Bloss Docs

A creator's posting compliance

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

One creator's posting compliance against the brand's posting rules, as the profile's Compliance tab shows it: the rules, the creator's bucket, and per platform the posts, weeks under the minimum, days over the maximum, the busiest day and week, and the current week's pace, plus posts per day. Days are in the brand's time zone. Default window: the last 84 days; to can't be after today. creator is null for paused and archived creators, who aren't scored.

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

Query Parameters

from?string

First day, YYYY-MM-DD. Default: 84 days before to.

to?string

Last day, YYYY-MM-DD. Default: today.

Response Body

Success.

application/json
  1. response
window*
rules*array<>
creator*|null
curl -X GET 'https://example.com/api/v1/brands/string/creators/string/compliance'
{  "window": {    "from": "string",    "to": "string",    "timeZone": "string"  },  "rules": [    {      "platform": "instagram",      "enforced": true,      "minPerWeek": 0,      "maxPerDay": 0,      "source": "default"    }  ],  "creator": {    "bucket": "over",    "worstPlatform": "instagram",    "joinedDay": "string",    "postsInWindow": 0,    "judgeableWeeks": [      "string"    ],    "platforms": [      {        "platform": "instagram",        "enforced": true,        "connected": true,        "scored": true,        "minPerWeek": 0,        "maxPerDay": 0,        "postsInWindow": 0,        "weeksInWindow": 0,        "requiredPosts": 0,        "weeksMetMin": 0,        "weeksUnderMin": [          "string"        ],        "daysOverMax": [          "string"        ],        "worstDay": {          "date": "string",          "posts": 0        },        "worstWeek": {          "weekStart": "string",          "posts": 0        },        "currentWeek": {          "weekStart": "string",          "posts": 0,          "expected": 0,          "onPace": true,          "judged": true        }      }    ],    "postsPerDay": [      {        "date": "string",        "platform": "instagram",        "posts": 0      }    ]  }}

Was this page helpful?