Skip to content

Quickstart Guides API reference Webhooks

Getting started

Quickstart
Authentication
Versioning
Errors
Pagination
Idempotency
Rate limits
Mock server

Core concepts

Organisations and sites
Screens and Harvesters
Passport and wrapping
Plays and verification scores

Guides

Register screens
Wrap a creative
Read verification and plays
Receive webhooks

SDKs

TypeScript

Webhook events

All events
screen.quality
screen.calibrated
wrapper.readyplanned
wrapper.failedplanned
pod.verifiedlegacy
verification.ping
verification.pod
verification.score

API reference

All endpoints

Account

getGet the signed-in user (not available yet)
putSet the default organisation (not available yet)
getList accessible organisations (not available yet)
postCreate an organisation (not available yet)
getGet the active organisation
getList the organisation's entitlements (not available yet)

Screens

getList screens
postCreate a screen
getGet a screen
patchUpdate a screen
deleteDelete a screen
putAssign a harvester to a screen (not available yet)
deleteUnassign a screen's harvester (not available yet)
putAssign a screen to a site (not available yet)
deleteRemove a screen from its site (not available yet)
postCalibrate a screen (not available yet)
getList screen size ranges

Sites

getList sites
postCreate a site
getGet a site (not available yet)
patchUpdate a site (not available yet)
deleteDelete a site (not available yet)

Harvesters

getList harvesters (not available yet)
postActivate a harvester (not available yet)
getGet a harvester (not available yet)

Clients

getList clients (not available yet)
getGet a client (not available yet)

Campaigns

getList campaigns (not available yet)
getGet a campaign (not available yet)

Advertisements

getList advertisements (not available yet)
postRegister an advertisement (not available yet)
postStart an upload (not available yet)
getGet an advertisement (not available yet)
patchUpdate an advertisement (not available yet)
deleteArchive an advertisement (not available yet)

Wrappers

postCreate a wrapper
getGet a wrapper

Plays

getList plays
getGet a play
getList a play's evidence events

Webhooks

getList webhook endpoints
postCreate a webhook endpoint
getGet a webhook endpoint
patchUpdate a webhook endpoint
deleteDelete a webhook endpoint
postRoll a webhook endpoint's signing secret
getList recent deliveries
postRetry a delivery

Stats

getPlays over time (not available yet)
getActivity matrix (not available yet)
getScreens needing attention (not available yet)
getList operational issues (not available yet)
getPer-site harvester health (not available yet)
getVerified plays by method (not available yet)
getScreen performance (not available yet)
getScreen content breakdown (not available yet)
getScreen quality (not available yet)
getHarvester verified plays (not available yet)
getEvidence composition by month

Dashboards

getGet the home dashboard template (not available yet)
getList dashboards (not available yet)
postCreate a dashboard (not available yet)
getGet a dashboard (not available yet)
patchUpdate a dashboard (not available yet)
deleteDelete a dashboard (not available yet)

More

Error codes
Changelog and versioning

SDKs

TypeScript
A typed client generated from the API contract.