Skip to main content

Computed REST Endpoints (deprecated)

API docs by Redocly

Insiders API

Download OpenAPI specification:Download

Athletes

This feature, related to computed data, has been deprecated.

V1 - Lists athlete users Deprecated

This operation is restricted to manager users. It lists athletes on whom they currently have READ permission.

Authorizations:
OAuth2Security
query Parameters
page
integer

Page number

limit
integer

Number of results per page (max is 3000)

ordering
string
Enum: "username" "email" "external_id" "first_name" "last_name" "gender" "birthdate" "managed_by"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • External ID
  • Username
  • Email
  • Last name
  • First name
email
string

Filter on email (insensitive contains)

username
string

Filter on username (insensitive contains)

external_id
string

Filter on external_id (insensitive contains)

first_name
string

Filter on first_name (insensitive contains)

last_name
string

Filter on last_name (insensitive contains)

gender
string

Filter on gender (M or F) (insensitive exact)

managed_by
number

Filter by managed_by (id of manager)

is_managed
boolean

Filter managed or non managed athletes (valid options are true or false)

birthdate_from
string <date>
Example: birthdate_from=1996-01-01

Filter on birthdate (greater than or equal)

birthdate_to
string <date>
Example: birthdate_to=1998-12-31

Filter on birthdate (lesser than or equal)

Responses

Response samples

Content type
application/json
{
  • "count": 150,
  • "page": 2,
  • "next": 3,
  • "previous": 1,
  • "results": [
    ]
}

V1 - Creates an athlete user Deprecated

This operation create an athlete account and an email is sent to the user's email address, with the account credentials.

This operation is not restricted. Anyone can use this endpoint to register as an athlete.

Authorizations:
OAuth2Security
Request Body schema: application/json
username
required
string

User's name used to authenticate himself/herself

external_id
string

User's external ID used from another organisation

email
required
string <email>

User's contact email address

object (AthleteProfile)

Responses

Request samples

Content type
application/json
{
  • "username": "jon.doe@example.com",
  • "external_id": "0123456789",
  • "email": "jon.doe@example.com",
  • "athlete_profile": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "username": "jon.doe@example.com",
  • "external_id": "0123456789",
  • "email": "jon.doe@example.com",
  • "managed_by": 1,
  • "athlete_profile": {
    }
}

V1 - Creates a managed athlete user Deprecated

This operation create an athlete account managed by a manager.

Username will be a random UUID prefixed by MANAGED- and email will be empty.

This operation target to simplify athlete account creation and permission request processes. Athletes do not need to create their own accounts and accept permissions request. Athlete account created like this are not meant to be logged in to.

This operation is restricted to manager users. The manager must have a specific permission to manage managed athletes, which is given by the Insiders support team if requested.

Authorizations:
OAuth2Security
Request Body schema: application/json
external_id
string

User's external ID used from another organisation

managed_by
required
integer

Reference the manager who manage this athlete account. Only managers can create athlete with this field, and the must put their own id. A set of read, write and share permissions are created for this manager at athlete creation, from 1970-01-01 to 2199-12-31

object (AthleteProfile)

Responses

Request samples

Content type
application/json
{
  • "external_id": "0123456789",
  • "managed_by": 1,
  • "athlete_profile": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "username": "jon.doe@example.com",
  • "external_id": "0123456789",
  • "managed_by": 1,
  • "athlete_profile": {
    }
}

V1 - Retrieves an athlete by its external id Deprecated

This operation is restricted to manager users who currently have READ permission on this athlete and the athlete himself.

Authorizations:
OAuth2Security
query Parameters
external-id
required
string

External ID

Responses

Response samples

Content type
application/json
{
  • "id": 12,
  • "username": "jon.doe@example.com",
  • "external_id": "0123456789",
  • "email": "jon.doe@example.com",
  • "managed_by": 1,
  • "athlete_profile": {
    }
}

V1 - Find athlete by username Deprecated

