Get started

Quickstart

The fastest way to feel out the API is to list your campaigns. You'll need an API key (one minute) and a terminal.

1. Create an API key

In your organization dashboard, open Settings → API Keys and click Create key. The key starts with ugcb_live_and is shown once, so store it somewhere safe. Every key is scoped to a single organization and can't see data from other orgs.

2. List your campaigns

Pass the key as a bearer token. Everything else is plain HTTPS. No SDKs required.

terminal

bash

curl https://ugcbloom.com/api/v1/campaigns \
  -H "Authorization: Bearer ugcb_live_your_api_key_here"

You should get back a paginated list of campaigns. Pick a campaign id from the response and use it with any of the other endpoints. Most paths follow the shape /campaigns/{campaignId}/....

3. Explore

From there it's all read endpoints. The Campaigns section is the most common starting point. Pull stats, charts, leaderboards and per-creator performance from a single campaign id.