Get an affiliate's report
GET
One affiliate's totals, time series, landing pages, referrers and countries in the window, and its link. Revenue, commission and recent payments need revenue:read too.
Requires affiliates:read on the site (an API key, or a signed-in member's role). Share links: 401.
header
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: affiliates:read
siteId*stringid*stringMatch
^([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)$Format
uuidstart?stringend?stringlast?stringall?"true"Value in
"true"tz?stringbucket?stringValue in
"minute""5m""15m""hour""day""week""month""year"OK
application/json- response
data*meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/affiliates/497f6eca-6276-4993-bfeb-53cbbbba6f08/report'Example Response200
{ "data": { "affiliate": { "id": "string", "name": "string", "slug": "string", "commissionPercent": 0, "shareEnabled": true, "createdAt": "string", "updatedAt": "string" }, "currency": "string", "link": "string", "totals": { "visits": 0, "visitors": 0, "payments": 0, "revenue": 0, "commission": 0, "conversion_rate": 0 }, "series": [ { "t": "string", "visits": 0, "visitors": 0, "payments": 0, "revenue": 0 } ], "landing_pages": [ { "pathname": "string", "visits": 0 } ], "referrers": [ { "value": "string", "visits": 0 } ], "countries": [ { "value": "string", "visits": 0 } ], "recent_payments": [ { "ts": "string", "amount": 0, "currency": "string", "status": "string" } ] }, "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}