PilotFoxDocs

Get the revenue time series

GET
/api/v1/sites/{siteId}/revenue/timeseries

Revenue and payments per time bucket in one currency (currency, else the site's); with a comparison window, each point carries the comparison's point at the same index under previous (null where that series is shorter).

Requires revenue:read on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-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

Path Parameters

siteId*string

Query Parameters

start?string
end?string
last?string
all?"true"
Value in"true"
tz?string
bucket?string
Value in"minute""5m""15m""hour""day""week""month""year"
compare?string
Value in"previous""year"
compare_start?string
compare_end?string
filters?string
Lengthlength <= 64000
segment?string
Match^([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)$
Formatuuid
currency?string

ISO 4217 code: only amounts in this currency count, so every amount of the response is in it (no conversion); default: the site's currency

Match^[A-Za-z]{3}$
model?string

Which 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

Value in"last_non_direct""first_visit""last_visit"

Response Body

OK

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/revenue/timeseries'
Example Response200
{  "data": [    {      "t": "string",      "revenue": 0,      "gross": 0,      "refunded": 0,      "payments": 0,      "previous": {        "t": "string",        "revenue": 0,        "gross": 0,        "refunded": 0,        "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"  }}