Skip to main content
GET
/
api
/
v1
/
radar
/
custom-events
Custom events
curl --request GET \
  --url https://taap.it/api/v1/radar/custom-events \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "event_name": "<string>",
      "people": 123,
      "events": 123,
      "completion_rate": 123
    }
  ],
  "limit": 123
}
Returns the most frequent custom events tracked for the project bound to your API key, ranked by volume. Request:
cURL
curl -X GET 'https://taap.it/api/v1/radar/custom-events?start=2026-01-01T00:00:00Z&end=2026-01-31T23:59:59Z&limit=20' \
  -H 'Authorization: Bearer taapit_your_api_key_here'
Response:
{
  "data": [
    { "event_name": "signup_click", "people": 240, "events": 312, "completion_rate": 0 },
    { "event_name": "add_to_cart", "people": 180, "events": 410, "completion_rate": 0 }
  ],
  "limit": 20
}

Authorization

Authorization
string
required
Bearer token with your Radar API key. Format: Bearer taapit_...

Query Parameters

start
string
Start of the range, ISO 8601 (UTC). Optional — omit for all time.
end
string
End of the range, ISO 8601 (UTC). Optional — omit for all time.
limit
integer
default:"50"
Maximum number of events to return. Capped at 500.

Response Fields

data
array
required
Custom events ranked by volume.
limit
integer
The effective limit applied to this response.