Find an athlete id given its username.

This operation is restricted to manager users.

Authorizations:
OAuth2Security
query Parameters
email
required
string

Email

Responses

Response samples

Content type
application/json
{
  • "id": 12
}

V1 - Find athletes by email Deprecated

Find athletes id given an email. This operation is restricted to manager users.

Authorizations:
OAuth2Security
query Parameters
email
required
string

Email

Responses

Response samples

Content type
application/json
[
  • {
    }
]

V1 - Retrieves an athlete Deprecated

This operation is restricted to manager users who currently have READ permission on this athlete and the athlete himself.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

query Parameters
ordering
string
Enum: "username" "email" "external_id" "first_name" "last_name" "gender" "birthdate" "managed_by"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • External ID
  • Username
  • Email
  • Last name
  • First name
email
string

Filter on email (insensitive contains)

username
string

Filter on username (insensitive contains)

external_id
string

Filter on external_id (insensitive contains)

first_name
string

Filter on first_name (insensitive contains)

last_name
string

Filter on last_name (insensitive contains)

gender
string

Filter on gender (M or F) (insensitive exact)

managed_by
number

Filter by managed_by (id of manager)

is_managed
boolean

Filter managed or non managed athletes (valid options are true or false)

birthdate_from
string <date>
Example: birthdate_from=1996-01-01

Filter on birthdate (greater than or equal)

birthdate_to
string <date>
Example: birthdate_to=1998-12-31

Filter on birthdate (lesser than or equal)

Responses

Response samples

Content type
application/json
{
  • "id": 12,
  • "username": "jon.doe@example.com",
  • "external_id": "0123456789",
  • "email": "jon.doe@example.com",
  • "managed_by": 1,
  • "athlete_profile": {
    }
}

V1 - Updates an athlete Deprecated

This operation is restricted to the athlete himself.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

query Parameters
ordering
string
Enum: "username" "email" "external_id" "first_name" "last_name" "gender" "birthdate" "managed_by"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • External ID
  • Username
  • Email
  • Last name
  • First name
email
string

Filter on email (insensitive contains)

username
string

Filter on username (insensitive contains)

external_id
string

Filter on external_id (insensitive contains)

first_name
string

Filter on first_name (insensitive contains)

last_name
string

Filter on last_name (insensitive contains)

gender
string

Filter on gender (M or F) (insensitive exact)

managed_by
number

Filter by managed_by (id of manager)

is_managed
boolean

Filter managed or non managed athletes (valid options are true or false)

birthdate_from
string <date>
Example: birthdate_from=1996-01-01

Filter on birthdate (greater than or equal)

birthdate_to
string <date>
Example: birthdate_to=1998-12-31

Filter on birthdate (lesser than or equal)

Request Body schema: application/json
username
required
string

User's name used to authenticate himself/herself

external_id
string

User's external ID used from another organisation

email
required
string <email>

User's contact email address

object (AthleteProfile)

Responses

Request samples

Content type
application/json
{
  • "username": "jon.doe@example.com",
  • "external_id": "0123456789",
  • "email": "jon.doe@example.com",
  • "athlete_profile": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "username": "jon.doe@example.com",
  • "external_id": "0123456789",
  • "email": "jon.doe@example.com",
  • "managed_by": 1,
  • "athlete_profile": {
    }
}

V1 - Deletes an athlete Deprecated

This operation is restricted to the athlete himself.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

query Parameters
ordering
string
Enum: "username" "email" "external_id" "first_name" "last_name" "gender" "birthdate" "managed_by"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • External ID
  • Username
  • Email
  • Last name
  • First name
email
string

Filter on email (insensitive contains)

username
string

Filter on username (insensitive contains)

external_id
string

Filter on external_id (insensitive contains)

first_name
string

Filter on first_name (insensitive contains)

last_name
string

Filter on last_name (insensitive contains)

gender
string

Filter on gender (M or F) (insensitive exact)

