Taxonomy data

These endpoints contain data that expose the taxonomy of categories, brands etc.

Sectors with brands

This endpoint responds with a payload that lists all available sectors to the company as well as all brands for each sector.

Also, it will return with a Content-Disposition header set to attachment type, so that, if the request is made via a browser, it helps the user to download the file under a specific name. This might not be useful, however, when the file is being requested from an API client that's not a browser.

URL
https://api.brandindex.com/v0/taxonomy/sectors-with-brands.csv to get the file as CSV
https://api.brandindex.com/v0/taxonomy/sectors-with-brands.json to get the file as JSON
Required parameters
region - the region for which the sectors should be listed.
HTTP methods
GET
HTTP statuses
200 - request successful
400 - if required parameters are missing.
404 - if the region was not found.
Response body example

For a CSV file, just download this example file and look at the format.

For a JSON file, just download this example file and look at the format.

For the JSON file, the first level of items is for the sectors, and the second level is for the brands.

Brand data

This endpoint responds with a payload that describes a specific brand.

URL
https://api.brandindex.com/v0/taxonomy/brand.json
Required parameters
region - the region for which the sectors should be listed.
sector - the sector ID that the brand is tied to.
brand - the brand ID that the brand is tied to.
HTTP methods
GET
HTTP statuses
200 - request successful
400 - if required parameters are missing.
404 - if the brand was not found.
Response body example

{
  "data":{
    "brand_id": 1234,
    "region": "uk",
    "name": "Foo brand",
    "sector_id": 123,
    "validity_periods": [
      ["2011-01-01", "2012-01-01"],
      ["2013-01-01", null]
    ]
  },
  "ok":true
}

The data element has basic fields related to the brand, like its name, its identifier etc, but it also has a list of validity periods. These validity periods describe when a brand is valid, and each item from the outer list is a validity period, while, in the inner list, the first item is the start of the period and the second item is the end of the period. If the second item is null, the brand will be valid indefinitely.