Bloss Docs

The brand's videos

Developers
GET
/brands/{brandId}/videos

The creators' videos as the Video Vault lists them, newest post first: creator, platform, link, posted time, views, likes, comments and shares, the set (pair) each belongs to, tags, link health and eligibility. Same membership as the Vault: live creators, videos with a posted date and tracked metrics. Metrics are live, or as of the window's last day when to or the cycle ended in the past. Pay is not included.

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
platform?string

Only this platform: instagram, tiktok, youtube or facebook.

Value in"instagram""tiktok""youtube""facebook"
creatorId?string

Only this creator's videos.

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.

cycleId?string

Only videos posted inside this payout cycle; metrics are then as of the cycle's last day.

from?string

Posted on or after this day, YYYY-MM-DD in the brand's time zone.

to?string

Posted on or before this day, YYYY-MM-DD in the brand's time zone.

q?string

Search captions, titles, and creator names and handles.

includeIrrelevant?string

"true" to include videos marked irrelevant. Default false.

Value in"true""false"
eligibleOnly?string

"true" for videos whose set meets the payout rules only.

Value in"true""false"
linkHealth?string

"has_dead": only sets holding a post whose link is dead; "no_dead": only sets with none.

Value in"has_dead""no_dead"
updatedSince?string

Only videos changed (e.g. new metrics) at or 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/videos'
{  "data": [    {      "id": "string",      "platform": "string",      "platformVideoId": "string",      "url": "string",      "title": "string",      "caption": "string",      "thumbnailUrl": "string",      "durationSeconds": 0,      "postedAt": "string",      "views": 0,      "likes": 0,      "comments": 0,      "shares": 0,      "engagementRate": 0,      "setId": "string",      "inSet": true,      "irrelevant": true,      "addedByUrl": true,      "linkHealth": {        "status": "available",        "reason": "string",        "unavailableAt": "string",        "detectedOwnerHandle": "string"      },      "tags": [        {          "id": "string",          "name": "string",          "color": "string"        }      ],      "creator": {        "id": "string",        "name": "string",        "handle": "string"      },      "eligibility": {        "set": "eligible",        "video": "eligible",        "reason": "string"      },      "updatedAt": "string"    }  ],  "nextCursor": "string"}

Was this page helpful?