This guide is intended to provide instructions on how to interact with and use the External NordBord API.
The External NordBord API can be utilised to access team and athlete test data.
- Identify your region
- Scenario 1: Retrieve a collection of tests for a tenant (Updated)
- Scenario 2: Retrieve a collection of tests for a tenant (Planned for deprecation)
- Scenario 3: Retrieve a single test
- Scenario 4: Retrieve a NordBord force trace associated with a single test
Identify your region
The endpoint you use to interact with the External NordBord API is dependant on what region you (the client) reside in.
Please note that only tenant data which resides within the region of the API endpoint used is accessible. Therefore, if a tenant's data resides in Australia (East), it will only be accessible from that region's API.
Choose your region below and copy the endpoint URL provided.
Australia (East) |
https://prd-aue-api-externalnordbord.valdperformance.com/swagger/index.html |
United States (East) |
https://prd-use-api-externalnordbord.valdperformance.com/swagger/index.html |
Europe (West) |
https://prd-euw-api-externalnordbord.valdperformance.com/swagger/index.html |
If you are unsure which region-specific URL you should be using, please contact support@vald.com.
Scenario 1: Retrieve a collection of tests for a tenant
Updated
This is the recommended method to retrieve a list of tests for a tenant.
URL
/tests/v2
Path Parameters
None.
Query Parameters
Parameter | Required | Description |
tenantId | True | ID of the tenant from which to retrieve tests. |
modifiedFromUtc | True |
Retrieve tests modified after the specified UTC date. Format: YYYY-MM-DDT00:00:00.000Z |
profileId | False | ID of the athlete from which to retrieve tests. |
Description
- Set the required parameters.
- Set the
tenantId
parameter. This is your organization's unique identifier. - Set the
modifiedFromUtc
parameter. This is the date and time from which you want to retrieve test data (formatted in UTC).
- Set the
- Retrieve your data. Here are a few examples of how to structure your requests:
Request 1: Retrieve all tests modified after a specific date and time
/tests/v2?TenantId={tenantId}&ModifiedFromUtc={modifiedFromUtc}
- To get the next set of paged records, use the
modifiedDateUtc
value of the last record as the value for themodifiedFromUtc
query parameter in your next request. - This will return all tests for the tenant from the specified date and time.
Request 2: Retrieve tests for a specific profile
/tests/v2?TenantId={tenantId}&ModifiedFromUtc={modifiedFromUtc}&ProfileId={profileId}
- As with Request 1, use the
modifiedDateUtc
value of the last record for pagination. - This request will return tests filtered by tenant and profile.
Request 3: Retrieve all tests modified in the last 2 hours
/tests/v2?TenantId={tenantId}&ModifiedFromUtc={modifiedFromUtc}
- If the current UTC time is
2024-02-12T09:00:00.1234567Z
, setmodifiedFromUtc
to 2 hours earlier (i.e.2024-02-12T07:00:00.1234567Z
). - This will return all records modified in the past 2 hours.
Note: You cannot retrieve tests using a specific date range, as described in the previous example.
- Repeat the above steps until you receive a
204 No Content
status code, which indicates there are no more records to retrieve.
Tests are returned in ascending order of {modifiedFromUtc} (i.e. oldest to newest).
Response
Example response
{
"tests": [
{
"profileId": "<PROFILE_ID>",
"testId": "<TEST_ID>",
"modifiedDateUtc": "2024-03-11T05:50:28.981Z",
"testDateUtc": "2024-03-11T05:50:28.935Z",
"testTypeId": "<TEST-TYPE-ID>",
"testTypeName": "Nordic",
"notes": "Max Strength Testing",
"device": "NordBord-1033",
"leftAvgForce": 219.25,
"leftImpulse": 200.56,
"leftMaxForce": 219.25,
"leftTorque": 64.13062500000001,
"leftCalibration": 0,
"leftRepetitions": 1,
"rightAvgForce": 228.25,
"rightImpulse": 217.365,
"rightMaxForce": 228.25,
"rightTorque": 66.763125,
"rightCalibration": 0,
"rightRepetitions": 1
}
]
}
Scenario 2: Retrieve a collection of tests for a tenant
Planned for deprecation
This approach is no longer preferable and will be deprecated in future. Please use Scenario 1 above to retrieve a collection of tests for a tenant.
URL
/tests
Path Parameters
None.
Query Parameters
Parameter | Required | Description |
tenantId | True | ID of the tenant from which to retrieve tests. |
modifiedFromUtc | True |
Retrieve tests modified after the specified UTC date. Format: YYYY-MM-DDT00:00:00.000Z |
testFromUtc | True |
Retrieve tests recorded after the specified UTC date. Format: YYYY-MM-DDT00:00:00.000Z |
testToUtc | True |
Retrieve tests recorded before the specified UTC date. Format: YYYY-MM-DDT00:00:00.000Z |
athleteId | False | ID of the athlete from which to retrieve tests. |
page | False | The page number to return. Default is 1. |
pageSize | False | The number of tests returned by a single page. Default is 50 – max value is 100. |
Description
- Set the required parameters.
- Ensure the
testFromUtc
andtestToUtc
are within six months of each other. - Use the
modifiedFromUtc
as a mechanism to refine the tests down further. If unsure, set this parameter to be equal totestFromUtc
. - Set
page
equal to1
.
- Ensure the
- Retrieve a page of data using
/tests?TenantId={tenantId}&ModifiedFromUtc={modifiedFromUtc}&TestFromUtc={testFromUtc}&TestToUtc={testToUtc}&Page={page}
- Increment the
page
parameter. -
Repeat steps 2 - 3 until a No Content
204
status code is returned.
Note: Tests are returned in descending order of test date (i.e. newest to oldest).
Response
Example response
{
"tests": [
{
"athleteId": "<PROFILE-ID>",
"testId": "<TEST-ID>",
"modifiedUtc": "2024-06-12T01:06:07.504Z",
"testDateUtc": "2024-03-20T04:52:50.571Z",
"testTypeId": "596a6004-553f-4afa-aef0-1474903b462e",
"testTypeName": "Nordic",
"notes": "Training Camp (March)",
"device": "NBE - 1033",
"leftAvgForce": 339.5,
"leftImpulse": 741.55,
"leftMaxForce": 339.5,
"leftTorque": 126.80325000000002,
"leftCalibration": 1.0165,
"rightAvgForce": 339.75,
"rightImpulse": 749.595,
"rightMaxForce": 339.75,
"rightTorque": 126.89662500000001,
"rightCalibration": 1.0118,
"leftRepetitions": 1,
"rightRepetitions": 1
},
...
{
"athleteId": "<PROFILE-ID>",
"testId": "<TEST-ID>",
"modifiedUtc": "2024-01-10T00:46:28.703Z",
"testDateUtc": "2024-01-10T00:46:28.468Z",
"testTypeId": "596a6004-553f-4afa-aef0-1474903b462e",
"testTypeName": "Nordic",
"notes": "Training Camp (January)",
"device": "NordBord-1622",
"leftAvgForce": 165.125,
"leftImpulse": 1053.455,
"leftMaxForce": 166.0,
"leftTorque": 48.55500000000001,
"leftCalibration": 0.0,
"rightAvgForce": 161.0,
"rightImpulse": 1035.685,
"rightMaxForce": 162.5,
"rightTorque": 47.53125000000001,
"rightCalibration": 0.0,
"leftRepetitions": 2,
"rightRepetitions": 2
}
],
"page": 2,
"pageCount": 5
}
Scenario 3: Retrieve a single test
URL
/tests/{testId}
Path Parameters
Parameter | Required | Description |
testId | True | ID of test to retrieve. |
Query Parameters
Parameter | Required | Description |
tenantId | True | ID of the tenant from which to retrieve tests. |
Description
Use to retrieve summary information about a test.
Response
Example response
{
"athleteId": "<PROFILE-ID>",
"testId": "<TEST-ID>",
"modifiedUtc": "2024-01-10T00:46:28.703Z",
"testDateUtc": "2024-01-10T00:46:28.468Z",
"testTypeId": "596a6004-553f-4afa-aef0-1474903b462e",
"testTypeName": "Nordic",
"notes": "Training Camp (January)",
"device": "NordBord-1622",
"leftAvgForce": 165.125,
"leftImpulse": 1053.455,
"leftMaxForce": 166.0,
"leftTorque": 48.55500000000001,
"leftCalibration": 0.0,
"rightAvgForce": 161.0,
"rightImpulse": 1035.685,
"rightMaxForce": 162.5,
"rightTorque": 47.53125000000001,
"rightCalibration": 0.0,
"leftRepetitions": 2,
"rightRepetitions": 2
}
Scenario 4: Retrieve a NordBord force trace associated with a single test
URL
/tests/{testId}/nordbordtrace
Path Parameters
Parameter | Required | Description |
testId | True | ID of test to retrieve. |
Query Parameters
Parameter | Required | Description |
tenantId | True | ID of the tenant from which to retrieve tests. |
Description
Use to retrieve a NordBord force trace.
Response
Example response
{
"athleteId": "<PROFILE-ID>",
"testId": "<TEST-ID>",
"testTypeId": "596a6004-553f-4afa-aef0-1474903b462e",
"testTypeName": "Nordic",
"forces": [
{
"ticks": 638404443510279552,
"leftForce": 0.0,
"rightForce": 0.0
},
...
{
"ticks": 638404443860190080,
"leftForce": 0.25,
"rightForce": 2.25
}
],
"device": "NordBord-1622",
"testDateUtc": "2024-01-10T00:46:28.468Z",
"notes": "Training Camp (January)"
}}
Comments
0 comments
Please sign in to leave a comment.