Bloss Docs

A creator's trial

Developers
GET
/brands/{brandId}/creators/{creatorId}/trial

Trial progress as admins see it, whatever the creator's status now: the goal (qualifying videos, each reaching viewGoal views, within trialDays of joining), progress, days left, and the videos posted in the trial window, each marked if it qualifies. When the brand runs no trial everyone passes and videos is empty.

Authorization

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

Path Parameters

brandId*string

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

Length1 <= length
creatorId*string

A creator id from GET /brands/{brandId}/creators.

Length1 <= length

Response Body

Success.

application/json
  1. response
enabled*boolean

Whether this brand runs a trial at all.

creatorStatus*string

"trial", "active", "paused" or "archived" (removed from the roster; kept for history).

Value in"trial""active""paused""archived"
inTrial*boolean

On trial, inside the window, and not passed yet.

completed*boolean
skipped*boolean

An admin waived the trial.

withinWindow*boolean
qualifyingVideos*number
videoGoal*number
viewGoal*number

Views each qualifying video needs.

videosRemaining*number
progressPercent*number
totalViews*number

Views on all trial-window videos.

totalVideos*number
trialDays*number
daysRemaining*number
startedAt*string
endsAt*string
videos*array<>
curl -X GET 'https://example.com/api/v1/brands/string/creators/string/trial'
{  "enabled": true,  "creatorStatus": "trial",  "inTrial": true,  "completed": true,  "skipped": true,  "withinWindow": true,  "qualifyingVideos": 0,  "videoGoal": 0,  "viewGoal": 0,  "videosRemaining": 0,  "progressPercent": 0,  "totalViews": 0,  "totalVideos": 0,  "trialDays": 0,  "daysRemaining": 0,  "startedAt": "string",  "endsAt": "string",  "videos": [    {      "id": "string",      "platform": "string",      "url": "string",      "caption": "string",      "postedAt": "string",      "views": 0,      "qualifies": true,      "addedByUrl": true    }  ]}

Was this page helpful?

A creator's account analytics GET

Account-level analytics for each platform the creator connected for cross-posting (followers, views, impressions, likes, comments, posts), and the audience breakdowns a platform reports (Instagram: country, city, gender, age; TikTok: age, city). The latest stored figures, as the profile's Social analytics panel shows them; this never forces a refresh. Empty when the creator connected nothing.

A creator's posting violations GET

The posting-rule violations stored for a creator, newest first, as the profile lists them: a day over a platform's daily maximum ("daily") or a completed week under its weekly minimum ("weekly"). `date` is that day or the week's first day. `platform` is null on old rows from before rules were per platform.