Skip to main content

​
Pré-requisitos

  • API Key com escopo: logs:read.
  • Envie a API Key em toda requisição:
    • Header: Authorization: Bearer sk_live_xxxxx
    • ou Header: x-api-key: sk_live_xxxxx

​
1. Listar logs

Consulta o histórico de chamadas à API do workspace. Cada log retorna: endpoint, método HTTP, status, corpo da requisição/resposta (quando registrado), duração e data. Request 
GET /v1/logs?page=1&limit=20
Authorization: Bearer sk_live_xxxxx
Response (200) 
{
  "success": true,
  "data": [
    {
      "id": "clxx...",
      "apiKeyId": "clyy...",
      "instanceId": null,
      "endpoint": "/v1/whatsapp/messages",
      "method": "POST",
      "status": 202,
      "userAgent": "MyApp/1.0",
      "ip": "203.0.113.42",
      "requestQuery": null,
      "requestBody": { "instanceId": "clzz...", "to": ["5511999999999"], "type": "text", "payload": { "message": "Olá!" } },
      "responseBody": { "messageIds": ["claa..."], "status": "QUEUED" },
      "duration": 45,
      "createdAt": "2025-02-20T14:30:00.000Z"
    },
    {
      "id": "clxx2...",
      "apiKeyId": "clyy...",
      "instanceId": null,
      "endpoint": "/v1/sms/messages/clbb...",
      "method": "GET",
      "status": 200,
      "userAgent": "MyApp/1.0",
      "ip": "203.0.113.42",
      "requestQuery": null,
      "requestBody": null,
      "responseBody": { "success": true, "data": { "smsId": "clbb...", "to": "5511999999999", "status": "DELIVERED" } },
      "duration": 12,
      "createdAt": "2025-02-20T14:29:55.000Z"
    }
  ],
  "pagination": { "total": 150, "page": 1, "limit": 20, "totalPages": 8 }
}

​
2. Filtros (query)

ParâmetroDescrição
pagePágina (default 1).
limitItens por página (default 20, máx. 100).
statusCódigo(s) HTTP separados por vírgula (ex.: 200,201,404).
startDateData/hora início (ISO 8601).
endDateData/hora fim (ISO 8601).
methodMétodo(s) HTTP separados por vírgula (ex.: GET,POST).
apiKeyIdID da API Key; filtra logs apenas dessa key (deve ser do workspace).
Exemplo com filtros 
GET /v1/logs?status=200,202&method=POST&startDate=2025-02-20T00:00:00.000Z&endDate=2025-02-20T23:59:59.000Z
Authorization: Bearer sk_live_xxxxx
Se apiKeyId não pertencer ao workspace, retorna 400.

​
Resumo do fluxo

  1. GET /v1/logs com paginação (page, limit) → listar logs.
  2. (Opcional) Use status, startDate, endDate, method, apiKeyId para filtrar e auditar uso ou debugar erros.