Skip to main content
GET
Analytics de conversas (componentes aditivos)
Retorna linhas no grão dia / semana / mês × dimensão com componentes aditivos dos seus dados de conversas — você recebe as contagens e faz as divisões. Medidas (sempre contagens, nunca uma taxa pré-dividida): conversations_started, conversations_answered, conversations_no_response, appointments, transferred. Para as taxas (resposta, agendamento), divida você mesmo o numerador pelo denominador.
Sem parâmetros, o endpoint retorna o mesmo recorte que os painéis mostram por padrão. Use agent_type para ampliar. Os dados têm até ~6h de defasagem — veja as_of / stale na resposta e o header X-Data-As-Of.
O princípio de componentes aditivos e o cálculo das taxas estão na Visão geral de analytics.

Authorizations

Authorization
string
header
required

Workspace API key no formato mk_..., gerada na plataforma em Integrações → Configurar API.

Path Parameters

granularity
enum<string>
required

Tamanho do balde. Um de: day, week (segunda-feira ISO), month.

Available options:
day,
week,
month

Query Parameters

from
string<date>

Data ISO (limite inferior, inclusivo). Padrão: 30 dias atrás.

to
string<date>

Data ISO (limite superior, exclusivo). Padrão: agora.

tz
string
default:America/Sao_Paulo

Timezone IANA para o agrupamento por dia. Padrão: America/Sao_Paulo.

group_by
string

Lista separada por vírgulas das dimensões permitidas: agent_type, agent_id, source.

agent_type
string

Filtro / sobrescrita de escopo: lista separada por vírgulas dos tipos de agente a incluir (os mesmos valores que aparecem na dimensão agent_type dos resultados). Sobrescreve o recorte padrão.

agent_id
string

Filtro: lista separada por vírgulas de ids de agente.

source
string

Filtro: lista separada por vírgulas de origens.

Response

Linhas agregadas de componentes aditivos.

granularity
string
required

Granularidade aplicada (day, week ou month).

tz
string
required

Timezone IANA usado no agrupamento.

from
string
required

Limite inferior efetivo da janela.

to
string
required

Limite superior efetivo da janela.

as_of
string | null
required

Momento (ISO 8601) da última execução de ETL bem-sucedida deste metricset; null quando desconhecido.

stale
boolean
required

true quando os dados estão defasados (mais que ~2× a cadência de 6h) ou o frescor é desconhecido.

group_by
string[]
required

Dimensões aplicadas no agrupamento.

data
object[]
required

Uma linha por balde × combinação de dimensões. Cada dimensão de group_by aparece como uma chave adicional na linha.

count
integer
required

Número de linhas em data.