Pular para o conteúdo

Como funciona

O PassKey fica entre o anúncio e o gateway de pagamento. Ele descobre qual criativo gerou cada venda e devolve isso pronto — é essa ligação que a API entrega.

Toda a configuração das vendas é feita no painel do PassKey. A API serve para uma coisa: ler as vendas que chegaram pelos seus gateways de pagamento, já com o criativo atribuído.

A API é somente leitura: ela não cria, não altera e não apaga venda nenhuma.

O que você lê

RotaResponde
GET /v1/salesquais vendas eu recebi no período
GET /v1/sales/metricsquanto faturei e como as vendas se dividem por status
GET /v1/creatives/rankingqual criativo vendeu mais

Fuso e janela

As datas de filtro são dia de calendário (YYYY-MM-DD) e o to é inclusivo. A janela é interpretada no fuso da conta, então "01 a 31 de agosto" é o mesmo período que o painel mostra.