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

# Brand API

> Read the campaigns, clips and campaign metrics of your brands from your own tools.

The Brand API is for brands whose campaigns run on ClipStake. It gives your
own tools the same data that your ClipStake dashboard shows.

The API is read-only. Every endpoint uses `GET`. An API key cannot change a
brand, a campaign or a clip.

> [card] [Quickstart](https://docs.clipstake.com/brand-api/quickstart.md)
>
> Create an API key and read your first campaign.

> [card] [Authentication](https://docs.clipstake.com/brand-api/authentication.md)
>
> Create, send and revoke API keys.

## What you can read

| Resource | What it contains |
| - | - |
| Brands | The brands that you are a member of. |
| Campaigns | Status, budget, platforms and rates for each campaign. |
| Campaign metrics | Views, spend, CPM and engagement for one campaign. |
| Campaign countries | The views and spend of one campaign for each country. |
| Clips | Views, engagement and status for each clip. |

## Base URL

```text theme={null}
https://app.clipstake.com/api/v1/brand
```

## IDs

Each ID starts with a prefix that names its resource.

| Prefix | Resource |
| - | - |
| `brd_` | Brand |
| `cmp_` | Campaign |
| `clip_` | Clip |

An ID that your API key cannot read returns `404`. This includes an ID of a
brand that you are not a member of, and an ID with the wrong prefix.

## Money and metrics

* Amounts are integers in US cents. For example, `125000` is \$1,250.00.
* A metric that was not measured is `null`. It is never `0`.
* The `platform` of a campaign or a clip is `instagram`, `x`, `tiktok` or
  `youtube`. More values can be added. Accept values that you do not know.


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