All queries can be filtered using any of the predefined filters. A query may use multiple filters and for each filter multiple values may be used. Filters are added to the filters property of the query and must have the filter property as the identifier and the values property as the values to filter for.
"filters": [
{
"filter": "identifier",
"values": ["value 1", "value 2", "value 3"]
}
]
Group
Identifier: Group
Filter the query by group. Use the teams(renamed from groups) api to get available values for Groups.
Segment
Identifier: Segment
Filter the query by segment. Use the segment api to get available values for Segments.
Category
Identifier: Category
Filter the query by question category. Use the survey api to get available values for Categories.
TeamType
Identifier: TeamType
Filter the query by team type using the pre-defined values:
- Core
- Flex
Note
We are renaming groups to teams in our product and both terms represent the same concept. As part of this transition, the term team is used in this filter, which is why the identifier is named TeamType rather than GroupType.
Age distribution
Identifier: AgeDistribution
Filter the query by age distribution using the pre-defined values:
- 0 - 17
- 18 - 24
- 25 - 34
- 35 - 44
- 45 - 54
- 55 - 70
- 71 - 99
Gender
Identifier: Gender
Filter the query by gender using the pre-defined values:
- None
- Female
- Male
- NonBinary
Employment interval
Identifier: EmploymentInterval
Filter the query by employment interval. Each interval is defined by three parts: start, end and factor.
Available values for the factor are:
- Week
- Month
- Quarter
- Year
An operand is used to define the start and end.
Between
Example: 0-6 Month
This will include all temperatures where the respondent has been employed between 0-6 months.
Greater than
Example: >1 Year
This will include all temperatures where the respondent has been employed for more than 1 year.
Less than
Example: <6 Week
This will include all temperatures where the respondent has been employed for less than 6 weeks.