Tickets

Os dois endpoints consideram tickets criados no período.

Filtros comuns

Parâmetro	Exemplo	Efeito
initialDate, finalDate	2026-09-01	Período de criação (padrão: últimos 30 dias)
queueIds	1,2	Tickets dessas filas
includeUnassignedQueue	true	Com queueIds, inclui tickets sem fila
userIds	5	Tickets desses atendentes
whatsappIds	2	Tickets dessas conexões
tagIds	4,5	Tickets com todas essas tags
ticketStatus	closed	open, pending, closed, bot ou all (padrão)

Contagem

GET /public/v1/reports/ticketsPeríodo máximo: 366 dias

cURLNode.jsPython

Copiar

curl "https://api.takeflow.com.br/public/v1/reports/tickets?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/tickets?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/tickets?initialDate=2026-09-01&finalDate=2026-09-30",
    headers={"x-api-key": os.environ["TAKEFLOW_API_KEY"]},
)
print(json.load(urllib.request.urlopen(req)))

{
  "period": { "initialDate": "2026-09-01", "finalDate": "2026-09-30" },
  "total": 428
}

Lista detalhada

GET /public/v1/reports/tickets/detailedPeríodo máximo: 31 dias

cURLNode.jsPython

Copiar

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

fetch("https://api.takeflow.com.br/public/v1/reports/tickets/detailed?initialDate=2026-09-01&finalDate=2026-09-30&page=1&limit=50", {
  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/tickets/detailed?initialDate=2026-09-01&finalDate=2026-09-30&page=1&limit=50",
    headers={"x-api-key": os.environ["TAKEFLOW_API_KEY"]},
)
print(json.load(urllib.request.urlopen(req)))

Parâmetros adicionais:

Parâmetro	Padrão	Efeito
page	1	Página, de 1 a 10000
limit	50	Tickets por página, de 1 a 200
search		Até 100 caracteres. Busca parcial no nome e no número do contato e no uuid do ticket; busca exata no id do ticket
tabulationCategoryId		UUID da categoria de tabulação do ticket

Os tickets vêm do mais recente para o mais antigo. Cada ticket aparece uma única vez, e total é o número de tickets que o filtro encontrou.

{
  "period": { "initialDate": "2026-09-01", "finalDate": "2026-09-30" },
  "total": 428,
  "page": 1,
  "limit": 50,
  "totalPages": 9,
  "tickets": [
    {
      "id": 1024,
      "uuid": "e4e91fe0-831f-4b77-adba-e5fc4b73f360",
      "status": "closed",
      "contactName": "João Silva",
      "contactPhone": "5511999999999",
      "userName": "Ana Souza",
      "queueName": "Suporte",
      "whatsappName": "Comercial",
      "tags": "Lead, VIP",
      "tabulationName": "Venda",
      "serviceTimeMinutes": 14.5,
      "firstResponseTimeMinutes": 1.2,
      "createdAt": "2026-09-10T14:32:00.000Z",
      "updatedAt": "2026-09-10T15:01:00.000Z"
    }
  ]
}

Campo	Significado
contactName, contactPhone	Vazios quando o contato não tem nome ou número
userName, queueName, whatsappName, tabulationName	null quando o ticket não tem esse vínculo
tags	Nomes das tags, em ordem alfabética, separados por vírgula
serviceTimeMinutes	Minutos entre o primeiro início de atendimento e o último encerramento registrado no ticket; null se nenhum atendimento dele foi encerrado. Em ticket reaberto, vale o encerramento anterior até o novo atendimento terminar
firstResponseTimeMinutes	Minutos entre o primeiro início de atendimento e a primeira mensagem enviada pela empresa depois dele
createdAt, updatedAt	ISO 8601 em UTC