Profile ¶

profile¶

GET /api/v1/profile/tags/¶

List Profile Tags

Input parameters

Parameter	In	Type	Default	Nullable	Description
`HTTPBearer`	header	string	N/A	No	JWT Bearer token
`refreshed-token`	header			No
`token`	cookie	string		No

Responses

200 OK422 Unprocessable Content

application/json

Schema of the response body

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /api/v1/profile/sports/¶

List Profile Sports

Input parameters

Parameter	In	Type	Default	Nullable	Description
`HTTPBearer`	header	string	N/A	No	JWT Bearer token
`only_root`	query	boolean	False	No
`refreshed-token`	header			No
`token`	cookie	string		No

Responses

200 OK422 Unprocessable Content

application/json

Schema of the response body

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /api/v1/profile/template-week¶

Get Profile Template Week

Description

Get a template week for the user based on their training history. The template week is a list of days, each with a name, a list of sports, and a typical and average training duration for that day.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`HTTPBearer`	header	string	N/A	No	JWT Bearer token
`refreshed-token`	header			No
`token`	cookie	string		No

Responses

200 OK422 Unprocessable Content

application/json

{
    "monday": {
        "sports": [
            "cycling"
        ],
        "avg_training_duration": "string",
        "typical_training_duration": "string"
    },
    "tuesday": null,
    "wednesday": null,
    "thursday": null,
    "friday": null,
    "saturday": null,
    "sunday": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "monday": {
            "$ref": "#/components/schemas/TemplateDay"
        },
        "tuesday": {
            "$ref": "#/components/schemas/TemplateDay"
        },
        "wednesday": {
            "$ref": "#/components/schemas/TemplateDay"
        },
        "thursday": {
            "$ref": "#/components/schemas/TemplateDay"
        },
        "friday": {
            "$ref": "#/components/schemas/TemplateDay"
        },
        "saturday": {
            "$ref": "#/components/schemas/TemplateDay"
        },
        "sunday": {
            "$ref": "#/components/schemas/TemplateDay"
        }
    },
    "type": "object",
    "required": [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday",
        "saturday",
        "sunday"
    ],
    "title": "TemplateWeekResponse"
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /api/v1/profile/intensity-duration-model¶

Get Intensity Duration Model

Description

Warning: This endpoint is in development and subject to change.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`HTTPBearer`	header	string	N/A	No	JWT Bearer token
`by`	query	string	intensity	No	The axis to index on. Only `intensity` is supported at this time.
`date`	query			No	The date to use for the model. Defaults to the current date and is inclusive for the passed date.
`index`	query			No	The index values to use for the model. Defaults to the full range of values for `duration`.
`metric`	query	string		No	The metric to use for the model. Only `power` and `speed` are supported at this time.
`refreshed-token`	header			No
`sport`	query			No
`token`	cookie	string		No

Responses

200 OK422 Unprocessable Content

application/json

Schema of the response body

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

PUT /api/v1/profile/app-metadata¶

Put Profile Metadata

Input parameters

Parameter	In	Type	Default	Nullable	Description
`HTTPBearer`	header	string	N/A	No	JWT Bearer token
`refreshed-token`	header			No
`token`	cookie	string		No

Request body

application/json

Schema of the request body

{
    "type": "object",
    "additionalProperties": true,
    "title": "Data"
}

Responses

200 OK422 Unprocessable Content

application/json

Schema of the response body

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /api/v1/profile/app-metadata¶

Delete Profile Metadata

Input parameters

Parameter	In	Type	Default	Nullable	Description
`HTTPBearer`	header	string	N/A	No	JWT Bearer token
`refreshed-token`	header			No
`token`	cookie	string		No

Responses

204 No Content422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas¶

HTTPValidationError¶

Name	Type	Description
`detail`	Array<ValidationError>

Sport¶

Type: string

TemplateDay¶

Name	Type	Description
`avg_training_duration`	string(duration)
`sports`	Array<Sport>
`typical_training_duration`	string(duration)

TemplateWeekResponse¶

Name	Type	Description
`friday`	TemplateDay
`monday`	TemplateDay
`saturday`	TemplateDay
`sunday`	TemplateDay
`thursday`	TemplateDay
`tuesday`	TemplateDay
`wednesday`	TemplateDay

ValidationError¶

Name	Type	Description
`loc`	Array<>
`msg`	string
`type`	string

Security schemes¶

Name	Type	Scheme	Description
HTTPBearer	http	bearer
HTTPBasic	http	basic