managed_by
number

Filter by managed_by (id of manager)

is_managed
boolean

Filter managed or non managed athletes (valid options are true or false)

birthdate_from
string <date>
Example: birthdate_from=1996-01-01

Filter on birthdate (greater than or equal)

birthdate_to
string <date>
Example: birthdate_to=1998-12-31

Filter on birthdate (lesser than or equal)

Responses

Response samples

Content type
application/json
{
  • "detail": "You do not have permission to perform this action."
}

V1 - Updates a managed athlete Deprecated

This operation is restricted to the manager user who manage this athlete.

The manager must have a specific permission to manage managed athletes, which is given by the Insiders support team if requested.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

Request Body schema: application/json
external_id
string

User's external ID used from another organisation

managed_by
required
integer

Reference the manager who manage this athlete account. Only managers can create athlete with this field, and the must put their own id. A set of read, write and share permissions are created for this manager at athlete creation, from 1970-01-01 to 2199-12-31

object (AthleteProfile)

Responses

Request samples

Content type
application/json
{
  • "external_id": "0123456789",
  • "managed_by": 1,
  • "athlete_profile": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "username": "jon.doe@example.com",
  • "external_id": "0123456789",
  • "email": "jon.doe@example.com",
  • "managed_by": 1,
  • "athlete_profile": {
    }
}

V1 - Deletes a managed athlete Deprecated

This operation is restricted to the manager of this athlete.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

Responses

Response samples

Content type
application/json
{
  • "detail": "You do not have permission to perform this action."
}

V1 - Changes the user's password Deprecated

This operation is restricted to the athlete himself.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

Request Body schema: application/json
password
string <password>

User's plain password

Responses

Request samples

Content type
application/json
{
  • "password": "SuperPassword$$123"
}

Response samples

Content type
application/json
{
  • "detail": "Not found"
}

ManagerPermissions

This feature, related to computed data, has been deprecated.

V1 - Lists all the permissions regarding to an athlete Deprecated

This operation is restricted to the athlete himself.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

Responses

Response samples

Content type
application/json
{
  • "count": 150,
  • "page": 2,
  • "next": 3,
  • "previous": 1,
  • "results": [
    ]
}

V1 - Lists a manager's permissions regarding to an athlete Deprecated

This operation is restricted to the athlete himself.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

manager
required
integer

Manager ID

Responses

Response samples

Content type
application/json
{
  • "count": 150,
  • "page": 2,
  • "next": 3,
  • "previous": 1,
  • "results": [
    ]
}

V1 - Creates permissions to a manager Deprecated

This operation is restricted to the athlete himself.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

manager
required
integer

Manager ID

Request Body schema: application/json
start_time
string <date-time>
expiration_time
string <date-time>
permission
string
Enum: "READ" "WRITE" "SHARE"

Responses

Request samples

Content type
application/json
{
  • "start_time": "2020-02-20T13:18:29+0100",
  • "expiration_time": "2022-02-20T13:18:29+0100",
  • "permission": "READ"
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "manager": 1,
  • "athlete": 2,
  • "start_time": "2020-02-20T13:18:29+0100",
  • "expiration_time": "2022-02-20T13:18:29+0100",
  • "permission": "READ",
  • "is_active": true
}

V1 - Revokes all permissions to a manager Deprecated

This operation is restricted to the athlete himself.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

manager
required
integer

Manager ID

Responses

Response samples

Content type
application/json
{
  • "detail": "You do not have permission to perform this action."
}

V1 - Revokes a specific permission to a manager Deprecated

This operation is restricted to the athlete himself.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

manager
required
integer

Manager ID

permission
required
integer

Permission ID

Responses

Response samples

Content type
application/json
{
  • "detail": "You do not have permission to perform this action."
}

V1 - Shares a read permission to another manager Deprecated

The authenticated manager needs to have a SHARE permission on the athlete.

This action gives read access to the specified manager on the athlete.

