Skip to main content
Version: v1

Sectors

When doing a BAV study, some questions are asked that relate brands to one or more categories. These are categories that brands can belong to (one or multiple). These categories are combined to create broader sectors.

List Sectors

To list all of the sectors, use the list endpoint:

GET /api/v1/sectors

The sectors list response contains details about the brand.

Schema

KeyTypeDescription
idintegerThe system ID for the sector.
namestringThe name of the sector.

{
"data": [
{
"id": 20,
"name": "Apparel & Accessories"
}
//...
]
// ...
}

Get a Sector

You may also directly retrieve a sector's details if you already have its system ID.

GET /api/v1/sectors/123

Where 123 is the system ID of the sector.

Schema

KeyTypeDescription
idintegerThe system ID for the sector.
namestringThe name of the sector.

{
"data": {
"id": 20,
"name": "Apparel & Accessories"
}
}

Configurable Fields

If you only need some of the fields you can optimize the request for a leaner response ( see Configurable Fields for more information). The following fields can be toggled:

  • name

Expansions

To create a leaner response data related to sectors are not included in the response by default. See the Expansions section for more information on how this works. The following relationships can be expanded for the categories resource:

  • categories - A list of categories that belong to this sector.

Filters

The categories endpoint supports the following filters:

Sorting

The following fields are sortable:

  • id
  • name