Custom Events

The custom events endpoint returns paginated summaries grouped by event name. Cursors are opaque; pass pagination.nextCursor back as cursor without editing it. Totals are not returned by default.

Endpoint

GET https://trackfox.app/api/v1/custom-events

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": [
    {
      "name": "signup",
      "count": 24,
      "uniqueUsers": 21,
      "timestamp": "2026-05-14T15:32:18.000Z",
      "paymentAmount": null,
      "totalRevenue": null,
      "currency": null,
      "orderId": null,
      "productId": null,
      "category": null,
      "customProperties": {
        "plan": "pro"
      }
    }
  ],
  "pagination": {
    "limit": 50,
    "hasMore": true,
    "nextCursor": "NEXT_CURSOR"
  }
}

Examples

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

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