To get WRITE access, the athletes needs to grant this permission to the manager.

This operation is restricted to manager users.

Authorizations:
OAuth2Security
path Parameters
athlete
required
integer

Athlete ID

Request Body schema: application/json
manager
integer
start_time
string <date-time>
expiration_time
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "manager": 10,
  • "start_time": "2020-02-20T13:18:29+0100",
  • "expiration_time": "2022-02-20T13:18:29+0100"
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "manager": 1,
  • "athlete": 2,
  • "start_time": "2020-02-20T13:18:29+0100",
  • "expiration_time": "2022-02-20T13:18:29+0100",
  • "permission": "READ",
  • "is_active": true
}

JsonSchemas

This feature, related to computed data, has been deprecated.

V1 - Lists JSON schemas Deprecated

This operation is restricted to manager users.

Authorizations:
OAuth2Security
query Parameters
page
integer

Page number

limit
integer

Number of results per page (max is 3000)

ordering
string
Enum: "name" "type" "parent"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • Name
type
integer

Filter on type (exact match)

parent
integer

Filter on parent schema id (exact match)

Responses

Response samples

Content type
application/json
{
  • "count": 150,
  • "page": 2,
  • "next": 3,
  • "previous": 1,
  • "results": [
    ]
}

V1 - Retrieves a JSON schema Deprecated

This operation is restricted to manager users.

Authorizations:
OAuth2Security
path Parameters
json_schema
required
integer

JSON schema ID

query Parameters
ordering
string
Enum: "name" "type" "parent"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • Name
type
integer

Filter on type (exact match)

parent
integer

Filter on parent schema id (exact match)

Responses

Response samples

Content type
application/json
{
  • "id": 12,
  • "name": "timeframe_soccer",
  • "type": "TIMEFRAME",
  • "parent": 1,
  • "schema": { }
}

Activities

This feature, related to computed data, has been deprecated.

V1 - Lists activities Deprecated

This operation is restricted to manager users. It lists activities he created.

Authorizations:
OAuth2Security
query Parameters
page
integer

Page number

limit
integer

Number of results per page (max is 3000)

ordering
string
Value: "name"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • Name
name
string

Filter on name (insensitive contains)

owner
number

Filter by owner (id of manager)

Responses

Response samples

Content type
application/json
{
  • "count": 150,
  • "page": 2,
  • "next": 3,
  • "previous": 1,
  • "results": [
    ]
}

V1 - Creates an activity Deprecated

This operation is restricted to manager users.

Authorizations:
OAuth2Security
Request Body schema: application/json
name
required
string

Descriptive title

required
activity_biking (object) or activity_running (object) or activity_soccer (object) or activity_swimming (object) or activity_trailrunning (object) or activity_triathlon (object)

Sport-specific parameters based on json_schema

json_schema
required
integer

ID of the JSON schema describing the activity parameters

owner
required
integer

ID of the Manager user who owns the activity

Responses

Request samples

Content type
application/json
{
  • "name": "World Cup Final 2024 at Stade de la Tuilière",
  • "json": {
    },
  • "json_schema": 1,
  • "owner": 1
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "name": "World Cup Final 2024 at Stade de la Tuilière",
  • "json": {
    },
  • "json_schema": 1,
  • "owner": 1
}

V1 - Retrieves an activity Deprecated

This operation is restricted to the manager user who own this activity.

Authorizations:
OAuth2Security
path Parameters
activity
required
integer

Activity ID

query Parameters
ordering
string
Value: "name"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • Name
name
string

Filter on name (insensitive contains)

owner
number

Filter by owner (id of manager)

Responses

Response samples

Content type
application/json
{
  • "id": 12,
  • "name": "World Cup Final 2024 at Stade de la Tuilière",
  • "json": {
    },
  • "json_schema": 1,
  • "owner": 1
}

V1 - Updates an activity Deprecated

Update an activity and trigger a new computation of all its time frame's computed data, asynchronously.

