> ## Documentation Index
> Fetch the complete documentation index at: https://docs.taap.it/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom events

> Most frequent custom events tracked for the project

Returns the most frequent custom events tracked for the project bound to your API key, ranked by
volume.

**Request:**

```bash cURL theme={null}
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:**

```json theme={null}
{
  "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

<ParamField header="Authorization" type="string" required>
  Bearer token with your Radar API key. Format: `Bearer taapit_...`
</ParamField>

## Query Parameters

<ParamField query="start" type="string">
  Start of the range, ISO 8601 (UTC). Optional — omit for all time.
</ParamField>

<ParamField query="end" type="string">
  End of the range, ISO 8601 (UTC). Optional — omit for all time.
</ParamField>

<ParamField query="limit" type="integer" default="50">
  Maximum number of events to return. Capped at `500`.
</ParamField>

## Response Fields

<ResponseField name="data" type="array" required>
  Custom events ranked by volume.

  <Expandable title="Event" defaultOpen>
    <ResponseField name="event_name" type="string">Name of the custom event.</ResponseField>
    <ResponseField name="people" type="number">Number of unique people who triggered it.</ResponseField>
    <ResponseField name="events" type="number">Total number of times the event fired.</ResponseField>
    <ResponseField name="completion_rate" type="number">Reserved for funnel use; currently `0`.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="limit" type="integer">
  The effective limit applied to this response.
</ResponseField>