Get the revenue summary
Revenue, refunds, payments, average order value, paying visitors and conversion rate of the payments in one currency (currency, else the site's), credited to visits by the site's credit model (or model), and the currencies seen in the window; with a comparison window, the same figures for it under previous.
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"compare?string"previous""year"compare_start?stringcompare_end?stringfilters?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"OK
application/json- response
data*meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/revenue/summary'{ "data": { "revenue": 0, "gross": 0, "refunded": 0, "payments": 0, "refunds": 0, "aov": 0, "paying_visitors": 0, "visitors": 0, "conversion_rate": 0, "revenue_per_visitor": 0, "unattributed_payments": 0, "currency": "string", "currencies": [ { "currency": "string", "payments": 0 } ], "credit_model": "last_non_direct", "credit_window_days": 0, "previous": { "revenue": 0, "gross": 0, "refunded": 0, "payments": 0, "refunds": 0, "aov": 0, "paying_visitors": 0, "visitors": 0, "conversion_rate": 0, "revenue_per_visitor": 0, "unattributed_payments": 0 } }, "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}