This operation is restricted to the manager user who own this activity.

Authorizations:
OAuth2Security
path Parameters
activity
required
integer

Activity ID

query Parameters
ordering
string
Value: "name"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • Name
name
string

Filter on name (insensitive contains)

owner
number

Filter by owner (id of manager)

Request Body schema: application/json
name
required
string

Descriptive title

required
activity_biking (object) or activity_running (object) or activity_soccer (object) or activity_swimming (object) or activity_trailrunning (object) or activity_triathlon (object)

Sport-specific parameters based on json_schema

json_schema
required
integer

ID of the JSON schema describing the activity parameters

owner
required
integer

ID of the Manager user who owns the activity

Responses

Request samples

Content type
application/json
{
  • "name": "World Cup Final 2024 at Stade de la Tuilière",
  • "json": {
    },
  • "json_schema": 1,
  • "owner": 1
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "name": "World Cup Final 2024 at Stade de la Tuilière",
  • "json": {
    },
  • "json_schema": 1,
  • "owner": 1
}

V1 - Deletes an activity Deprecated

This operation is restricted to the manager user who own this activity.

Authorizations:
OAuth2Security
path Parameters
activity
required
integer

Activity ID

query Parameters
ordering
string
Value: "name"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

search
string

Multiple fields text search (case-insensitive partial matches).

  • Name
name
string

Filter on name (insensitive contains)

owner
number

Filter by owner (id of manager)

Responses

Response samples

Content type
application/json
{
  • "detail": "You do not have permission to perform this action."
}

V1 - List activity's webhooks Deprecated

This operation is restricted to the manager user who own this activity.

Authorizations:
OAuth2Security
path Parameters
activity
required
integer

Activity ID

Responses

Response samples

Content type
application/json
{}

V1 - Create an activity's webhook Deprecated

Register a new webhook.

This operation is restricted to the manager user who own this activity.

Authorizations:
OAuth2Security
path Parameters
activity
required
integer

Activity ID

Request Body schema: application/json
webhook_url
required
string <url> <= 200 characters

The callback URL

secret_token
required
string <= 100 characters

The value to be added in the X-Asi-Api-Token header while requesting the callback url.

When listing or retrieving webhooks from the API, this value is partially hidden (for example 123*************).

activity_events
required
boolean

Whether to call this webhook on activity events for this activity: activity-updated or activity-destroyed

timeframes_events
required
boolean

Whether to call this webhook on timeframes events for timeframes related to this activity: timeframe-created, timeframe-updated or timeframe-destroyed

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

V1 - Retrieves an activity's webhook Deprecated

This operation is restricted to the manager user who own this activity.

Authorizations:
OAuth2Security
path Parameters
activity
required
integer

Activity ID

webhook
required
integer

Activity's webhook ID

Responses

Response samples

Content type
application/json
{}

V1 - Updates an activity's webhook Deprecated

This operation is restricted to the manager user who own this activity.

Authorizations:
OAuth2Security
path Parameters
activity
required
integer

Activity ID

webhook
required
integer

Activity's webhook ID

Request Body schema: application/json
webhook_url
required
string <url> <= 200 characters

The callback URL

secret_token
required
string <= 100 characters

The value to be added in the X-Asi-Api-Token header while requesting the callback url.

When listing or retrieving webhooks from the API, this value is partially hidden (for example 123*************).

activity_events
required
boolean

Whether to call this webhook on activity events for this activity: activity-updated or activity-destroyed

timeframes_events
required
boolean

Whether to call this webhook on timeframes events for timeframes related to this activity: timeframe-created, timeframe-updated or timeframe-destroyed

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

V1 - Deletes an activity's webhook Deprecated

This operation is restricted to the manager user who own this activity.

Authorizations:
OAuth2Security
path Parameters
activity
required
integer

Activity ID

webhook
required
integer

Activity's webhook ID

Responses

Response samples

