How it works

PassKey sits between the ad and the payment gateway. It determines which creative produced each sale and hands that back — that link is what the API delivers.

All sales configuration happens in the PassKey dashboard. The API is for one thing: reading the sales that came in through your payment gateways, already attributed to a creative.

The API is read-only: it creates, changes and deletes no sale.

What you read

Endpoint	Answers
`GET /v1/sales`	which sales came in this period
`GET /v1/sales/metrics`	how much I made and how sales break down by status
`GET /v1/creatives/ranking`	which creative sold the most

Time zone and window

Filter dates are calendar days (YYYY-MM-DD) and to is inclusive. The window is read in the account time zone, so "August 1 to 31" is the same period the dashboard shows.