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

# Clicks

`GET /v1/reporting/clicks` lists click events for your account, plus a total-click summary for the whole date window.

## Date windows

Pass `start_date` and `end_date` as ISO 8601 datetimes:

* Omit both to default to the **last 30 days** ending now.
* Provide **both** or **neither** — a single bound returns `400`.
* Maximum window is **90 days**.
* Offset-aware values (e.g. `2026-08-01T00:00:00-04:00`) are converted to UTC. Naive values are treated as UTC.
* Responses echo the resolved window as UTC (`...Z`).

## Pagination

Results are newest-first. Use `page` (1-indexed) and `limit` (1–100, default 20). Each response includes `total_count`, `has_more`, and a `summary` for the full window (not just the current page).

Every offer URL in a search or product response is a tracked buy link. When a shopper clicks it, Channel3 records the click. You do not need to configure anything for this to work.

```typescript TypeScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
import Channel3 from "@channel3/sdk";

const client = new Channel3();

const clicks = await client.reporting.clicks.list({
  start_date: "2026-07-01T00:00:00Z",
  end_date: "2026-07-31T23:59:59Z",
  page: 1,
  limit: 50,
  user_id: "ABCD", // optional
});

console.log(clicks.summary.total_clicks);
for (const click of clicks.items) {
  console.log(click.timestamp, click.product?.title, click.country);
}
```

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
from channel3_sdk import Channel3

client = Channel3()

clicks = client.reporting.clicks.list(
    start_date="2026-07-01T00:00:00Z",
    end_date="2026-07-31T23:59:59Z",
    page=1,
    limit=50,
    user_id="ABCD",  # optional
)

print(clicks.summary.total_clicks)
for click in clicks.items:
    print(click.timestamp, click.product, click.country)
```

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl "https://api.trychannel3.com/v1/reporting/clicks?start_date=2026-07-01T00:00:00Z&end_date=2026-07-31T23:59:59Z&page=1&limit=50&user_id=ABCD" \
  -H "x-api-key: $CHANNEL3_API_KEY"
```

Each click includes an `id`, `timestamp`, optional `user_id`, optional geo (`city` / `country`), and a compact `product` when we can match one (`id`, `title`, `image_url`).

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "clk_abc123",
  "timestamp": "2026-07-15T14:22:00Z",
  "user_id": "ABCD",
  "product": {
    "id": "2yh8WH5",
    "title": "Running Shoe",
    "image_url": "https://cdn.trychannel3.com/..."
  },
  "country": "US"
}
```

Pass `user_id` to limit the list to one person. See [By user](/docs/guides/reporting/by-user.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.