Solicitar um relatório

Coloca a geração do relatório na fila e devolve o identificador do trabalho. O arquivo fica pronto de forma assíncrona; acompanhe pelo status. Cada tipo declara as permissões que exige (por exemplo attendance:read para a visão de atendimento), conferidas na criação e de novo na geração para quem pediu; sem elas responde 403 report_forbidden. O escopo de departamento e de responsável é calculado na geração a partir de quem pediu, nunca dos parâmetros enviados. O tipo leads só nasce em POST /v1/leads/actions e aqui responde 400 report_kind_not_offered. O tipo whatsapp_dispatch gera o bloco de disparo de campanhas da visão de atendimento (funil, dias, campanhas, motivos de falha e etiquetas) para qualquer período de até 731 dias, com os parâmetros dateFrom, dateTo (YYYY-MM-DD), campaignId e departmentId opcionais; exige attendance:read e whatsapp_campaigns:read. Parâmetros que o tipo não consegue gerar, como um período maior que o limite do tipo, respondem 400 report_invalid_params. A reutilização de um pedido igual considera quem pediu. O cabeçalho Idempotency-Key é opcional: repetir a chave com o mesmo corpo devolve a mesma resposta.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Relatório a gerar

string
string
string
params
object
Headers
string

Chave única da operação

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json