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

Procure dados de identidade, atividade, receita e perfil de um visitante específico usando o visitId interno retornado pelo 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 websiteId ou domain 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

ParâmetroTipoDescrição
websiteIdstringID do site a ser usado com um token de API do workspace. Omitir ao autenticar com uma chave de API de site.
domainstringSite 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.

Identificação do visitante

Use o ID de visitante interno dos registros do Flowsery ou das respostas da API. Não passe o cookie _fs_vid do navegador diretamente como parâmetro de rota.

Campos de resposta

ParâmetroTipoDescrição
identityobjectLocalização geográfica, tipo de dispositivo, navegador, sistema operacional e dimensões do viewport da última visualização de página
sourcestring | nullFonte de tráfego original que trouxe este visitante (domínio de referência ou fonte UTM)
sourceIconUrlstring | nullURL do favicon da fonte de tráfego
activityobjectContagens de visitas e visualizações de página, informações de tempo, última URL, objetivos concluidos e lista de páginas visitadas
revenueobjectResumo de receita: totalRevenue, indicador isCustomer, timeToFirstConversion (segundos, ou null)
profileobject | nullDados do usuário identificado (userId, name, email) se identify foi chamado. Null para visitantes anônimos
activityTimelinearrayLista cronologica combinada de todas as visualizações de página, objetivos concluidos e pagamentos para este visitante
Exemplo de requisição (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
      }
    ]
  }
}