Activities
Last updated
Last updated
According to the OpenActive website:
The OpenActive Activity List is a standardised list of physical activities widely practiced in the UK. Its intent is to improve the accuracy and findability of physical activities by providing standardised labels and identifiers for all the activities it contains.
These physical activities are instances of Concept and form a hierarchy of activities. The Activity List is made up of a list of hierarchical Concepts, with 134 topConceptOf and hundreds more lower-level Concepts.
At imin, we refer to topConceptOf as parent activities and lower-level concepts as children. The purpose of the these Concepts is to easily facilitate a seamless UX for end users when searching for activities.
An example of a Concept hierarchy is Funky HAU2, which is a child of Dance Aerobics, which is a child of Dance Fitness, which is a child of Group Exercise, which itself is one of the 134 topConceptOfs .and, therefore, the parent Concept.
We refer to each activity, regardless of hierarchy, listed in the Activity List as a canonical activity. An activity that is not included in the List is referred to as a non-canonical activity.
Activities can be found at the /events-api/v2/facets endpoint with JSONPath: $['imin:index'].activity['imin:item'] (see API Reference for more detail). The aforementioned hierarchy is represented by the broaderTransitive property in the activity object (as seen below) and references the id of its parent activities from the Activity List. This allows for the list of activities in the Facets endpoint to be polyhierarchical.
We recommend you heavily cache the results of this endpoint, as it is likely to change very infrequently (at most nightly).
Sometimes, open data providers do not work from the OpenActive Activity List and so the data in their RPDE feeds may include non-canonical activities.
As part of our service, any open data that includes non-canonical activities are matched by our Platform to the relevant concept in the Activity List. By doing so, we are able to ensure that as much open data as possible is high quality and searchable.
Our APIs do not return any items that have non-canonical activities, i.e. those not listed in the Activity List.
Sometimes the open data we consume will not contain activity data at all. Whilst we do our best to ensure a minimum standard of data in our platform, we cannot always guarantee an activity array will be present for each item in the API.
Each activity array in the imin Platform can have more than one object. These will generally be a hierarchically related. For example:
NB the parent activity will not always be present in the activity array.
We do our very best to ensure that all activity information accurately reflects the session with which it is associated. However, given the nature of open data, we cannot guarantee this will always be the case. If you notice any data that you think is inaccurate, please let us know.
For information on filtering by Activity, please see here.