API: Como gerenciar a audiência de uma missão

Atualizado por Larson Guimarães

A API do Learning Rocks permite gerenciar a audiência de uma missão, definindo quais usuários poderão visualizar um treinamento específico.

Clicando aqui você pode acessar a collection completa de Missões.

A API disponibiliza os seguintes comandos:

  • Associar usuários e times à audiência de uma missão;
  • Dissociar usuários e times da audiência de uma missão.

Associar usuários ou times

Para adicionar usuários ou times ao público-alvo de uma missão, é necessário enviar o comando PATCH para a URL: https://mission.learningrocks.io/missions/add_audience.

O body da requisição deve ser preenchido com os seguintes campos:

  • "mission_id": "mission_id" – substituindo o valor pelo ID da missão;
  • "user_ids": ["user_id", "user_id"] – substituindo os valores pelos IDs dos usuários que serão adicionados;
  • "team_ids": ["team_id", "team_id"] – substituindo os valores pelos IDs dos times que serão adicionados.

Exemplo de request e response:

Dissociar usuários ou times

Para remover usuários ou times ao público-alvo de uma missão, é necessário enviar o comando PATCH para a URL: https://mission.learningrocks.io/missions/remove_audience.

O body da requisição deve ser preenchido com os seguintes campos:

  • "mission_id": "mission_id" – substituindo o valor pelo ID da missão;
  • "user_ids": ["user_id", "user_id"] – substituindo os valores pelos IDs dos usuários que serão removidos;
  • "team_ids": ["team_id", "team_id"] – substituindo os valores pelos IDs dos times que serão removidos.

Exemplo de request e response:

Importante

  • Somente os usuários e times listados na requisição serão afetados pelo comando. Usuários ou times que não forem incluídos na listagem não sofrerão alterações. Exemplo: se os usuários João e “Maria” estiverem individualmente adicionados à audiência, e for enviado o comando para remover o "João", “Maria” permanecerá na audiência normalmente.
  • Audiências inteligentes não podem ser gerenciadas via API. Elas devem ser adicionadas como público de uma missão diretamente pela plataforma.
  • Para lidar com um grande volume de requisições simultâneas e garantir que o desempenho não seja comprometido, recomendamos que as requisições sejam realizadas de forma paginada.
  • Para enviar as requisições, é necessário saber o ID da missão, informação que pode ser obtida por meio dos relatórios da plataforma.


O que você achou desse artigo? Gostou?


Powered by HelpDocs (opens in a new tab)