capi.deliveries_list

Listar entregas de conversões. Entregas da fila da API de Conversões, da mais recente para a mais antiga, 50 por página. Filtro opcional por status. cursor é o nextCursor da página anterior.

• Endpoint: POST https://app.atomiks.com.br/api/v1/capi.deliveries_list (corpo JSON)
• Quem pode chamar: administrador da conta
• Escopo da chave: conversions:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: capi_deliveries_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId capi.deliveries_list)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "sending",
        "sent",
        "failed",
        "skipped"
      ]
    },
    "cursor": {
      "type": "string",
      "pattern": "^\\d+$"
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/capi.deliveries_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"failed"}'

CLI:

node cli/atomiks.mjs capi.deliveries_list --json '{"status":"failed"}'

MCP: ferramenta capi_deliveries_list com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "eventName": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "sending",
              "sent",
              "failed",
              "skipped"
            ]
          },
          "contact": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "id",
              "name"
            ],
            "additionalProperties": false
          },
          "valueCents": {
            "type": [
              "number",
              "null"
            ]
          },
          "attempts": {
            "type": "number"
          },
          "lastError": {
            "type": [
              "string",
              "null"
            ]
          },
          "sentAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "eventName",
          "status",
          "contact",
          "valueCents",
          "attempts",
          "lastError",
          "sentAt",
          "createdAt"
        ],
        "additionalProperties": false
      }
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "items",
    "nextCursor"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).