Filters

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"]
  }
]

Team (contributors)

Identifier: Group

Filter the query by team (previously known as "group" in Winningtemp). Use the teams API to get available values (team ids):
https://developer.winningtemp.com/reference/get_teams-v1

This includes responses for all contributors to the team - i.e. responses from direct members in the selected team, as well as members in all sub-teams, at any depth.

Team (direct members only)

Identifier: GroupExplicit

Filter the query by team (previously known as "group" in Winningtemp). Use the teams API to get available values (team ids):
https://developer.winningtemp.com/reference/get_teams-v1

Unlike the Group filter, this will only include responses from direct members of the selected team - not any sub-team members.

Segment

Identifier: Segment

Filter the query by segment. Use the segment API to get available values (segment ids):
https://developer.winningtemp.com/reference/get_segments-v1

Category

Identifier: Category

Filter the query by question category. Use the survey API to get available values (category ids):
https://developer.winningtemp.com/reference/get_survey-v1-categories

Team type

Identifier: TeamType

Filter the query by team type using the pre-defined values:

• Core
• Flex

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.

Survey frequency

Identifier: SurveyFrequency

Filter the query by the survey frequency (in days). Useful when querying for a date range and there is a need to separate pulse and periodic survey results. Values and their meaning:

• High - retain only answers to "high frequency" (pulse) surveys. All results from periodic surveys will be excluded in the result.
• Low - retain only answers to "low frequency" (periodic) surveys. All results from pulse surveys will be excluded in the result.