api-reference

1. Crie um token API ou uma chave de website

Crie um token API de workspace na página API Tokens quando precisar de acesso programático a todos os websites do workspace, incluindo integrações MCP e OpenClaw. Tokens de workspace usam o prefixo <code>flow_ws_</code>. Para tracking server-to-server de um único website, crie uma chave API de website em Settings > API desse website; chaves de website usam o prefixo <code>flow_</code>. Copie novos tokens imediatamente porque o segredo só aparece uma vez.

2. Autenticar suas requisicoes

Cada chamada API deve incluir o header Authorization usando o esquema Bearer. Use um token de workspace <code>flow_ws_</code> para acesso API multi-website, ou uma chave de website <code>flow_</code> para um único website.

Cabecalho de autorizacao
Authorization: Bearer YOUR_API_KEY

3. Comecar a fazer requisicoes

A URL base para todos os endpoints v1 é: <code>https://analytics.flowsery.com/api/v1/</code>. Com um token de workspace, chame <code>GET /websites</code> primeiro e depois passe <code>websiteId</code> ou <code>domain</code> nas solicitações. Chaves de website já são limitadas a um website e não precisam de seletor.

Formato de resposta

Respostas bem-sucedidas retornam um status 200 OK com um corpo estruturado como:

Resposta bem-sucedida
{
  "status": "success",
  "data": { ... }
}

Os erros utilizam o formato normal de resposta de erros HTTP NestJS.

Resposta de erro
{
  "message": "Unauthorized",
  "statusCode": 401
}

Codigos de erro padrao

<strong>400 Bad Request</strong> -- A entrada é inválida ou faltam parâmetros obrigatórios.<br /><strong>401 Unauthorized</strong> -- O token API está ausente, é inválido, expirou ou não é aceito para este endpoint.<br /><strong>404 Not Found</strong> -- O recurso solicitado não existe.<br /><strong>500 Internal Server Error</strong> -- Ocorreu um problema inesperado no servidor.
Exemplo de requisicao (curl)
curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/websites \
  --header 'Authorization: Bearer <workspace-api-token>'
200
{
  "status": "success",
  "data": [
    {
      "id": "cm8abc123",
      "domain": "example.com",
      "timezone": "America/New_York",
      "currency": "USD",
      "trackingId": "flid_abc123"
    }
  ]
}