Obter dados do visitante

api-referenceGET

GEThttps://analytics.flowsery.com/analytics/api/v1/visitors/{visitorId}

Procure dados de identidade, atividade, receita e perfil de um visitante específico utilizando o visitId interno devolvido por Flowsery.

Token Bearer (token de workspace ou chave API de website)

Os tokens do espaço de trabalho precisam de um seletor de site

Os tokens da API do Workspace podem acessar todos os sites do workspace. Passe <code>websiteId</code> ou <code>domain</code> para que Flowsery saiba qual site consultar ou alterar. As chaves da API do site já têm como escopo um site, portanto o seletor pode ser omitido.

Seletor de site

Parametro	Tipo	Descricao
`websiteId`	`string`	ID do site a ser usado com um token de API do workspace. Omitir ao autenticar com uma chave de API de site.
`domain`	`string`	Site domain para usar com um token de API do espaço de trabalho quando websiteId não for fornecido. Omitir ao autenticar com uma chave de API de site.

Identificacao do visitante

Utilize o visitante interno dos registos Flowsery ou das respostas API. Não passe o cookie _fs_vid do browser diretamente como parâmetro de rota.

Campos de resposta

Parametro	Tipo	Descricao
`identity`	`object`	Localizacao geografica, tipo de dispositivo, navegador, sistema operacional e dimensoes do viewport da ultima visualizacao de pagina
`source`	`string \| null`	Fonte de trafego original que trouxe este visitante (dominio de referencia ou fonte UTM)
`sourceIconUrl`	`string \| null`	URL do favicon da fonte de trafego
`activity`	`object`	Contagens de visitas e visualizacoes de pagina, informacoes de tempo, ultima URL, objetivos concluidos e lista de paginas visitadas
`revenue`	`object`	Resumo de receita: totalRevenue, indicador isCustomer, timeToFirstConversion (segundos, ou null)
`profile`	`object \| null`	Dados do usuario identificado (userId, name, email) se identify foi chamado. Null para visitantes anonimos
`activityTimeline`	`array`	Lista cronologica combinada de todas as visualizacoes de pagina, objetivos concluidos e pagamentos para este visitante

Exemplo de requisicao (curl)

curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/visitors/{visitorId} \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": {
    "visitorId": "a3ab2331-989f-4cfa-91c6-2461c9e3c6bd",
    "identity": {
      "country": "South Korea",
      "countryCode": "KR",
      "region": "KR-44",
      "city": "Seosan City",
      "browser": { "name": "Chrome", "version": "133.0.0.0" },
      "os": { "name": "Mac OS", "version": "10.15.7" },
      "device": { "type": "Desktop" },
      "viewport": { "width": 1728, "height": 998 }
    },
    "source": "youtube.com",
    "sourceIconUrl": "https://icons.duckduckgo.com/ip3/youtube.com.ico",
    "activity": {
      "visitCount": 3,
      "pageViewCount": 8,
      "firstVisitAt": "2025-04-11T03:38:49.154Z",
      "lastVisitAt": "2025-04-11T03:38:49.154Z",
      "currentUrl": "example.com/",
      "visitedPages": [
        { "url": "example.com/", "timestamp": "2025-04-11T03:38:49.154Z" }
      ],
      "completedCustomGoals": [
        { "name": "newsletter_signup", "timestamp": "2025-04-11T03:38:54.253Z" }
      ]
    },
    "revenue": {
      "totalRevenue": 29.99,
      "isCustomer": true,
      "timeToFirstConversion": 3600
    },
    "profile": {
      "userId": "usr_123",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "activityTimeline": [
      {
        "type": "payment",
        "timestamp": "2025-04-11T04:38:49.154Z",
        "url": null,
        "eventName": null,
        "amount": 29.99
      },
      {
        "type": "goal",
        "timestamp": "2025-04-11T03:38:54.253Z",
        "url": null,
        "eventName": "newsletter_signup",
        "amount": null
      },
      {
        "type": "pageview",
        "timestamp": "2025-04-11T03:38:49.154Z",
        "url": "example.com/",
        "eventName": null,
        "amount": null
      }
    ]
  }
}