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

# API introduction

> A REST API to read your channels, links, clicks and visitor journeys, and to drive referral programmes — plus signed webhooks for events.

TrackRev exposes a small, predictable REST API for reading your tracking data and driving referral
programmes, plus signed outbound [webhooks](/developers/webhooks) for real-time events.

## Base URL

```text theme={null}
https://app.trackrev.io/api/v1
```

All endpoints return JSON, accept and return UTF-8, and support CORS (so browser-safe endpoints can
be called with a publishable key from any origin).

## Quick example

```bash theme={null}
curl "https://app.trackrev.io/api/v1/channels?days=30&ltv=1" \
  -H "Authorization: Bearer <your secret key>"
```

```json theme={null}
{
  "window": { "from": "2026-06-21T00:00:00.000Z", "to": "2026-07-21T00:00:00.000Z" },
  "channels": [
    { "channel": "newsletter", "clicks": 1204, "visitors": 980, "conversions": 47, "revenue": 4231.5, "ltv": 9120.0 }
  ]
}
```

## What you can do

<CardGroup cols={2}>
  <Card title="Read analytics" icon="chart-simple">
    [Channels](/developers/endpoints/channels), [Links](/developers/endpoints/links),
    [Clicks](/developers/endpoints/clicks) and
    [Visitor journeys](/developers/endpoints/visitor-journey).
  </Card>

  <Card title="Drive referrals" icon="share-nodes">
    [Enroll referrers and report signups](/developers/endpoints/referrals) for product-led referral
    programmes.
  </Card>

  <Card title="Manage credit rewards" icon="gift">
    [List grants and mark them delivered](/developers/endpoints/credits).
  </Card>

  <Card title="React to events" icon="bolt">
    Subscribe to signed [webhooks](/developers/webhooks) for clicks, leads, sales and commissions.
  </Card>
</CardGroup>

## Before you start

<Info>
  The API is a **paid-plan** feature. Every `/api/v1` endpoint requires the workspace to be on an
  active paid plan; free workspaces receive a `402`. Generate keys under **Settings → Developers**.
</Info>

<Steps>
  <Step title="Create an API key">
    See [Authentication](/developers/authentication).
  </Step>

  <Step title="Make an authenticated request">
    Send your key as a Bearer token.
  </Step>

  <Step title="Handle errors and paginate">
    See [Errors](/developers/errors) and
    [Rate limits & pagination](/developers/rate-limits-and-pagination).
  </Step>
</Steps>