Get a revenue breakdown
Revenue, payments and conversion per value of one session dimension (dim, as /breakdown takes it) or of the payment's affiliate, in one currency (currency, else the site's), credited by the site's credit model (or model), a page at a time (limit and offset; meta.totalCount).
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 amounts in this currency count, so every amount of the response is in it (no conversion); default: the site's 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"dim*stringA session dimension of the registry, or "affiliate" (the payment's own)
limit?integer1 <= value <= 100050offset?integer0 <= value <= 1000000OK
application/json- response
data*array<>meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/revenue/breakdown?dim=string'{ "data": [ { "value": "string", "label": "string", "region": "string", "region_name": "string", "country": "string", "revenue": 0, "gross": 0, "refunded": 0, "payments": 0, "paying_visitors": 0, "visitors": 0, "conversion_rate": 0, "percentage": 0 } ], "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}