API de análises

A API de análises oferece acesso programático a dados de desempenho multicanal, histórico de seguidores e métricas de engajamento das postagens de todas as contas conectadas.

📌 Endpoints

Método	Caminho	Descrição	Escopo Necessário
`GET`	`/v1/brand/analytics`	Consulta métricas detalhadas por intervalo de tempo, plataforma ou conexão	`analytics:read` ou `*`
`GET`	`/v1/brand/analytics/overview`	Resumo rápido de 30 dias de todos os canais da marca	`analytics:read` ou `*`

📊 Análises detalhadas (`GET /v1/brand/analytics`)

Consulta métricas agregadas e canal por canal com base em critérios de filtro.

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
`range`	`string`	Opcional	`30d`	Intervalo de tempo (`7d`, `14d`, `30d`, `90d` ou personalizado `YYYY-MM-DD..YYYY-MM-DD`)
`sns_type`	`string`	Opcional	-	Filtrar por plataforma (`instagram`, `threads`, `bluesky`, etc.)
`connection_id`	`string`	Opcional	-	Filtrar por ID de conexão específico

Exemplo de Requisição

curl -X GET "https://api.ankk.app/v1/brand/analytics?range=30d&sns_type=instagram" \
  -H "Authorization: Bearer spk_live_xxxxxxxx"

Exemplo de Resposta (`200 OK`)

{
  "range": {
    "start": "2026-07-17T00:00:00Z",
    "end": "2026-08-16T00:00:00Z",
    "preset": "30d"
  },
  "totals": {
    "followers": 12500,
    "followers_change": 340,
    "published_posts": 28,
    "impressions": 84200,
    "reach": 61500,
    "engagement_rate": 4.8,
    "likes": 3210,
    "comments": 412,
    "shares": 180,
    "saves": 250
  },
  "by_channel": [
    {
      "connection_id": "conn_01jm8x9k2example",
      "sns_type": "instagram",
      "username": "acme_official",
      "followers": 12500,
      "posts_count": 28,
      "metrics_status": "synced"
    }
  ]
}

📈 Visão Geral da Marca (`GET /v1/brand/analytics/overview`)

Busca rapidamente resumos de alto nível de 30 dias adequados para widgets de painel e informativos diários.

Exemplo de Requisição

curl -X GET "https://api.ankk.app/v1/brand/analytics/overview" \
  -H "Authorization: Bearer spk_live_xxxxxxxx"

Exemplo de Resposta (`200 OK`)

{
  "brand_ref": "brand_01jm8v4k9example",
  "active_connections": 4,
  "summary_30d": {
    "total_published": 54,
    "total_failed": 1,
    "total_followers": 28400,
    "total_impressions": 195000
  },
  "synced_at": "2026-08-16T03:00:00Z"
}

⚠️ Notas sobre Métricas e Limites

Limites do Plano: O plano Free suporta métricas dos últimos 30 dias. Planos Growth e superiores permitem retenção estendida (90d+).
Interpretando 0 vs null:
- 0: O valor da métrica medida é genuinamente zero.
- null / unsupported: A API da plataforma não suporta esta métrica ou a permissão não foi verificada.

🔗 Documentação Relacionada