Challenge Detail
MetricEntry
pydantic-model
¶
Bases: OtfItemBase
Definition of a metric used to track benchmark performance.
Show JSON schema:
{
"$defs": {
"EquipmentType": {
"description": "Enum representing the type of equipment used in workouts.",
"enum": [
2,
3,
4,
5,
6,
7
],
"title": "EquipmentType",
"type": "integer"
}
},
"description": "Definition of a metric used to track benchmark performance.",
"properties": {
"Title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Display title for the metric.",
"title": "Title"
},
"EquipmentId": {
"anyOf": [
{
"$ref": "#/$defs/EquipmentType"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of equipment for this metric."
},
"EntryType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of entry (e.g. time, distance).",
"title": "Entrytype"
},
"MetricKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Internal key for the metric.",
"title": "Metrickey"
},
"MinValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum valid value for this metric.",
"title": "Minvalue"
},
"MaxValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum valid value for this metric.",
"title": "Maxvalue"
}
},
"title": "MetricEntry",
"type": "object"
}
Fields:
-
title(str | None) -
equipment_id(EquipmentType | None) -
entry_type(str | None) -
metric_key(str | None) -
min_value(str | None) -
max_value(str | None)
BenchmarkHistory
pydantic-model
¶
Bases: OtfItemBase
A single benchmark result from a specific class.
Show JSON schema:
{
"$defs": {
"EquipmentType": {
"description": "Enum representing the type of equipment used in workouts.",
"enum": [
2,
3,
4,
5,
6,
7
],
"title": "EquipmentType",
"type": "integer"
}
},
"description": "A single benchmark result from a specific class.",
"properties": {
"StudioName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the studio where the benchmark was performed.",
"title": "Studioname"
},
"EquipmentId": {
"anyOf": [
{
"$ref": "#/$defs/EquipmentType"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of equipment used."
},
"ClassTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the class took place.",
"title": "Classtime"
},
"ChallengeSubCategoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Sub-category of the benchmark.",
"title": "Challengesubcategoryid"
},
"WeightLBS": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Member's weight in pounds at time of benchmark.",
"title": "Weightlbs"
},
"ClassName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the class.",
"title": "Classname"
},
"CoachName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the coach.",
"title": "Coachname"
},
"Result": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The benchmark result (time, distance, etc.).",
"title": "Result"
},
"WorkoutTypeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Workouttypeid"
},
"WorkoutId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Workoutid"
},
"LinkedChallenges": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Linkedchallenges"
},
"DateCreated": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the entry was created in database, not useful to users",
"title": "Datecreated"
},
"DateUpdated": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the entry was updated in database, not useful to users",
"title": "Dateupdated"
},
"ClassId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API",
"title": "Classid"
},
"SubstituteId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API, also always seems to be 0",
"title": "Substituteid"
}
},
"title": "BenchmarkHistory",
"type": "object"
}
Fields:
-
studio_name(str | None) -
equipment_id(EquipmentType | None) -
class_time(datetime | None) -
challenge_sub_category_id(int | None) -
weight_lbs(int | None) -
class_name(str | None) -
coach_name(str | None) -
result(float | str | None) -
workout_type_id(int | None) -
workout_id(int | None) -
linked_challenges(list[Any] | None) -
date_created(datetime | None) -
date_updated(datetime | None) -
class_id(int | None) -
substitute_id(int | None)
studio_name
pydantic-field
¶
studio_name = None
Name of the studio where the benchmark was performed.
challenge_sub_category_id
pydantic-field
¶
challenge_sub_category_id = None
Sub-category of the benchmark.
date_created
pydantic-field
¶
date_created = None
When the entry was created in database, not useful to users
date_updated
pydantic-field
¶
date_updated = None
When the entry was updated in database, not useful to users
ChallengeHistory
pydantic-model
¶
Bases: OtfItemBase
A challenge participation record with benchmark results.
Show JSON schema:
{
"$defs": {
"BenchmarkHistory": {
"description": "A single benchmark result from a specific class.",
"properties": {
"StudioName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the studio where the benchmark was performed.",
"title": "Studioname"
},
"EquipmentId": {
"anyOf": [
{
"$ref": "#/$defs/EquipmentType"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of equipment used."
},
"ClassTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the class took place.",
"title": "Classtime"
},
"ChallengeSubCategoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Sub-category of the benchmark.",
"title": "Challengesubcategoryid"
},
"WeightLBS": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Member's weight in pounds at time of benchmark.",
"title": "Weightlbs"
},
"ClassName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the class.",
"title": "Classname"
},
"CoachName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the coach.",
"title": "Coachname"
},
"Result": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The benchmark result (time, distance, etc.).",
"title": "Result"
},
"WorkoutTypeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Workouttypeid"
},
"WorkoutId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Workoutid"
},
"LinkedChallenges": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Linkedchallenges"
},
"DateCreated": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the entry was created in database, not useful to users",
"title": "Datecreated"
},
"DateUpdated": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the entry was updated in database, not useful to users",
"title": "Dateupdated"
},
"ClassId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API",
"title": "Classid"
},
"SubstituteId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API, also always seems to be 0",
"title": "Substituteid"
}
},
"title": "BenchmarkHistory",
"type": "object"
},
"EquipmentType": {
"description": "Enum representing the type of equipment used in workouts.",
"enum": [
2,
3,
4,
5,
6,
7
],
"title": "EquipmentType",
"type": "integer"
}
},
"description": "A challenge participation record with benchmark results.",
"properties": {
"StudioName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the studio.",
"title": "Studioname"
},
"StartDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date of the challenge.",
"title": "Startdate"
},
"EndDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date of the challenge.",
"title": "Enddate"
},
"TotalResult": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Aggregated result for the challenge.",
"title": "Totalresult"
},
"IsFinished": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the challenge has been completed.",
"title": "Isfinished"
},
"BenchmarkHistories": {
"description": "Individual benchmark results within this challenge.",
"items": {
"$ref": "#/$defs/BenchmarkHistory"
},
"title": "Benchmarkhistories",
"type": "array"
},
"ChallengeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API",
"title": "Challengeid"
},
"StudioId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API",
"title": "Studioid"
},
"ChallengeObjective": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Always the string 'None'",
"title": "Challengeobjective"
}
},
"title": "ChallengeHistory",
"type": "object"
}
Fields:
-
studio_name(str | None) -
start_date(datetime | None) -
end_date(datetime | None) -
total_result(float | str | None) -
is_finished(bool | None) -
benchmark_histories(list[BenchmarkHistory]) -
challenge_id(int | None) -
studio_id(int | None) -
challenge_objective(str | None)
benchmark_histories
pydantic-field
¶
benchmark_histories
Individual benchmark results within this challenge.
Goal
pydantic-model
¶
Bases: OtfItemBase
Goal settings for a fitness benchmark.
Show JSON schema:
{
"description": "Goal settings for a fitness benchmark.",
"properties": {
"Goal": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Target value for the goal.",
"title": "Goal"
},
"GoalPeriod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Time period for the goal.",
"title": "Goalperiod"
},
"OverallGoal": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Overall target value.",
"title": "Overallgoal"
},
"OverallGoalPeriod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Time period for the overall goal.",
"title": "Overallgoalperiod"
},
"MinOverall": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum overall value.",
"title": "Minoverall"
},
"MinOverallPeriod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Time period for the minimum overall.",
"title": "Minoverallperiod"
}
},
"title": "Goal",
"type": "object"
}
Fields:
-
goal(int | None) -
goal_period(str | None) -
overall_goal(int | None) -
overall_goal_period(str | None) -
min_overall(int | None) -
min_overall_period(str | None)
FitnessBenchmark
pydantic-model
¶
Bases: OtfItemBase
Detailed benchmark data including history, records, and goals.
Show JSON schema:
{
"$defs": {
"BenchmarkHistory": {
"description": "A single benchmark result from a specific class.",
"properties": {
"StudioName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the studio where the benchmark was performed.",
"title": "Studioname"
},
"EquipmentId": {
"anyOf": [
{
"$ref": "#/$defs/EquipmentType"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of equipment used."
},
"ClassTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the class took place.",
"title": "Classtime"
},
"ChallengeSubCategoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Sub-category of the benchmark.",
"title": "Challengesubcategoryid"
},
"WeightLBS": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Member's weight in pounds at time of benchmark.",
"title": "Weightlbs"
},
"ClassName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the class.",
"title": "Classname"
},
"CoachName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the coach.",
"title": "Coachname"
},
"Result": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The benchmark result (time, distance, etc.).",
"title": "Result"
},
"WorkoutTypeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Workouttypeid"
},
"WorkoutId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Workoutid"
},
"LinkedChallenges": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Linkedchallenges"
},
"DateCreated": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the entry was created in database, not useful to users",
"title": "Datecreated"
},
"DateUpdated": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the entry was updated in database, not useful to users",
"title": "Dateupdated"
},
"ClassId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API",
"title": "Classid"
},
"SubstituteId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API, also always seems to be 0",
"title": "Substituteid"
}
},
"title": "BenchmarkHistory",
"type": "object"
},
"ChallengeHistory": {
"description": "A challenge participation record with benchmark results.",
"properties": {
"StudioName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the studio.",
"title": "Studioname"
},
"StartDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date of the challenge.",
"title": "Startdate"
},
"EndDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date of the challenge.",
"title": "Enddate"
},
"TotalResult": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Aggregated result for the challenge.",
"title": "Totalresult"
},
"IsFinished": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the challenge has been completed.",
"title": "Isfinished"
},
"BenchmarkHistories": {
"description": "Individual benchmark results within this challenge.",
"items": {
"$ref": "#/$defs/BenchmarkHistory"
},
"title": "Benchmarkhistories",
"type": "array"
},
"ChallengeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API",
"title": "Challengeid"
},
"StudioId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API",
"title": "Studioid"
},
"ChallengeObjective": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Always the string 'None'",
"title": "Challengeobjective"
}
},
"title": "ChallengeHistory",
"type": "object"
},
"EquipmentType": {
"description": "Enum representing the type of equipment used in workouts.",
"enum": [
2,
3,
4,
5,
6,
7
],
"title": "EquipmentType",
"type": "integer"
},
"Goal": {
"description": "Goal settings for a fitness benchmark.",
"properties": {
"Goal": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Target value for the goal.",
"title": "Goal"
},
"GoalPeriod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Time period for the goal.",
"title": "Goalperiod"
},
"OverallGoal": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Overall target value.",
"title": "Overallgoal"
},
"OverallGoalPeriod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Time period for the overall goal.",
"title": "Overallgoalperiod"
},
"MinOverall": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum overall value.",
"title": "Minoverall"
},
"MinOverallPeriod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Time period for the minimum overall.",
"title": "Minoverallperiod"
}
},
"title": "Goal",
"type": "object"
},
"MetricEntry": {
"description": "Definition of a metric used to track benchmark performance.",
"properties": {
"Title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Display title for the metric.",
"title": "Title"
},
"EquipmentId": {
"anyOf": [
{
"$ref": "#/$defs/EquipmentType"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of equipment for this metric."
},
"EntryType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of entry (e.g. time, distance).",
"title": "Entrytype"
},
"MetricKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Internal key for the metric.",
"title": "Metrickey"
},
"MinValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum valid value for this metric.",
"title": "Minvalue"
},
"MaxValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum valid value for this metric.",
"title": "Maxvalue"
}
},
"title": "MetricEntry",
"type": "object"
}
},
"description": "Detailed benchmark data including history, records, and goals.",
"properties": {
"ChallengeCategoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Category ID for the benchmark.",
"title": "Challengecategoryid"
},
"ChallengeSubCategoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Sub-category ID for the benchmark.",
"title": "Challengesubcategoryid"
},
"EquipmentId": {
"anyOf": [
{
"$ref": "#/$defs/EquipmentType"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of equipment used."
},
"EquipmentName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Display name of the equipment.",
"title": "Equipmentname"
},
"MetricEntry": {
"anyOf": [
{
"$ref": "#/$defs/MetricEntry"
},
{
"type": "null"
}
],
"default": null,
"description": "Definition of the metric being tracked."
},
"ChallengeName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Display name of the benchmark.",
"title": "Challengename"
},
"BestRecord": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Member's all-time best result.",
"title": "Bestrecord"
},
"LastRecord": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Member's most recent result.",
"title": "Lastrecord"
},
"PreviousRecord": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Member's previous result before the most recent.",
"title": "Previousrecord"
},
"Unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Unit of measurement for the result.",
"title": "Unit"
},
"Goals": {
"anyOf": [
{
"$ref": "#/$defs/Goal"
},
{
"type": "null"
}
],
"default": null,
"description": "Goal settings for this benchmark."
},
"ChallengeHistories": {
"description": "Historical participation records.",
"items": {
"$ref": "#/$defs/ChallengeHistory"
},
"title": "Challengehistories",
"type": "array"
}
},
"title": "FitnessBenchmark",
"type": "object"
}
Fields:
-
challenge_category_id(int | None) -
challenge_sub_category_id(int | None) -
equipment_id(EquipmentType | None) -
equipment_name(str | None) -
metric_entry(MetricEntry | None) -
challenge_name(str | None) -
best_record(float | str | None) -
last_record(float | str | None) -
previous_record(float | str | None) -
unit(str | None) -
goals(Goal | None) -
challenge_histories(list[ChallengeHistory])