Skip to Content
Urlizo API Docs
API ReferenceAnalytics

Analytics

Consultas sobre a tabela agregada AnalyticsDaily (nunca ClickEvents crus). Paginação page/limit (default 50, max 100) — a resposta espelha `limit` como `pageSize`. Workspace divergente retorna zeros/página vazia com 200.

Tag no Swagger: Analytics · Auth: JWT (Dashboard) + API Key (Public) · 4 endpoints

GET/api/v1/analytics/workspace/:workspaceId/summary

Totais do workspace da chave. Divergente = zeros com 200.

Auth: API Key Bearer (scope analytics:read)

Response

{ totalClicks, totalUniqueClicks }

Errors: 401 · 403

GET/api/v1/analytics/:linkId

Diárias de um link (page/limit → pageSize).

Auth: API Key Bearer (scope analytics:read)

Query parameters

CampoTipoObrigatórioRegras
pagenumbernãoDefault 1.
limitnumbernãoDefault 50, max 100.

Response

{ data, total, page, pageSize, totalPages }

Errors: 401 · 403

GET/api/v1/analytics/workspace/:workspaceId

Diárias do workspace. ATENÇÃO: no branch divergente usa a query crua (page da string, pageSize fixo 50).

Auth: API Key Bearer (scope analytics:read)

Query parameters

CampoTipoObrigatórioRegras
pagenumbernãoDefault 1.
limitnumbernãoDefault 50, max 100 (ignorado no branch divergente).

Response

{ data, total, page, pageSize, totalPages }

Errors: 401 · 403

GET/api/v1/analytics/:linkId/summary

Totais de um link.

Auth: API Key Bearer (scope analytics:read)

Response

{ totalClicks, totalUniqueClicks }

Errors: 401 · 403