Content type
application/json
{
  • "detail": "You do not have permission to perform this action."
}

TimeFrames

This feature, related to computed data, has been deprecated.

V1 - Lists time frames Deprecated

This operation is restricted to the manager users. It lists time frames he created. Optionally filtered by activity to which it's related.

Authorizations:
OAuth2Security
query Parameters
page
integer

Page number

limit
integer

Number of results per page (max is 3000)

ordering
string
Enum: "start_time" "end_time" "device" "athlete" "activity"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

device
number

Filter by device (id)

athlete
number

Filter by athlete (id)

owner
number

Filter by owner (id of manager)

activity
number

Filter by activity (id)

start_time_from
string <date-time>
Example: start_time_from=2020-02-20T13:00:00+0100

Filter on start_time (greater than or equal)

start_time_to
string <date-time>
Example: start_time_to=2020-02-20T18:00:00+0100

Filter on start_time (lesser than or equal)

end_time_from
string <date-time>
Example: end_time_from=2020-02-20T13:00:00+0100

Filter on end_time (greater than or equal)

end_time_to
string <date-time>
Example: end_time_to=2020-02-20T18:00:00+0100

Filter on end_time (lesser than or equal)

with_device
boolean

If true, include nested representation of the device in the response instead of its id

with_activity
boolean

If true, include nested representation of the activity in the response instead of its id

with_athlete
boolean

If true, include nested representation of the athlete in the response instead of its id

Responses

Response samples

Content type
application/json
{
  • "count": 150,
  • "page": 2,
  • "next": 3,
  • "previous": 1,
  • "results": [
    ]
}

V1 - Create a time frame Deprecated

This operation is restricted to manager users.

Authorizations:
OAuth2Security
Request Body schema: application/json
start_time
string <date-time>

Start of the time interval considered for computing the metrics. Must >= now for live streaming.

end_time
string <date-time>

End of the time interval considered for computing the metrics. Must be >= now for live streaming.

timeframe_biking (object) or timeframe_running (object) or timeframe_soccer (object) or timeframe_swimming (object) or timeframe_trailrunning (object) or timeframe_triathlon (object) (TimeFrameParams)

Parameters for the metrics algorithms based on json_schema

device
integer

ID of the device

activity
integer

ID of the activity

athlete
integer

ID of the Athlete user wearing the device

owner
integer

ID the the Manager user owning access to the Timeframe

json_schema
integer

ID of the JSON schema describing the parameters of the metrics algorithms

Responses

Request samples

Content type
application/json
{
  • "start_time": "2022-02-20T13:18:29+0100",
  • "end_time": "2022-02-20T14:18:29+0100",
  • "params": {
    },
  • "device": 123,
  • "activity": 321,
  • "athlete": 42,
  • "owner": 1,
  • "json_schema": 2
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "start_time": "2022-02-20T13:18:29+0100",
  • "end_time": "2022-02-20T14:18:29+0100",
  • "params": {
    },
  • "device": 123,
  • "activity": 321,
  • "athlete": 42,
  • "owner": 1,
  • "json_schema": 2
}

V1 - Retrieves a time frame Deprecated

This operation is restricted to the manager user who own this time frame.

Authorizations:
OAuth2Security
path Parameters
timeFrame
required
integer

Time frame ID

query Parameters
ordering
string
Enum: "start_time" "end_time" "device" "athlete" "activity"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

device
number

Filter by device (id)

athlete
number

Filter by athlete (id)

owner
number

Filter by owner (id of manager)

activity
number

Filter by activity (id)

start_time_from
string <date-time>
Example: start_time_from=2020-02-20T13:00:00+0100

Filter on start_time (greater than or equal)

start_time_to
string <date-time>
Example: start_time_to=2020-02-20T18:00:00+0100

Filter on start_time (lesser than or equal)

end_time_from
string <date-time>
Example: end_time_from=2020-02-20T13:00:00+0100

Filter on end_time (greater than or equal)

