← Voltar para Eventos

API de Eventos — DM BOT Builder

Consulte, exporte e dispare eventos programaticamente. Todos os endpoints exigem autenticação via JWT.

Autenticação via API Key

Para integrações externas, use uma API Key fixa no header:

X-API-Key: dmk_sua_chave_aqui

A chave não expira até ser revogada. Também aceita Authorization: Bearer JWT para chamadas internas.

Suas API Keys

Carregando...

POST /api/events/track Disparar evento via API

Cria um novo evento na tabela track_events com source: "api".

Campo	Tipo	Obrigatório	Descrição
`event_name`	string	Sim	Identificador do evento (slug)
`event_label`	string	Não	Nome amigável
`conversation_id`	string	Não	ID da conversa associada
`assistant_id`	int	Não	ID do assistente
`contact_document`	string	Não	CPF do contato
`contact_name`	string	Não	Nome do contato
`contact_phone`	string	Não	Telefone
`contact_email`	string	Não	Email
`channel`	string	Não	Canal de origem
`environment`	string	Não	prod (padrão), homol, dev
`keys`	object	Não	Dados extras do evento (chave/valor)

Exemplo de requisição

curl -X POST https://chat.imperioog.com/api/events/track \ -H "X-API-Key: dmk_sua_chave_aqui" \ -H "Content-Type: application/json" \ -d '{ "event_name": "pagamento_confirmado", "event_label": "Pagamento confirmado", "conversation_id": "abc123", "contact_document": "05180712351", "contact_name": "Jonathan", "environment": "prod", "keys": { "valor": "150.00", "metodo": "pix", "id_transacao": "TXN-98765" } }'

Resposta

{ "ok": true, "id": "uuid-do-evento" }

Testar agora

GET /api/events/list Listar eventos com filtros

Param	Tipo	Descrição
`page`	int	Página (padrão 1)
`limit`	int	Itens por página (padrão 20)
`event_name`	string	Filtrar por nome do evento
`assistant_id`	int	Filtrar por assistente
`environment`	string	prod, homol, dev
`source`	string	manual, system, api
`date_from`	string	YYYY-MM-DD
`date_to`	string	YYYY-MM-DD
`document`	string	CPF do contato
`conversation_id`	string	ID da conversa

Exemplo

curl https://chat.imperioog.com/api/events/list?event_name=new_contact&date_from=2026-06-01 \ -H "X-API-Key: dmk_sua_chave_aqui"

GET /api/events/names Nomes de eventos distintos

Retorna a lista de todos os nomes de eventos registrados, com contagem de ocorrencias.

GET /api/events/summary Contagem agrupada por evento

Retorna contagem, ultimo disparo e assistentes por evento. Aceita filtros: date_from, date_to, assistant_id, environment.

GET /api/events/export Exportar CSV

Exporta eventos em CSV com colunas fixas + keys dinamicas. Autenticacao via token como query parameter.

Exemplo

https://chat.imperioog.com/api/events/export?token=SEU_TOKEN&event_name=meu_evento&date_from=2026-06-01

GET /api/events/{event_id} Detalhe de um evento

Retorna todos os campos de um evento especifico pelo UUID.