Skip to main content
GET
Get account metrics
Este endpoint retorna os KPIs da conta e até cinco automações principais. Use o id de uma conta obtido em Listar contas como account_id.

Acesso

Sua chave de API precisa do escopo metrics:read e acesso à conta selecionada.

Selecione um período

Defina window com um destes valores de enum:
  • 7d: o período dos últimos 7 dias. Este é o padrão.
  • 30d: o período dos últimos 30 dias.
Para dms_sent e new_contacts, value abrange o período selecionado, e prev abrange o período imediatamente anterior com a mesma duração. delta_pct é a variação percentual arredondada entre eles. O valor será null quando prev for zero.

KPIs retornados

O objeto kpis contém: leads.last_window pode ser null quando existem leads, mas os timestamps de captura não estão disponíveis.

Principais automações

top_automations contém no máximo cinco itens. Cada item inclui id, name, status, dms_last_7d e last_fired_at. O enum status tem estes valores:
  • draft: salva, mas não processa novos gatilhos.
  • live: ativa e capaz de processar gatilhos correspondentes.
  • paused: inativa até que seja ativada novamente.
dms_last_7d sempre abrange os últimos sete dias, mesmo quando você solicita o período de conta 30d. last_fired_at será null quando a automação ainda não tiver sido acionada.

Exemplo de requisição

Autorizações

Authorization
string
header
obrigatório

Levios API key sent as a Bearer token.

Parâmetros de consulta

account_id
string<uuid>
obrigatório
window
enum<string>

Values: 30d: the trailing 30-day period; 7d: the trailing 7-day period.

Opções disponíveis:
30d,
7d

Resposta

Successful response.

kpis
object
obrigatório
top_automations
object[]
obrigatório
Maximum array length: 5
window
enum<string>
obrigatório

Values: 30d: the trailing 30-day period; 7d: the trailing 7-day period.

Opções disponíveis:
30d,
7d