Skip to main content
GET
Tracked videos

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

X-Act-As-Company
string

OAuth human grants and scoped Platform API keys can act on one direct agency sub-account included in their explicit delegation. Current parent relationship, authorizing person access, child scope ceiling, and subscription eligibility are checked. Omit this header to act on the connected company. Machine client_credentials tokens do not carry delegation. Query parameters such as companyId, company_id, client, and subaccountId are not general tenant selectors where an endpoint does not explicitly document them.

Query Parameters

page
integer
default:1

1-based page number.

Required range: x >= 1
limit
integer
default:50

Page size. Values above 100 are clamped to 100.

Required range: 1 <= x <= 100
sortBy
string
default:uploadedAt

Field to sort videos by.

sortOrder
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Free-text query matched against the tracked posts.

programId
string[]

Restrict results to these campaigns. Repeat the parameter to pass several ids. program is the legacy alias and is only consulted when programId is absent.

program
string[]

Legacy alias for programId. Ignored when programId is present.

creatorId
string[]

Restrict results to these creators. Repeat the parameter to pass several ids. creator is the legacy alias and is only consulted when creatorId is absent.

creator
string[]

Legacy alias for creatorId. Ignored when creatorId is present.

platform
string[]

Restrict results to these platforms. Repeat the parameter for several.

programStatus
enum<string>

Restrict to campaigns in this state. Unrecognised values are ignored.

Available options:
active,
all,
archived
fromDate
string<date>

Inclusive start of the date window, YYYY-MM-DD, interpreted at 00:00:00Z.

toDate
string<date>

Inclusive end of the date window, YYYY-MM-DD, interpreted at 23:59:59Z.

ghostHandles
enum<string>

Whether unclaimed (ghost) handles are counted. Defaults to all when omitted.

Available options:
all,
include,
exclude
excludeDeletedVideos
boolean
default:false

Pass true to drop posts that have since been deleted. Any other value is false.

approvalStatus
enum<string>

Restrict to posts in this review state.

Available options:
all,
approved,
rejected,
unreviewed
minViews
integer

Only include posts with at least this many views. A value of 0 is a no-op.

Required range: x >= 0
maxViews
integer

Only include posts with at most this many views. A value of 0 is a no-op.

Required range: x >= 0
creatorCollectionId
string[]

Restrict to creators in these account groups. Repeat the parameter for several. Combined with creatorId as an intersection, so passing both with no overlap matches nothing.

Response

Success. Returns the resource envelope.

data
object
required