Bloss Docs

List matched posts

Developers
GET
/brands/{brandId}/scripts/matches

Each matched post's script, status, lead and best guesses, newest post first. filter narrows it: "open" (waiting for a pick), "auto" (set by matching), "person" (set by a person), "skipped" (not campaign or nothing to read) or "all". counts has every filter's total.

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, onboarding:read, onboarding:signatures, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read, groups:write, videos:write, onboarding:write, sync:write, payouts:write.

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

Which posts. Default: open.

Default"open"
Value in"open""auto""person""skipped""all"

Response Body

Success.

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

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

counts*
curl -X GET 'https://example.com/api/v1/brands/string/scripts/matches'
{  "data": [    {      "videoId": "string",      "platform": "string",      "title": "string",      "postUrl": "string",      "postedAt": "string",      "creatorName": "string",      "setId": "string",      "script": {        "id": "string",        "code": "string",        "title": "string"      },      "status": "set",      "source": "transcript",      "lead": 0,      "guesses": [        {          "scriptId": "string",          "code": "string",          "score": 0        }      ],      "reason": "string"    }  ],  "nextCursor": "string",  "counts": {    "property1": -9007199254740991,    "property2": -9007199254740991  }}

Was this page helpful?