Ver .md

external_recovery.export_csv

Exportar a recuperação externa em CSV. Texto CSV (separador ";") da sub-aba da recuperação externa. A tela baixa como external-recovery-<sub-aba>.csv.

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

Entrada

CampoTipoObrigatórioNota
subTab"failed" | "chargeback" | "refunded" | "canceled" | "cartAbandonment"sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "subTab": {
      "type": "string",
      "enum": [
        "failed",
        "chargeback",
        "refunded",
        "canceled",
        "cartAbandonment"
      ]
    }
  },
  "required": [
    "subTab"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs external_recovery.export_csv --json '{"subTab":"failed"}'

MCP: ferramenta external_recovery_export_csv com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "filename": {
      "type": "string"
    },
    "csv": {
      "type": "string"
    },
    "count": {
      "type": "number"
    }
  },
  "required": [
    "filename",
    "csv",
    "count"
  ],
  "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).