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

# Overview

Product responses include buy URLs that look like `buy.trychannel3.com/***`. These links route shoppers to the merchant site and let Channel3 attribute clicks and sales to your account.

You can pull click, commission, and API usage data for your account with the endpoints below. Use it to power dashboards, reconcile payouts, or feed analytics into your own systems.

## What you can pull

> [card] [Clicks](/docs/guides/reporting/clicks.md)
>
> Click events plus a total-click summary for your date window.

> [card] [Sales](/docs/guides/reporting/sales.md)
>
> Transactions plus net commission totals for your date window.

> [card] [By user](/docs/guides/reporting/by-user.md)
>
> Send `x-user-id` on search, then filter clicks and sales to that user.

> [card] [By conversation](/docs/guides/reporting/by-conversation.md)
>
> Send `x-conversation-id` so the searches in one shopper session group together.

Commission amounts on sales are **your net share** after Channel3's take rate. See [Commissions](/docs/commissions.md) for how payouts work.

## API usage

Returns the number of API requests your account made each day, split by endpoint. It reads the same data as the usage graph in your dashboard, so you can reproduce that view over any window of up to 90 days.

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl "https://api.trychannel3.com/v1/reporting/usage?start_date=2026-07-01T00:00:00Z&end_date=2026-07-31T23:59:59Z&timezone=America/New_York" \
  -H "x-api-key: $CHANNEL3_API_KEY"
```

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "endpoints": ["get_product_detail", "lookup", "search"],
  "days": [
    {
      "date": "2026-07-01",
      "total_requests": 1240,
      "counts": { "search": 980, "get_product_detail": 240, "lookup": 20 }
    },
    {
      "date": "2026-07-02",
      "total_requests": 1105,
      "counts": { "search": 870, "get_product_detail": 215, "lookup": 20 }
    }
  ],
  "total_requests": 2345,
  "start_date": "2026-07-01T00:00:00Z",
  "end_date": "2026-07-31T23:59:59Z",
  "timezone": "America/New_York"
}
```

* `days` has one entry per day with at least one request, oldest first. Days with no traffic are omitted.
* `counts` is keyed by endpoint name. `endpoints` lists every name present in the window so you can build a stable legend or stacking order.
* `timezone` is an optional IANA name (for example `America/New_York`) that controls which calendar day each request falls into. It defaults to `UTC`. An unknown name returns `400`.
* Counts are near real-time and include every request, whether or not it was billable. Calls to free endpoints, failed requests, and requests covered by free credits all appear here, so the totals are a traffic view, not a billing statement.

## Send feedback

Use [`POST /v1/reporting/feedback`](/docs/api-reference/v1/submit-feedback) to report a problem or share feedback about the API or its data. It's free, and your own agents can call it when they hit something unexpected.

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST https://api.trychannel3.com/v1/reporting/feedback \
  -H "x-api-key: $CHANNEL3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "data_issue",
    "description": "Product 2yh8WH5 shows the wrong brand.",
    "endpoint": "/v1/products/{product_id}"
  }'
```

| Field | Required | Description |
| - | - | - |
| `category` | Yes | One of `error_response`, `performance`, `incorrect_behavior`, `data_issue`, `documentation`, or `other`. |
| `description` | Yes | What happened, up to 4,000 characters. Include inputs, status codes, or product IDs that help us reproduce it. |
| `endpoint` | No | The API endpoint this feedback is about, up to 200 characters. |

A successful request returns `201`:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "feedback_id": "fb_8e1d4c...",
  "status": "received",
  "created_at": "2026-11-09T20:18:42Z"
}
```

Leave API keys and other secrets out of `description`. Requests are limited to 1 per second and 100 per day for each account. A request over either limit returns `429` with a `Retry-After` header.


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