Skip to main content
GET
Ver métricas do workspace

Authorizations

Authorization
string
header
required

Chave de API do workspace, criada em Configurações > Chaves de API.

Query Parameters

range
enum<string>
default:30d

7d (últimos 7 dias), 30d (últimos 30 dias, o padrão), mtd (mês até hoje) ou custom. Os dias são dias corridos no fuso horário do usuário dono da chave de API, incluindo hoje.

Available options:
7d,
30d,
mtd,
custom
start
string<date>

Primeiro dia, Y-m-d. Obrigatório com range=custom e ignorado nos outros períodos prontos. Enviar start e end sem range equivale a custom.

end
string<date>

Último dia, Y-m-d, igual ou depois de start. Obrigatório com range=custom.

channels[]
string<uuid>[]

Só estas contas sociais. Ids desconhecidos e contas sem análises são ignorados sem erro; quando nenhum id serve, o relatório cobre todos os canais.

Response

O relatório.

bounds
object

Primeiro e último dia com dados de análises no escopo (null quando não há nenhum).

range
object

Dias corridos no fuso horário do usuário dono da chave de API (as duas pontas incluídas).

previous_range
object

Dias corridos no fuso horário do usuário dono da chave de API (as duas pontas incluídas).

summary
object

Totais do período comparados com o período anterior. posts conta os posts publicados no período (feitos no PostClean ou não). engagement_rate é um percentual. watch_time_minutes e average_watch_time_seconds valem para vídeos.

followers
object
posts
object
top_posts
object

Até 5 posts do período com mais reações e até 5 com mais comentários.

performance
object[]

Uma linha por canal com pelo menos um post no período, com cada métrica comparada ao período anterior.

coverage
object[]

Até onde as análises já foram coletadas em cada canal conectado. Cada canal pode ter uma linha por coletor.