PilotFoxDocs

Get affiliate stats

GET
/api/v1/sites/{siteId}/affiliates/stats

Visits, visitors, payments, revenue, commission and conversion rate per affiliate in the window (slugs seen without a registered affiliate included), with totals, in the site's currency. The money fields are null without revenue:read.

Requires affiliates: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: affiliates: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"

Response Body

OK

application/json
  1. response
data*
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/affiliates/stats'
Example Response200
{  "data": {    "currency": "string",    "totals": {      "visits": 0,      "visitors": 0,      "payments": 0,      "revenue": 0,      "commission": 0,      "conversion_rate": 0    },    "affiliates": [      {        "id": "string",        "slug": "string",        "name": "string",        "commission_percent": 0,        "visits": 0,        "visitors": 0,        "payments": 0,        "revenue": 0,        "commission": 0,        "conversion_rate": 0      }    ]  },  "meta": {    "window": {      "from": "string",      "to": "string",      "tz": "string",      "bucket": "minute"    },    "compare": {      "from": "string",      "to": "string"    },    "totalCount": -9007199254740991,    "nextCursor": "string",    "truncated": true,    "cache": "hit"  }}