Bloss Docs

Campaign reach by day

Developers
GET
/brands/{brandId}/campaign/daily

Videos posted and views gained per day across the campaign's cycles, in the brand's time zone. Summing the days gives GET /brands/{brandId}/campaign/summary for the same cycles: a video counts once on the day it was posted, and views are each video's own day-over-day gain. tagIds and groupIds scope both series.

Authorization

bearerAuth analytics:read
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, recruitment:read, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read.

Scope: analytics:read

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length

Query Parameters

cycleIds*string

Comma-separated payout cycle ids (from GET /brands/{brandId}/cycles): the cycles that make up the campaign.

Length1 <= length
tagIds?string

Comma-separated tag ids (from GET /brands/{brandId}/tags). Matches any of them.

groupIds?string

Comma-separated creator-group ids (from GET /brands/{brandId}/creator-groups); __ungrouped__ selects creators in no group. Matches creators in any of them. An unknown group id is a 400.

from?string

Clamp the window's start, YYYY-MM-DD. Default: the first cycle's first day.

to?string

Clamp the window's end, YYYY-MM-DD. Default: the last cycle's last day.

Response Body

Success.

application/json
  1. response
from*string
to*string
days*array<>
curl -X GET 'https://example.com/api/v1/brands/string/campaign/daily?cycleIds=string'
{  "from": "string",  "to": "string",  "days": [    {      "date": "string",      "videos": 0,      "views": 0    }  ]}

Was this page helpful?

Claims on a bounty GET

The creators who claimed a bounty, oldest first, with each claim's status ("pending", "approved", "paid" or "rejected"), when it was claimed, completed, approved and paid, and who approved it.

Campaign spend and budget GET

What a campaign (a set of payout cycles) has cost: spend is base pay + CPM bonus, the pay your creators earn on those cycles' sets. With `prepayment` (the budget you were prepaid), also what remains and whether spend has reached `thresholdPct` of it. `tagIds` and `groupIds` scope the totals. `breakdown=tag` adds spend and CPM per tag (attributed by the set's tags; a set with several tags counts under each; `tagIds` doesn't apply to it). `breakdown=day` adds spend per day, which is null on every day when `tagIds` or `groupIds` is set (pay can't be attributed to a day that way) and on days no cycle covers; a day can be negative when pay was revised down. Full admins only.