Bloss Docs

The brand's sets (pairs) with their videos

Developers
GET
/brands/{brandId}/sets

One row per set (pair) in the given payout cycles: the creator, the set's tags, its summed engagement and each of its videos with platform, link, posted time and metrics. Metrics come from the latest snapshot inside the set's cycle, the same figures the campaign endpoints total. Ordered by (updatedAt, setId) ascending; pass updatedSince with the largest updatedAt you stored to sync what changed. Pay is not included: read it with GET /brands/{brandId}/campaign/spend.

Authorization

bearerAuth videos: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: videos:read

Path Parameters

brandId*string

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

Length1 <= length

Query Parameters

limit?integer

Page size, 1–100. Default 50.

Range1 <= value <= 100
Default50
cursor?string

The nextCursor from the previous page. Omit for the first page.

Length1 <= length
cycleIds?string

Comma-separated payout cycle ids (from GET /brands/{brandId}/cycles). Default: every cycle.

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.

creatorId?string

Only this creator's sets.

updatedSince?string

Only sets whose updatedAt is strictly after this time.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time

Response Body

Success.

application/json
  1. response
data*array<>
nextCursor*|

Pass as cursor to get the next page; null on the last page.

curl -X GET 'https://example.com/api/v1/brands/string/sets'
{  "data": [    {      "setId": "string",      "cycleId": "string",      "creator": {        "creatorId": "string",        "name": "string",        "handles": {          "instagram": "string",          "tiktok": "string",          "youtube": "string",          "facebook": "string"        },        "groupIds": [          "string"        ]      },      "firstVideoAt": "string",      "videoCount": 0,      "countedVideos": 0,      "views": 0,      "likes": 0,      "comments": 0,      "shares": 0,      "saves": 0,      "tagIds": [        "string"      ],      "updatedAt": "string",      "videos": [        {          "videoId": "string",          "platform": "string",          "handle": "string",          "postUrl": "string",          "postedAt": "string",          "snapshotDate": "string",          "views": 0,          "likes": 0,          "comments": 0,          "shares": 0,          "saves": 0        }      ]    }  ],  "nextCursor": "string"}

Was this page helpful?

Referral payouts GET

Referral bonuses owed or paid to creators whose invite code brought in another creator, newest first, as on the Referral Payouts page.

List open account alerts GET

Open alerts about creators' social accounts, newest first: a handle that changed, or a profile that can't be found. The handle on file is never changed automatically; an admin applies or dismisses each alert in the app.