Bloss Docs

The videos behind one day of the analytics chart

Developers
GET
/brands/{brandId}/analytics/days/{date}

The drill-down behind one day of the brand's analytics charts: the videos posted that day, or those that gained that day, with each video's creator. total and totals cover every match (they equal the chart point), not just this page.

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
date*string

The day, YYYY-MM-DD in the brand's time zone.

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

The chart window's first day; default date. Must include date.

to?string

The chart window's last day; default date. Must include date.

kind?string

"posted" (default): videos posted that day; "gained": videos that gained views or engagement that day.

Default"posted"
Value in"posted""gained"
metric?string

For kind=gained: what counts as gaining. Default "any".

Default"any"
Value in"views""engagement""any"
mode?string

"cohort" (default): only videos posted inside from–to, as the brand charts count; "activity": any video.

Default"cohort"
Value in"cohort""activity"
creatorId?string

Only this creator's videos.

platform?string

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

Value in"instagram""tiktok""youtube""facebook"
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.

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"
sort?string
Default"views"
Value in"views""likes""eng"

Response Body

Success.

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

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

total*number

Videos matching, across all pages.

totals*
curl -X GET 'https://example.com/api/v1/brands/string/analytics/days/string'
{  "data": [    {      "id": "string",      "platform": "string",      "url": "string",      "caption": "string",      "thumbnailUrl": "string",      "postedAt": "string",      "views": 0,      "likes": 0,      "comments": 0,      "shares": 0,      "creator": {        "id": "string",        "name": "string",        "handle": "string"      }    }  ],  "nextCursor": "string",  "total": 0,  "totals": {    "views": 0,    "likes": 0,    "comments": 0,    "shares": 0  }}

Was this page helpful?

Who am I GET

Your account, your creator and coach profiles, and every brand you belong to, with your role in each. Start here to find the ids other endpoints take.

The instant base pay queue GET

Sets (pairs) whose base pay qualified mid-cycle and wait for an admin to review and pay, as on Payouts › Base pay. Pending by default; pass `status` for decided requests. Read-only: nothing here approves or pays. Newest first.