• Site Logo, Articulate

Busca de Artigos

Selecione um Produto

Diretório de suporte de null

Explore todos os artigos de null (Last Updated )

Nenhum artigo encontrado.

Resultados da pesquisa

Nenhum artigo encontrado.

API Reach 360: API de repórteres e grupos de relatórios

Artigo atualizado pela última vez em 22 de abr. de 2025

Endpoints

  • GET /users/{userId}/reporting-groups- liste para quais grupos um repórter se reporta
  • GET /groups/{groupId}/reporters- listar os repórteres de um grupo

Listar grupos que um repórter relata

GET /users/{userId}/reporting-groups

Parâmetros de solicitação (sequência de caracteres de consulta)

  • limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 100 (o padrão é 50)

Exemplo de resposta

{
  "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>"
}

Códigos de erro específicos do endpoint:

  • user_not_found- não consigo listar os grupos do repórter porque o usuário não existe
  • invalid_user_role- não é possível listar grupos de repórteres porque o usuário não é repórter

Listar os repórteres de um grupo

GET /groups/{groupId}/reporters

Observação: inclui usuários que também reportam sobre o grupo Todos

Parâmetros de solicitação (sequência de caracteres de consulta)

  • limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 100 (o padrão é 50)

Exemplo de resposta

{
  "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>"
}

Códigos de erro específicos do endpoint:

  • group_not_found- não consigo listar repórteres porque o grupo não existe

 

API Reach 360: API de repórteres e grupos de relatórios