Skip to main content
GET
List all tracked videos with analytics

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours from Settings → Integrations. A key created by a team member acts as that member and follows their current team permissions; a request outside those permissions returns 403 { "error": "insufficient_scope", "scope": "<required>" }.

Query Parameters

scope
enum<string>
default:company

Data scope. company (default) returns only the authenticated company's own data. agency returns the union of the parent agency plus every subaccount — use this to pull analytics across all brands.

scope=agency requires an API key belonging to a parent agency account (an account with isAgency=true and no parent). Passing it with a non-agency or subaccount key returns 403.

Available options:
company,
agency
page
integer
default:1
limit
integer
default:50
Required range: x <= 100
sortBy
enum<string>
default:uploadedAt

Field to sort by

Available options:
uploadedAt,
views,
likes,
engagement
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Free-text query matched against the tracked posts.

programId
string[]

Filter by campaign. Repeat the parameter for several. program is the legacy alias and is only consulted when programId is absent.

program
string[]

Legacy alias for programId. Ignored when programId is present.

platform
enum<string>[]

Filter by platform. Repeat the parameter for several. Use twitter rather than x, which is only the display name - this filter matches the stored value literally and does not resolve aliases. An unrecognised platform is not rejected; it simply matches nothing.

Available options:
tiktok,
instagram,
youtube,
snapchat,
facebook,
twitter,
linkedin
creatorId
string[]

Filter by creator. Repeat the parameter for several. creator is the legacy alias and is only consulted when creatorId is absent.

creator
string[]

Legacy alias for creatorId. Ignored when creatorId is present.

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.

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 for several. Intersected with creatorId, so passing both with no overlap matches nothing.

paid
enum<string>
default:all

Accepted but ignored. This API has no paid filter; the value is pinned to all internally regardless of what is sent.

Available options:
true,
false,
all

Response

200 - application/json

Successfully retrieved tracked videos

data
object[]
page
integer
limit
integer
total
integer
totalPages
integer
summary
object