This endpoint returns all product categories from Passport that your subscription has access to within a given context. It will also reveal the hierarchical structure of these categories.
URI | https://api.euromonitor.com/catalog/category | |
Supported verbs | GET | |
Required headers | Ocp-Apim-Subscription-Key, Accept, Authorization | |
Supported formats | JSON, XML, CSV | |
Parameters | ||
CategoryContext | Context in which you want categories returned: Statistics or Analysis. Always use “Statistics” for Statistics API purposes. |
A successful response body will have the following structure in JSON format:
[
{
"id": 0,
"name": "string",
"parentId": 0,
"parentName": "string",
"level": 0,
"industryCode": "string",
"industryName": "string",
"industryOrder": 0
}
]
It is an array of Category objects, each with the following members:
id | The category ID |
name | The category name |
parentId | The ID of the parent category. This member references the "id" member of a different record. For root nodes, this member will have a value of null |
parentName | The name associated with the parent category. For root nodes, this member will have a value of null |
level | The node level of the category in the hierarchy tree. For root nodes, this member will have a value of 0, for child nodes 1, for grandchildren 2 etc. |
industryCode | The code for the industry this category object is associated with |
industryName | The name of the industry this category is associated with |
industryOrder | Denotes the order of this category object within the related industry |
Tissue and Hygiene
└ Away-from-Home Tissue and Hygiene
| └ Away-from-Home Hygiene
└ Retail Tissue and Hygiene
Will be represented by the Categories endpoint like this:
[
{
"id": 1,
"name": "Tissue and Hygiene",
"parentId": null,
"parentName": null,
"level": 0,
"industryCode": "DPP",
"industryName": "Tissue and Hygiene",
"industryOrder": 0
},
{
"id": 10,
"name": "Away-from-Home Tissue and Hygiene",
"parentId": 1,
"parentName": "Tissue and Hygiene",
"level": 1,
"industryCode": "DPP",
"industryName": "Tissue and Hygiene",
"industryOrder": 1
},
{
"id": 101,
"name": "Away-from-Home Hygiene",
"parentId": 10,
"parentName": "Away-from-Home Tissue and Hygiene",
"level": 2,
"industryCode": "DPP",
"industryName": "Tissue and Hygiene",
"industryOrder": 2
},
{
"id": 11,
"name": "Retail Tissue and Hygiene",
"parentId": 1,
"parentName": "Tissue and Hygiene",
"level": 1,
"industryCode": "DPP",
"industryName": "Tissue and Hygiene",
"industryOrder": 3
}
]