Quickstart - ClipStake Developer Docs

1. Create an API key

Sign in to the ClipStake web app.
Open Settings, then API keys.
Select Create API key and give the key a name.
Copy the key. ClipStake shows it only once.

Only the agency owner or an agency admin can create an API key. Store the key on your server, for example in an environment variable.

export CLIPSTAKE_API_KEY="ck_live_..."

2. List your campaigns

curl "https://app.clipstake.com/api/v1/agency/campaigns" \
  --header "Authorization: Bearer $CLIPSTAKE_API_KEY"

const response = await fetch("https://app.clipstake.com/api/v1/agency/campaigns", {
  headers: { Authorization: `Bearer ${process.env.CLIPSTAKE_API_KEY}` },
});
const { data, next_cursor } = await response.json();

Each campaign in data has an id that starts with cmp_. Copy one ID for the next steps. To list the campaigns of one brand, add brand_id:

curl "https://app.clipstake.com/api/v1/agency/campaigns?brand_id=brd_..." \
  --header "Authorization: Bearer $CLIPSTAKE_API_KEY"

3. Read the campaign metrics

curl "https://app.clipstake.com/api/v1/agency/campaigns/$CAMPAIGN_ID/metrics" \
  --header "Authorization: Bearer $CLIPSTAKE_API_KEY"

const response = await fetch(
  `https://app.clipstake.com/api/v1/agency/campaigns/${campaignId}/metrics`,
  { headers: { Authorization: `Bearer ${process.env.CLIPSTAKE_API_KEY}` } },
);
const metrics = await response.json();

The metrics are the same figures that the campaign dashboard shows.

4. Page through the clips

To list only some clips, add status or platform. For example, ?status=approved&platform=instagram lists the approved Instagram clips. A list returns up to 25 items by default. Send next_cursor back as cursor to get the next page. Stop when next_cursor is null.

curl "https://app.clipstake.com/api/v1/agency/campaigns/$CAMPAIGN_ID/clips?limit=100" \
  --header "Authorization: Bearer $CLIPSTAKE_API_KEY"

curl "https://app.clipstake.com/api/v1/agency/campaigns/$CAMPAIGN_ID/clips?limit=100&cursor=$NEXT_CURSOR" \
  --header "Authorization: Bearer $CLIPSTAKE_API_KEY"

const clips = [];
let cursor = null;

do {
  const url = new URL(
    `https://app.clipstake.com/api/v1/agency/campaigns/${campaignId}/clips`,
  );
  url.searchParams.set("limit", "100");
  if (cursor) url.searchParams.set("cursor", cursor);

  const response = await fetch(url, {
    headers: { Authorization: `Bearer ${process.env.CLIPSTAKE_API_KEY}` },
  });
  const page = await response.json();
  clips.push(...page.data);
  cursor = page.next_cursor;
} while (cursor);

Next steps

Read Pagination before you follow a cursor with filters.
Read Errors to handle each error code.