Deprecated: Use get_tests instead, which has been expanded to handle all requests.
Get only tests of the specified group for an account.
Arguments
- groupId
Supply a group’s ID, a list of group IDs, or a string of a comma separated group id’s to receive tests from the specified groups. A maximum of 10 groups can be fetched at once.
- from
Optionally supply a time (Unix time stamp) you want the tests from. If you do not supply this value you will receive every test. This parameter is best suited for bulk exports of historical data.
- to
Optionally supply a time (Unix time stamp) you want the tests to. If you do not supply this value you will receive every test from the beginning of time or the optionally supplied
fromparameter. This parameter is best suited for bulk exports of historical data.- sync
The result set will include updated and newly created tests. This parameter is best suited to keep your database in sync with the Hawkin database. If you do not supply this value you will receive every test.
- includeInactive
There was a change to the default API configuration to reflect the majority of users API configuration. Inactive tests or tests where
active = falseare returned in these configuration. Be default,includeInactiveis set toFALSE. To return all tests, including disabled trials, setincludeInactivetoTRUE.
Value
Response will be a data frame containing the trials within the time range (if specified).
| Column Name | Type | Description |
| id | str | Test trial unique ID |
| active | logi | The trial is active and not disabled |
| timestamp | int | UNIX time stamp of trial |
| segment | chr | Description of the test type and trial number of the session (testType:trialNo) |
| test_type_id | chr | Id of the test type of the trial |
| test_type_name | chr | Name of the test type of the trial |
| test_type_canonicalId | chr | Canonical Id of the test type of the trial |
| test_type_tag_ids | chr | String of Ids associated with tags used during the test trial |
| test_type_tag_names | chr | String of names of tags used during the test trial |
| test_type_tag_desc | chr | String of descriptions of tags used during the test trial |
| athlete_id | chr | Unique Id of the athlete |
| athlete_name | chr | Athlete given name |
| athlete_active | logi | The athlete is active |
| athlete_teams | list | List containing Ids of each team the athlete is on |
| athlete_groups | list | List containing Ids of each group the athlete is in |
All metrics from each test type are included as the remaining variables. If a trial does not have data for a variable it is returned NA.
Examples
if (FALSE) { # \dontrun{
# This is an example of how the function would be called.
## Call for all tests by Group 1
dfGroup1 <- get_tests_group(groupId = "group1")
## Call for all tests from Groups 1 & 2
dfGroups_1_2 <- get_tests_group(groupId = paste0("group1","group2"))
## Call for all Group 1 tests since a specific date
df_Group1_Since <- get_tests_group("group1", from = 1689958617)
} # }