Pular para o conteúdo
Plataforma

Uso completo de um aluno (matrículas, aulas assistidas, certificados, login)

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/platform/users/{id}
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposplatform.read

A visão que uma auditoria de estorno precisa: matriculou? assistiu? concluiu? logou depois da compra? courses e certificates são ALL-TIME (toda a história do aluno); lessons e library filtram pela janela ?days=7|30|90 (default 30 — mesma janela do painel interno de engajamento). access.sessionsInWindow conta sessões abertas DENTRO da janela; lastLoginAt/lastActiveAt são sempre all-time (a pergunta 'ele já logou' não pode depender do período escolhido). access.lastIp é o IP da sessão mais recente — um carimbo, não 'o' IP do aluno. 404 se o usuário não existe.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho mín. 1

Parâmetros de consulta

Vão na querystring, depois do ?.

  • daysintegeropcional

Respostas

7 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Dossiê de uso do aluno: acesso (último login, última atividade, sessões abertas na janela e IP da sessão mais recente), matrículas e certificados de toda a história, e as aulas assistidas e documentos lidos DENTRO da janela de windowDays dias. Listas vazias querem dizer "existe e não usou".

V1PlatformUserDetail

  • idstring
  • namestring
  • emailstring
  • createdAtstring
  • windowDaysinteger
    • lastLoginAtstring | null
    • lastActiveAtstring | null
    • sessionsInWindowinteger
    • lastIpstring | null

  • Cada item da lista

    • courseIdstring
    • courseTitlestring
    • statusstring
      • um de"active""completed"
    • progressPctinteger
    • startedAtstring | null
    • completedAtstring | null

  • Cada item da lista

    • lessonIdstring
    • titlestring
    • courseTitlestring
    • watchSecinteger
    • watchPctinteger
    • completedboolean
    • lastDatestring

  • Cada item da lista

    • codestring
    • courseIdstring
    • courseTitlestring
    • issuedAtstring

  • Cada item da lista

    • docIdstring
    • titlestring
    • readSecinteger
    • readboolean
    • lastDatestring