Skip to main content
GET
Get a category

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"

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
currency
string
default:USD

Convert every monetary field to this ISO 4217 currency.

Examples:

"USD"

"GBP"

"IDR"

Response

The category.

A node in the normalized category tree.

id
string
Example:

"cat_beauty_personal_care"

object
string
Allowed value: "category"
name
string
Example:

"Beauty & Personal Care"

parent_id
string | null
level
integer
Required range: x >= 1
path
string[]
children
array
market
enum<string>

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
object
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.

currency
string