GET group/…/results

GET Retrieves the up-to-date results for a group.

The results include the following data:

  • the average proficiency for the entire group (over all group members and all drills)
  • the average proficiency for each drill (over all group members)
  • the current proficiency for each group member and each drill in the group
  • the average proficiency for each group member (over all drills)
  • the evaluation of practice objectives, if any have been defined for the drills in the group, and if the objectives is due (it's evaluation date has passed).

For large groups, it is recommended to paginate the results, using the resultStart and resultSize parameters. This will limit the number of group members to include in the result. The group members are sorted by date and time they joined the group.

Resource URL

https://www.drillster.com/api/2/group/{group_id}/results

The group ID is the unique identifier of the group.

Parameters

Field Type Description
resultStart
optional
Integer

The index number (zero-based) of the first group member to include in the result. Use this parameter, in combination with resultSize, to apply pagination of the result; it will limit the number of group members included in the result. Defaults to 0.

resultSize
optional
Integer

The maximum number of group members to include in the result. If not specified, the results for all (remaining) group members are returned.

Response

A 2.0 GroupResults object.

Example request

A request for a group with 2 drills and 1 course (containing 2 drills), 2 members, and no practice objectives.

GET https://www.drillster.com/api/2/group/nYrK9udUc-UGvRS2kxaPtaB-0wzeHAJzM6vlL1te6wI/results

Response

{
  "groupId" : "nYrK9udUc-UGvRS2kxaPtaB-0wzeHAJzM6vlL1te6wI",
  "averageProficiency" : 20,
  "averageDrillResults" : [ {
    "type" : "course",
    "proficiency" : 16,
    "drillResults" : [ {
      "type" : "drill",
      "proficiency" : 43,
      "id" : "QnOsNpGQTQSUVyXWdUjgqA"
    }, {
      "type" : "drill",
      "proficiency" : 22,
      "id" : "wL5Sj3hfQhmb3G1nzo0wYw"
    } ],
    "id" : "aisay8ZAS-22lDlB3k-64w"
  }, {
    "type" : "drill",
    "proficiency" : 26,
    "id" : "bcW3mGSRSECKtdBQsiieeg"
  }, {
    "type" : "drill",
    "proficiency" : 74,
    "id" : "86KQcmCWSzCsgjRr2lkO9Q"
  } ],
  "memberResults" : [ {
    "userId" : "BOR_04dNRNa_hGCL09UtyA",
    "averageProficiency" : 22,
    "drillResults" : [ {
      "type" : "drill",
      "proficiency" : 36,
      "id" : "bcW3mGSRSECKtdBQsiieeg"
    }, {
      "type" : "drill",
      "proficiency" : 47,
      "id" : "86KQcmCWSzCsgjRr2lkO9Q"
    }, {
      "type" : "course",
      "proficiency" : 24,
      "drillResults" : [ {
        "type" : "drill",
        "proficiency" : 62,
        "id" : "QnOsNpGQTQSUVyXWdUjgqA"
      }, {
        "type" : "drill",
        "proficiency" : 35,
        "id" : "wL5Sj3hfQhmb3G1nzo0wYw"
      } ],
      "id" : "aisay8ZAS-22lDlB3k-64w"
    } ]
  }, {
    "userId" : "tOsrtOKrSiigIMQQi7Rbmw",
    "averageProficiency" : 18,
    "drillResults" : [ {
      "type" : "drill",
      "proficiency" : 15,
      "id" : "bcW3mGSRSECKtdBQsiieeg"
    }, {
      "type" : "drill",
      "proficiency" : 100,
      "id" : "86KQcmCWSzCsgjRr2lkO9Q"
    }, {
      "type" : "course",
      "proficiency" : 8,
      "drillResults" : [ {
        "type" : "drill",
        "proficiency" : 8,
        "id" : "wL5Sj3hfQhmb3G1nzo0wYw"
      }, {
        "type" : "drill",
        "proficiency" : 24,
        "id" : "QnOsNpGQTQSUVyXWdUjgqA"
      } ],
      "id" : "aisay8ZAS-22lDlB3k-64w"
    } ]
  } ],
  "members" : 2
}

Error responses

The following error situations are possible:

ID Description
group_not_found Could not retrieve group details.
drill_code_missing No drill specified.
no_group_access You are not allowed to remove drills from this group.