Browse Articles

Browse Articles

Reach 360 API: Reporters and Reporting Groups API

Article Last Updated

This article applies to:

Reach 360

Endpoints

  • GET /users/{userId}/reporting-groups - list what groups a reporter reports for
  • GET /groups/{groupId}/reporters - list a group's reporters

List Groups a Reporter Reports

GET /users/{userId}/reporting-groups

Request Parameters (Query String)

  • limit (integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 100 (defaults to 50)

Example Response

{
  "userUrl": "<https://api.rise.com/users/example-user-id-1>",
  "groups": [
    {
      "id": "example-group-id-1",
      "membersUrl": "<https://api.rise.com/groups/example-group-id-1/users>",
      "managersUrl": "<https://api.rise.com/groups/example-group-id-1/managers>",
      "reportersUrl": "<https://api.rise.com/groups/example-group-id-1/reporters>",
      "name": "Example Group",
      "url": "<https://api.rise.com/groups/example-group-id-1>"
    }, ...
  ],
  "nextUrl": "<https://url-for-next-page-of-results>"
}

Endpoint-specific error codes:

  • user_not_found - can't list reporter's groups because user doesn't exist
  • invalid_user_role - can't list reporter's groups because user isn't a reporter

List a Group's Reporters

GET /groups/{groupId}/reporters

Note: Includes users who also report on the Everyone group

Request Parameters (Query String)

  • limit (integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 100 (defaults to 50)

Example Response

{
  "groupUrl": "<http://api.rise.com/groups/example-group-id>",
  "reporters": [
    {
      "id": "example-user-id-1",
      "email": "foo@example.com",
      "groupsUrl": "<https://api.rise.com/users/example-user-id-1/groups>",
      "managingGroupsUrl": null,
      "reportingGroupsUrl": "<https://api.rise.com/users/example-user-id-1/reporting-groups>",
      "role" :"reporter",
      "firstName": "Example Group Reporter",
      "lastName": "Example Last Name",
      "lastActiveAt": "2021-10-28T20:39:52.659Z",
      "learnerReportUrl": "<https://api.rise.com/reports/learners/example-user-id-1>",
      "url": "<https://api.rise.com/users/example-user-id-1>"
    },
    {
      "id": "example-user-id-2",
      "email": "bar@example.com",
      "groupsUrl": "<https://api.rise.com/users/example-user-id-2/groups>",
      "managingGroupsUrl": null,
      "reportingGroupsUrl": "<https://api.rise.com/users/example-user-id-2/reporting-groups>",
      "role": "reporter",
      "firstName": "Example Everyone Reporter",
      "lastName": "Example Last Name",
      "lastActiveAt": "2021-10-28T20:39:52.659Z",
      "learnerReportUrl": "<https://api.rise.com/reports/learners/example-user-id-2>",
      "url": "<https://api.rise.com/users/example-user-id-2>"
    }, ...
  ],
  "nextUrl": "<https://url-for-next-page-of-results>"
}

Endpoint-specific error codes:

  • group_not_found - can't list reporters because group doesn't exist