end_time_to
string <date-time>
Example: end_time_to=2020-02-20T18:00:00+0100

Filter on end_time (lesser than or equal)

with_device
boolean

If true, include nested representation of the device in the response instead of its id

with_activity
boolean

If true, include nested representation of the activity in the response instead of its id

with_athlete
boolean

If true, include nested representation of the athlete in the response instead of its id

Responses

Response samples

Content type
application/json
{
  • "id": 12,
  • "start_time": "2022-02-20T13:18:29+0100",
  • "end_time": "2022-02-20T14:18:29+0100",
  • "params": {
    },
  • "device": 123,
  • "activity": 321,
  • "athlete": 42,
  • "owner": 1,
  • "json_schema": 2
}

V1 - Updates a time frame Deprecated

Update a time frame and trigger a new computation of its computed data, asynchronously. This operation is restricted to the manager user who own this time frame.

Authorizations:
OAuth2Security
path Parameters
timeFrame
required
integer

Time frame ID

query Parameters
ordering
string
Enum: "start_time" "end_time" "device" "athlete" "activity"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

device
number

Filter by device (id)

athlete
number

Filter by athlete (id)

owner
number

Filter by owner (id of manager)

activity
number

Filter by activity (id)

start_time_from
string <date-time>
Example: start_time_from=2020-02-20T13:00:00+0100

Filter on start_time (greater than or equal)

start_time_to
string <date-time>
Example: start_time_to=2020-02-20T18:00:00+0100

Filter on start_time (lesser than or equal)

end_time_from
string <date-time>
Example: end_time_from=2020-02-20T13:00:00+0100

Filter on end_time (greater than or equal)

end_time_to
string <date-time>
Example: end_time_to=2020-02-20T18:00:00+0100

Filter on end_time (lesser than or equal)

with_device
boolean

If true, include nested representation of the device in the response instead of its id

with_activity
boolean

If true, include nested representation of the activity in the response instead of its id

with_athlete
boolean

If true, include nested representation of the athlete in the response instead of its id

Request Body schema: application/json
start_time
string <date-time>

Start of the time interval considered for computing the metrics. Must >= now for live streaming.

end_time
string <date-time>

End of the time interval considered for computing the metrics. Must be >= now for live streaming.

timeframe_biking (object) or timeframe_running (object) or timeframe_soccer (object) or timeframe_swimming (object) or timeframe_trailrunning (object) or timeframe_triathlon (object) (TimeFrameParams)

Parameters for the metrics algorithms based on json_schema

device
integer

ID of the device

activity
integer

ID of the activity

athlete
integer

ID of the Athlete user wearing the device

owner
integer

ID the the Manager user owning access to the Timeframe

json_schema
integer

ID of the JSON schema describing the parameters of the metrics algorithms

Responses

Request samples

Content type
application/json
{
  • "start_time": "2022-02-20T13:18:29+0100",
  • "end_time": "2022-02-20T14:18:29+0100",
  • "params": {
    },
  • "device": 123,
  • "activity": 321,
  • "athlete": 42,
  • "owner": 1,
  • "json_schema": 2
}

Response samples

Content type
application/json
{
  • "id": 12,
  • "start_time": "2022-02-20T13:18:29+0100",
  • "end_time": "2022-02-20T14:18:29+0100",
  • "params": {
    },
  • "device": 123,
  • "activity": 321,
  • "athlete": 42,
  • "owner": 1,
  • "json_schema": 2
}

V1 - Updates a time frame (partially) Deprecated

Works the same as PUT, but support partial payload, specifying only the fields to update.

Authorizations:
OAuth2Security
path Parameters
timeFrame
required
integer

Time frame ID

query Parameters
ordering
string
Enum: "start_time" "end_time" "device" "athlete" "activity"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

device
number

Filter by device (id)

athlete
number

Filter by athlete (id)

owner
number

Filter by owner (id of manager)

activity
number

Filter by activity (id)

