Métricas

GET/v1/sales/metrics

Os números do topo da tela numa chamada só: faturamento por moeda e contagem por status, sem paginar nada.

Parâmetros

Parâmetro	Tipo	Padrão
`from`	YYYY-MM-DD	30 dias atrás
`to`	YYYY-MM-DD	hoje
`convertTo`	ISO-4217	—

Exemplo

curl "https://public-api.passkey.global/v1/sales/metrics?from=2026-08-01&to=2026-08-31" \
  -H "Authorization: Bearer passkey_prd_..."

json

{
  "from": "2026-08-01",
  "to": "2026-08-31",
  "totals": { "paidCount": 152, "waitingCount": 9, "refundedCount": 6, "failedCount": 1 },
  "revenue": [{ "currency": "BRL", "amountCents": 4544800 }],
  "conversion": null
}

revenue conta só as vendas pagas. Esta rota é servida de cache de 30 segundos.

convertTo

O valor é o código ISO-4217 de três letras da moeda de destino — BRL, USD, EUR, o mesmo padrão do campo currency. Qualquer código de três letras é aceito; fora do formato, 400.

text

GET /v1/sales/metrics?from=2026-08-01&to=2026-08-31&convertTo=BRL

Sem ele, os valores vêm separados por moeda. Com ele, tudo é convertido para a moeda pedida:

json

{
  "revenue": [{ "currency": "BRL", "amountCents": 5121300 }],
  "conversion": { "target": "BRL", "quotedFrom": "2026-08-01", "quotedTo": "2026-08-31" }
}

Três regras que evitam número errado

Regra	Por quê
Cada linha usa a cotação do dia dela	com "a taxa de hoje", o total de um mês fechado mudaria toda vez que o câmbio mexesse
Tudo ou nada	faltando a cotação de um dia, a conversão inteira é descartada — converter parte daria um total pior que não converter, e indistinguível de um correto
`conversion: null` nunca é taxa 1	significa que não houve conversão: não foi pedida, faltou cotação, ou já era a moeda de destino

Sempre confira conversion antes de tratar revenue como moeda única.