v1

latestOpenAPI 3.0.02026-07-24900287.5 KB
Efforts Data

Get Efforts Data For Athlete in Period

This API retrieves efforts data for athlete in a period.

get/periods/{period_id}/athletes/{athlete_id}/efforts

Path parameters

period_idstring required

Period Id

athlete_idstring required

Athlete Id

Query parameters

effort_typesstring required

Comma Separated Effort Type Values (can only include 'acceleration' or 'velocity' or both separated by comma)

start_timeinteger

Start Time as UNIX timestamp in seconds

end_timeinteger

End Time as UNIX timestamp in seconds

velocity_bandsstring

One or more comma separated velocity band parameters may be supplied to restrict the list of bands returned, as an integer. Valid values are numbers 1 to 8. If not velocity bands values are specified, all bands are included.

acceleration_bandsstring

One or more comma separated acceleration band parameters may be supplied to restrict the list of bands returned, as an integer. Valid values are numbers -3 to 3, matching deceleration and acceleration bands 1 to 3 in OpenField Cloud including 0. If no band values are specified, bands -3, -2,-1 and 1, 2 and 3 will be included.

Response

Efforts Data (Acceleration & Velocity both)

athlete_idstring
device_idinteger
player_idstring
athlete_first_namestring
athlete_last_namestring
jerseystring
team_idstring
team_namestring