List payments
The window's payments from every provider (or of one currency or status), newest first, with how each was attributed; the ids, the customer email and the linked visits need sessions:read too (null otherwise). A page at a time (meta.nextCursor).
Requires revenue:read on the site (an API key, or a signed-in member's role). Share links: 401.
x-api-key<token>An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).
Scope: revenue:read
siteId*stringstart?stringend?stringlast?stringall?"true""true"tz?stringbucket?string"minute""5m""15m""hour""day""week""month""year"filters?stringlength <= 64000segment?string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidcurrency?stringISO 4217 code: only payments in this currency; default: every currency
^[A-Za-z]{3}$model?stringWhich visit of the paying person a payment is credited to: last_non_direct, first_visit (both within the site's lookback window) or last_visit; default: the site's model
"last_non_direct""first_visit""last_visit"status?string"paid""partially_refunded""refunded"search?stringSubstring of the payment id, utm_source, referrer domain or (sessions:read) email
1 <= length <= 100cursor?stringmeta.nextCursor of the previous page
length <= 2200limit?integer1 <= value <= 20050OK
application/json- response
data*array<>meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/payments'{ "data": [ { "payment_id": "string", "provider": "stripe", "ts": "string", "amount": 0, "currency": "string", "refunded_amount": 0, "status": "paid", "customer_email": "string", "attribution": "checkout_ref", "session_id": "string", "visitor_id": "string", "user_id": "string", "credited_session_id": "string", "channel": "string", "referrer_domain": "string", "utm_source": "string", "utm_medium": "string", "utm_campaign": "string", "country": "string", "city": "string", "device_type": "string", "browser": "string", "os": "string", "entry_page": "string", "affiliate": "string", "time_to_convert": 0 } ], "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}