Analytics API

A API de Analytics permite-te ler métricas de reprodução do teu workspace. Todos os endpoints são pedidos GET só de leitura em /api/analytics/*.

A tua Chave API tem de ter a permissão analytics.read. Apenas read em vídeos não chega. Consulta Autenticação.

Endpoints

Endpoint	Path
Reproduções	`GET /api/analytics/plays`
Fontes	`GET /api/analytics/sources`
Conteúdo	`GET /api/analytics/content`
Distribuição	`GET /api/analytics/breakdown`
Conclusão	`GET /api/analytics/completion`
Espetadores	`GET /api/analytics/watching`
Engagement	`GET /api/analytics/engagement`
Ao vivo	`GET /api/analytics/live`

Passa a tua Chave API como Token Bearer:


curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://app.ignitevideo.cloud/api/analytics/plays?interval=day"

O workspace é obtido a partir da Chave API. Não envies um parâmetro de consulta workspaceId.

Se a tua Chave API estiver limitada a categorias específicas:

As chamadas de Analytics ao nível do workspace (sem contentId de vídeo) continuam a devolver agregados de todo o workspace.
As chamadas por vídeo que passam um contentId VOD só têm sucesso quando esse vídeo está dentro do âmbito de categoria da chave.
O conteúdo live (contentType=live) não é filtrado pelo âmbito de categoria.

Muitos endpoints partilham estes parâmetros:

Parâmetro	Tipo	Descrição
`contentType`	`string`	`vod` (predefinição) ou `live`
`contentId`	`string`	Id do vídeo ou id do evento live
`from`	`string`	Hora de início ISO 8601. Predefinição: cerca de 30 dias atrás.
`to`	`string`	Hora de fim ISO 8601. Predefinição: agora.
`minimumWatchSeconds`	`number`	Tempo mínimo de visualização para uma view contar. Predefinição: `3`.
`interval`	`string`	Para plays: `hour` ou `day` (predefinição `day`)
`limit`	`number`	Máx. de linhas para listas ordenadas. Predefinição: `100`.

Intervalos maiores do que cerca de um ano são limitados ao ano mais recente.

Estado	Body	Significado
`400`	`{ "error": "..." }`	Parâmetros de consulta inválidos
`403`	—	Falta `analytics.read`, chave desativada ou `contentId` VOD fora do âmbito
`500`	`{ "error": "analytics_not_configured" }`	Analytics não está configurado no servidor
`502`	`{ "error": "analytics_upstream_error" }`	Erro upstream de analytics
`504`	`{ "error": "analytics_timeout" }`	Timeout upstream de analytics

As respostas incluem Cache-Control: private, no-store. Não armazenes em cache as respostas de analytics no navegador entre mudanças de workspace.