Skip to main content
GET
Get category metrics over time

Authorizations

Authorization
string
header
required

Send your workspace API key as a bearer token:

Keys are scoped to a single workspace. See Authentication.

Path Parameters

category_id
string
required

The Unif ID of the category.

Query Parameters

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"

metrics
string

Comma-separated metric names to return, for example revenue,units_sold.

Example:

"revenue,units_sold"

granularity
enum<string>
default:day

Bucket size for the series.

Available options:
day,
week,
month
period
enum<string>
default:last_30d

A named period. Mutually exclusive with period_start and period_end.

Available options:
last_7d,
last_30d,
last_90d,
last_180d,
month_to_date,
previous_month
period_start
string<date>

First day of a custom period, inclusive.

period_end
string<date>

Last day of a custom period, inclusive.

currency
string
default:USD

Convert every monetary field to this ISO 4217 currency.

Examples:

"USD"

"GBP"

"IDR"

Response

The metric series.

object
string
Allowed value: "timeseries"
entity_id
string
entity_type
enum<string>
Available options:
shop,
product,
creator,
video,
livestream,
category
granularity
enum<string>
Available options:
day,
week,
month
currency
string
period
object

The concrete window a request was measured over, after any preset was expanded and any channel-specific snapping was applied. Always read this rather than assuming you got back exactly the dates you asked for.

data
object[]
meta
object

How current and how complete this record is.