Visão geral

GET /public/v1/reports/overview

cURLNode.jsPython

Copiar

curl "https://api.takeflow.com.br/public/v1/reports/overview?initialDate=2026-09-01&finalDate=2026-09-30" \
  -H "x-api-key: tf_live_SUA_CHAVE"

fetch("https://api.takeflow.com.br/public/v1/reports/overview?initialDate=2026-09-01&finalDate=2026-09-30", {
  headers: { "x-api-key": process.env.TAKEFLOW_API_KEY },
})
  .then((res) => res.json())
  .then((body) => console.log(body));

import json, os, urllib.request

req = urllib.request.Request(
    "https://api.takeflow.com.br/public/v1/reports/overview?initialDate=2026-09-01&finalDate=2026-09-30",
    headers={"x-api-key": os.environ["TAKEFLOW_API_KEY"]},
)
print(json.load(urllib.request.urlopen(req)))

Os contadores e a lista de atendentes do Dashboard da TakeFlow, com o mesmo cálculo. Duas diferenças: a nota dos atendentes considera todas as avaliações do período, e usuários excluídos não aparecem na lista.

Parâmetros

Parâmetro	Exemplo	Efeito
initialDate, finalDate	2026-09-01	Período (padrão: últimos 30 dias; máximo 366). Considera atendimentos que entraram na fila a partir de initialDate e foram encerrados até o fim de finalDate
queueIds	1,2	Atendimentos dessas filas
includeUnassignedQueue	true	Com queueIds, inclui atendimentos sem fila
whatsappIds	2	Atendimentos dessas conexões
tagIds	4,5	Atendimentos de tickets com todas essas tags
userIds	1,7	Restringe só a lista attendants a esses usuários

Resposta

{
  "period": { "initialDate": "2026-09-01", "finalDate": "2026-09-30" },
  "counters": {
    "avgSupportTimeMinutes": 18.4,
    "avgWaitTimeMinutes": 3.2,
    "supportHappening": 12,
    "supportPending": 4,
    "supportFinished": 150,
    "leads": 45
  },
  "attendants": [
    {
      "id": 5,
      "name": "Ana Souza",
      "avgSupportTimeMinutes": 12.5,
      "tickets": 42,
      "rating": 4.8,
      "online": true
    }
  ]
}

Campo	Significado
avgSupportTimeMinutes	Média, em minutos, do início do atendimento até a avaliação (ou o encerramento, sem avaliação). Ignora atendimentos com duração 0. null sem atendimentos
avgWaitTimeMinutes	Média, em minutos, da entrada na fila até o início do atendimento. Ignora esperas de 0 minuto
supportHappening	Tickets com status open agora, não depende do período
supportPending	Tickets com status pending agora, não depende do período
supportFinished	Atendimentos encerrados no período
leads	Contatos com exatamente um atendimento no período
attendants[].tickets	Atendimentos do usuário no período
attendants[].avgSupportTimeMinutes	Tempo médio de atendimento do usuário, 0 sem atendimentos
attendants[].rating	Média das avaliações recebidas no período, 0 sem avaliações

A lista attendants traz todos os usuários não excluídos da empresa, inclusive os que não atenderam no período.