Skip to main content
GET
Check field coverage

Authorizations

Authorization
string
header
required

Send your workspace API key as a bearer token:

Keys are scoped to a single workspace. See Authentication.

Query Parameters

entity
enum<string>
required

The entity type to report coverage for.

Available options:
shop,
product,
creator,
video,
livestream,
category
channel
enum<string>

Restrict to one channel. Omit to span every channel your workspace has enabled — each returned object names its own channel.

A sales channel — the commerce surface a request is about. Behind each channel is a cascade of data sources, tried in cost order until one verifies; the roster is published, but which source answered a given row is not carried in the response, so the cascade can be re-tuned without breaking your code.

Available options:
tiktok_shop
Example:

"tiktok_shop"

market
enum<string>

The market to measure, as an ISO 3166-1 alpha-2 code. An ISO 3166-1 alpha-2 country code identifying a channel storefront.

Available options:
US,
GB,
IE,
ES,
FR,
DE,
IT,
ID,
TH,
VN,
MY,
PH,
SG,
JP,
BR,
MX
Example:

"US"

Response

Field coverage for the requested entity.

object
string
Allowed value: "coverage"
entity
enum<string>
Available options:
shop,
product,
creator,
video,
livestream,
category
fields
object[]