Skip to content

REST API v1 · Resource

Segments

Saved audiences a broadcast can name: list, create, change and delete them.

API reference · Segments

Endpoints

Paths are relative to https://fliok.com/api/v1. Each endpoint names the scope and the lowest key role it needs; a key without them gets 403 (see Authentication).

Segments

5
  • GET/segmentsSaved audiences — the same ones the broadcast composer saves and loadsScope broadcasts:read · viewer role or higher
  • POST/segmentsSave an audience under a name (the definition is the `segment` POST /broadcasts takes). Re-saving a name replaces itScope broadcasts:write · admin role or higher
  • GET/segments/{id}One saved audienceScope broadcasts:read · viewer role or higher
  • PATCH/segments/{id}Rename a saved audience or change who it covers. Broadcasts already made keep their own copyScope broadcasts:write · admin role or higher
  • DELETE/segments/{id}Delete a saved audience. Broadcasts that used it are untouchedScope broadcasts:write · admin role or higher

Rate limits

These endpoints have no row of their own in the rate-limit table.

Every limit, the RateLimit-* headers and what to do on a 429: Rate limits.