📄️ Conceptual Overview
The basic kinds of resources provided by the API are Devices, Activities, and Time frames. The Users resource must also be considered in order to understand how to set up and control access to the resources.
📄️ Initial setup
First, you need to create a Manager user. Then in order to access data from a Device, you need to take ownership of the device.
📄️ Requesting sensor data and metrics
Analytics are computed from Device data based on the Athlete's profile and parameters from the Activity for a given Time frame. Results can be Live streamed or requested offline.
📄️ User roles
There are 2 types of user roles:
📄️ OAuth 2.0
For applications to access data on behalf of the user, each request must be authorized based on an access token, which is obtained after successfully authenticating the user in question.
📄️ Data Access Control
Accessing Preprocessed Data
📄️ Example
In this scenario, a manager called A uses the platform to create an activity and two time frames prior to a tennis match, where athletes B and C play against each other.
📄️ Activity Webhooks
Changes to activities and timeframes can be subscribed to using activity webhooks. This allows for example to keep activities and timeframes in sync when they are shared across multiple apps, which otherwise wouldn't know when a change has been submitted by another app.
📄️ Request Rate Limits
The API is protected by a rate-limiting system to prevent abuse. When too many requests are made to the API by a client, the server will respond with an HTTP 429 status code. The Retry-After header in the response should be used by clients to know how long to wait before attempting any new request.