Docs/API REFERENCE/Referrers

Referrers

GET

Referrers

The referrers endpoint returns one paginated collection of top traffic sources. Cursors are opaque and totals are not returned by default.

Endpoint

GET https://trackfox.app/api/v1/referrers/top

Query Parameters

Parameter Type Required Description
websiteId string Yes The unique identifier of your website
period string No Defaults to last30d
startDate string Only for period=custom Custom period start date
endDate string Only for period=custom Custom period end date
timezone string No Defaults to UTC
limit number No Defaults to 50, maximum 100
cursor string No Opaque cursor from the previous response

Response

{
  "data": [
    {
      "domain": "google.com",
      "referrer": "https://google.com",
      "visitors": 88
    }
  ],
  "pagination": {
    "limit": 50,
    "hasMore": true,
    "nextCursor": "NEXT_CURSOR"
  }
}

Examples

curl "https://trackfox.app/api/v1/referrers/top?websiteId=site_123&period=last30d&limit=25" \
  -H "Authorization: Bearer tf_your_api_token_here"
curl "https://trackfox.app/api/v1/referrers/top?websiteId=site_123&period=last30d&limit=25&cursor=NEXT_CURSOR" \
  -H "Authorization: Bearer tf_your_api_token_here"

Need help? Contact us for assistance.

Suggest features? We'd love your feedback