Bloss Docs

The latest full sync's progress

Developers
GET
/brands/{brandId}/sync

The brand's latest brand-wide sync, whoever started it (trigger: "api", "app" for the app's Full sync or Sync all creators buttons, "scheduled" for the nightly sync): its status, when it started and finished, and how many creators it has done. status covers fetching the creators' posts: "running"; "success" (every creator synced); "incomplete" (some failed); "failed" (none synced, or it crashed); "stalled" (it stopped making progress and won't finish); "none" (no sync in the last two weeks). After the creators are done, a full sync goes on to pair videos into sets and recalculate the unpaid cycles' pay, and that last step isn't tracked: when status turns "success" or "incomplete", allow a few minutes before reading sets and pay.

Authorization

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

Path Parameters

brandId*string

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

Length1 <= length

Response Body

Success.

application/json
  1. response
status*string
Value in"running""success""incomplete""failed""stalled""none"
trigger*|

Who started it: "api", "app", "scheduled" (nightly), or "other". Null when status is "none".

startedAt*string|null
finishedAt*|

When the creators were done; null while running.

lastActivityAt*|

When the sync last started a creator.

creators*
curl -X GET 'https://example.com/api/v1/brands/string/sync'
{  "status": "running",  "trigger": "api",  "startedAt": "string",  "finishedAt": "string",  "lastActivityAt": "string",  "creators": {    "total": 0,    "done": 0,    "failed": 0  }}

Was this page helpful?