Skip to main content
GET
Consultar um relatório operacional
Puxa, linha a linha, os erros de entrega de mensagens do seu workspace (webhooks de falha do WhatsApp), com o código e a descrição do erro, o contato e a conversa.
updated_since é obrigatório e a janela (toupdated_since) não pode passar de 31 dias. Uma chamada sem updated_since é rejeitada com 400.
Filtros disponíveis (combináveis): deal_id, conversation_id, agent_id, external_id, error_code. Chaves de filtro desconhecidas são ignoradas. Pagine pelo next_cursor até ele voltar null. O significado de cada campo retornado está detalhado na seção Response abaixo.

Authorizations

Authorization
string
header
required

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

Path Parameters

report
enum<string>
required

Relatório a consultar.

Available options:
message_errors

Query Parameters

updated_since
string<date-time>
required

Timestamp ISO 8601; limite inferior da janela (inclusivo), mapeado para o timestamp do cursor. Obrigatório: sem ele a requisição é rejeitada com 400.

to
string<date-time>

Timestamp ISO 8601; limite superior da janela. Padrão: agora. A janela (toupdated_since) não pode exceder 31 dias.

cursor
string

Cursor opaco de paginação, conforme retornado em next_cursor na página anterior.

limit
integer
default:100

Máximo de linhas por página (1 a 1000, padrão 100). Valores fora do intervalo são ajustados, não rejeitados.

Required range: 1 <= x <= 1000
deal_id
string

Filtro: id do deal da conversa.

conversation_id
string

Filtro: id da conversa.

agent_id
string

Filtro: agente responsável pela conversa.

external_id
string

Filtro: id da mensagem no WhatsApp (wamid).

error_code
string

Filtro: código do erro de entrega do WhatsApp.

Response

Página de dados do relatório.

data
object[]
required

Linhas do relatório nesta página.

next_cursor
string | null
required

Cursor da próxima página; null quando não há mais páginas.

count
integer
required

Número de linhas nesta página.