Your Search Results and HighFrequencySessions
Last updated
Last updated
The default behaviour of the Events API is to include iminTag[not]=HighFrequencySession
in every call. As a result of this, a general Events API search will return neither swimming nor gym workout sessions. This is due to the sheer volume of these types of sessions in our Platform.
If you are offering users the ability to search for Swimming and/or gym workout, and you are relying on the default behaviour of the Events API, i.e. your API calls include iminTag[not]=HighFrequencySession
, then the number of sessions returned will be vastly reduced.
For example, the following API call will return a very smaller number of items that have Swimming as the activityPrefLabel
:
This is because iminTag[not]=HighFrequencySession
is filtering out the large of swimming sessions contained in the Platform that would otherwise match the given parameters.
If you want to return all available swimming sessions, you will need to include iminTag=HighFrequencySession
, i.e. exclude the [not]
from the API call.
For example, the following API call will return tens of thousands of items that have Swimming as the activityPrefLabel
:
If you want to return swimming or gym workout sessions via the Events API, then you must include iminTag=HighFrequencySession
along with the relevant activityId
.
Conversely, if you include iminTag=HighFrequencySession
in an API call along with an activityId
that corresponds to something other than swimming or gym workout, e.g. football, then 0 items will be returned.
iminTag=HighFrequencySession
can only be used exclusively when searching for swimming and/or gym workout.