Retrieving Categories

Listing the Categories within your Project.

Categories are stored within Projects.

If you are building an application, we recommend caching the Categories that are applied to your project locally, so that you do not have to retrieve them every time that you do a Mentions data call.

You can access them with the associated Project ID:

curl -X GET https://api.brandwatch.com/projects/398748937/categories

The response will look like this:

{
  "resultsTotal": -1,
  "resultsPage": -1,
  "resultsPageSize": -1,
  "results": [
    {
      "id": 39873297,
      "name": "Customer Issues",
      "multiple": false,
      "children": [
        {
          "id": 19298737,
          "name": "Shipping",
          "ordering": 0
        },
        {
          "id": 9083947,
          "name": "Sizing",
          "ordering": 0
        },
        {
          "id": 9328497,
          "name": "Product faults",
          "ordering": 0
        },
        {
          "id": 39483984,
          "name": "Environmental",
          "ordering": 0
        }
      ]
    }
  ]
}

Here, the "Customer Issues" Category with ID 39873297 has four Subcategories, as identified in the children array.

You can then use these Category and Subcategory IDs when filtering or breaking down Mention calls. Elsewhere in the documentation you may see the top-level Categories being referred to as "Parent Categories".

Retrieving Categories

Listing the Categories within your Project.