start_time_from
string <date-time>
Example: start_time_from=2020-02-20T13:00:00+0100

Filter on start_time (greater than or equal)

start_time_to
string <date-time>
Example: start_time_to=2020-02-20T18:00:00+0100

Filter on start_time (lesser than or equal)

end_time_from
string <date-time>
Example: end_time_from=2020-02-20T13:00:00+0100

Filter on end_time (greater than or equal)

end_time_to
string <date-time>
Example: end_time_to=2020-02-20T18:00:00+0100

Filter on end_time (lesser than or equal)

with_device
boolean

If true, include nested representation of the device in the response instead of its id

with_activity
boolean

If true, include nested representation of the activity in the response instead of its id

with_athlete
boolean

If true, include nested representation of the athlete in the response instead of its id

Responses

Response samples

Content type
application/json
{
  • "id": 12,
  • "start_time": "2022-02-20T13:18:29+0100",
  • "end_time": "2022-02-20T14:18:29+0100",
  • "params": {
    },
  • "device": 123,
  • "activity": 321,
  • "athlete": 42,
  • "owner": 1,
  • "json_schema": 2
}

V1 - Deletes a time frame Deprecated

This operation is restricted to the manager user who own this time frame.

Authorizations:
OAuth2Security
path Parameters
timeFrame
required
integer

Time frame ID

query Parameters
ordering
string
Enum: "start_time" "end_time" "device" "athlete" "activity"

Order the results by specified field, ascendant. Prefix the field with - to reverse order.

device
number

Filter by device (id)

athlete
number

Filter by athlete (id)

owner
number

Filter by owner (id of manager)

activity
number

Filter by activity (id)

start_time_from
string <date-time>
Example: start_time_from=2020-02-20T13:00:00+0100

Filter on start_time (greater than or equal)

start_time_to
string <date-time>
Example: start_time_to=2020-02-20T18:00:00+0100

Filter on start_time (lesser than or equal)

end_time_from
string <date-time>
Example: end_time_from=2020-02-20T13:00:00+0100

Filter on end_time (greater than or equal)

end_time_to
string <date-time>
Example: end_time_to=2020-02-20T18:00:00+0100

Filter on end_time (lesser than or equal)

with_device
boolean

If true, include nested representation of the device in the response instead of its id

with_activity
boolean

If true, include nested representation of the activity in the response instead of its id

with_athlete
boolean

If true, include nested representation of the athlete in the response instead of its id

Responses

Response samples

Content type
application/json
{
  • "detail": "You do not have permission to perform this action."
}

ComputedData

This feature has been deprecated.

V1 - Retrieves an activity's computed data Deprecated

The result is a list of all computed data of this activity's time frames.

This operation is restricted to manager users who have READ permission on the referenced athlete between start_time and end_time of this time frame.

Authorizations:
OAuth2Security
path Parameters
activity
required
integer

Activity ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

V1 - Retrieves a time frame's computed data Deprecated

This operation is restricted to manager users who have READ permission on the referenced athlete between start_time and end_time of this time frame.

Authorizations:
OAuth2Security
path Parameters
timeFrame
required
integer

Time frame ID

Responses

Response samples

Content type
application/json
Example
{
  • "first_timestamp": 1694432512600,
  • "last_timestamp": 1694432517600,
  • "last_computation": 1694432517600,
  • "total_distance": 4070.0806,
  • "max_speed": 5.8933,
  • "average_speed": 0.9882,
  • "accelerations": {
    },
  • "decelerations": {
    },
  • "sprint": {
    },
  • "hid": {
    },
  • "time_per_speed_ranges": [
    ],
  • "distance_per_speed_ranges": [
    ],
  • "intensity": {
    },
  • "hr_max": 0,
  • "hr_min": 0,
  • "hr_avg": 0,
  • "hr_plot": 0,
  • "athlete_max_hr": 0.9882,
  • "timePerHrZone": [
    ]
}