Sectors
What are sectors?
When doing a BAV study, some questions are asked that relate sectors to one or more categories. You can read more about the categories and what they represent on the categories endpoint.
Each category belongs to a sector, which is a broader classification of categories. The benefit of a sector is that it is easier to compare across countries and years.
List all sectors
To list all of the sectors and browse them via the API, use the list endpoint:
GET /api/v2/sectors
Get a sector
You may also directly retrieve a sector's details if you already have its system ID.
GET /api/v2/sectors/123
Where 123
is the system ID of the sector.
Schema
Full response schema
Key | Type | Filterable | Sortable | Configurable | Description |
---|---|---|---|---|---|
id | integer | ✅ (exact) | ✅ | ✅ | The system ID. |
is_active | boolean | ✅ | ✅ | ✅ | Whether the sector should be seen and used. |
name | string | ✅ | ✅ | ✅ | The name of the sector. |
excluded_for_most_influential | - | ✅ | ✅ | ✅ | Whether the sector should be part of the Most Influential brands lists or not. |
created_at | string | ❌ | ✅ | ✅ | A datetime string when this sector was first created. |
updated_at | string | (updated since) | ✅ | ✅ | A datetime string when this sector was last updated. |
Relationship Response Schema
The slim relationship schema is used when the sector is used as part of an include in another resource.
Key | Type | Description |
---|---|---|
id | integer | The system ID for the sector. |
name | string | The primary name of the sector. |
Additional Filters
For convenience, we have a set of additional filters that are not available in the default filters or are part of the columns. These are:
in_most_influential
- Set to1
to only return sectors that are part of the Most Influential lists.not_in_most_influential
- Set to1
to only return sectors that are not part of the Most Influential lists.
Relationships & includes
By default, relationships apart from the sector are not included. See the includes section for more information on how this works. The following relationships are available:
categories
- The categories that belong to this sector.
Searching
This endpoint supports searching. See the searching section for more details.