sales.external_overview

Cartões de vendas de plataformas externas. Receita, compradores, ticket médio por comprador e vendas por canal dos pedidos aprovados, na moeda escolhida em filters.currency (ou a de maior receita). currency vem nulo sem vendas.

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

Entrada

Campo	Tipo	Obrigatório	Nota
`filters`	object	não

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "filters": {
      "type": "object",
      "properties": {
        "transactionPeriod": {
          "type": "object",
          "properties": {
            "from": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            },
            "to": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          }
        },
        "searchText": {
          "type": "string",
          "maxLength": 200
        },
        "contactName": {
          "type": "string",
          "maxLength": 200
        },
        "contactEmail": {
          "type": "string",
          "maxLength": 200
        },
        "contactDocument": {
          "type": "string",
          "maxLength": 200
        },
        "transactionShortenId": {
          "type": "string",
          "maxLength": 200
        },
        "externalId": {
          "type": "string",
          "maxLength": 200
        },
        "contactTags": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmSource": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmMedium": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmCampaign": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmTerm": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmContent": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "src": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "sck": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "transactionStatus": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "pending",
              "paid",
              "canceled",
              "refunded",
              "chargedBack",
              "failed"
            ]
          }
        },
        "projectIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "funnelIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "productIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "offerIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "orderBumpOfferIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "excludeOrderBumpOfferIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "transactionRecurrence": {
          "type": "string",
          "enum": [
            "OneTime",
            "Recurrent",
            "Trial"
          ]
        },
        "saleKind": {
          "type": "string",
          "enum": [
            "new",
            "invoice"
          ]
        },
        "currency": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 3
          }
        },
        "valueOfLastPurchase": {
          "type": "object",
          "properties": {
            "min": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000
            },
            "max": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000
            }
          }
        },
        "transactionType": {
          "maxItems": 3,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "credit",
              "pix",
              "boleto"
            ]
          }
        },
        "suspectedFraudOnly": {
          "type": "boolean"
        },
        "couponCode": {
          "type": "string",
          "maxLength": 200
        },
        "externalPageUrl": {
          "type": "string",
          "maxLength": 200
        },
        "gatewayOrigin": {
          "type": "string",
          "maxLength": 200
        },
        "productName": {
          "type": "string",
          "maxLength": 200
        },
        "offerCode": {
          "type": "string",
          "maxLength": 200
        },
        "installments": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        }
      }
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs sales.external_overview --json '{}'

MCP: ferramenta sales_external_overview com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "aggregations": {
      "type": "object",
      "properties": {
        "currency": {
          "type": [
            "string",
            "null"
          ]
        },
        "totalRevenue": {
          "type": "number"
        },
        "totalNumberOfBuyers": {
          "type": "number"
        },
        "averageTicketPerBuyer": {
          "type": "number"
        },
        "totalSales": {
          "type": "number"
        },
        "revenueByCurrency": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string"
              },
              "revenue": {
                "type": "number"
              }
            },
            "required": [
              "currency",
              "revenue"
            ],
            "additionalProperties": false
          }
        },
        "channelAggregations": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "gateway": {
                "type": "string"
              },
              "revenue": {
                "type": "number"
              },
              "buyers": {
                "type": "number"
              }
            },
            "required": [
              "gateway",
              "revenue",
              "buyers"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "currency",
        "totalRevenue",
        "totalNumberOfBuyers",
        "averageTicketPerBuyer",
        "totalSales",
        "revenueByCurrency",
        "channelAggregations"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "aggregations"
  ],
  "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).