> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weve.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Linha do tempo de um aluno

> Compra, acesso, aula, comentário, certificado, live e mentoria numa lista só.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/students/{studentId}/activity
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.weve.cx
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
  - name: exports
  - name: certificates
paths:
  /v1/clubs/{clubId}/students/{studentId}/activity:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/StudentId'
    get:
      tags:
        - students
      summary: A linha do tempo de um aluno
      description: |
        O que aconteceu com esta pessoa, do mais recente ao mais antigo, numa
        lista só: compra, acesso concedido ou revogado, aula concluída,
        pergunta ou comentário escrito, certificado emitido, live assistida e
        sessão de mentoria.

        É uma UNIÃO de tabelas que não têm chave entre si, então o evento é
        genérico de propósito — `kind`, `occurred_at`, `title` e `detail`. Cada
        origem escreve o seu título em pt-BR; a tela desenha o que vier, e
        origem nova não obriga a mexer nela.

        Exige permissão de administração do club.
      operationId: listStudentActivity
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: A página pedida da linha do tempo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudentActivityList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - userSession: []
components:
  parameters:
    OrgId:
      name: clubId
      in: path
      required: true
      description: >
        Id público da organização — o mesmo que `GET /v1/me` devolve em

        `organization_id`.


        Na URL o recurso se chama **club**; no contrato e no domínio,
        organization.

        A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o
        que

        as pessoas leem.


        É o identificador do provedor de autenticação, e é assim de propósito:

        o cliente precisa nomear a organização ao pedir o token, e o token é o

        que prova o escopo. Um id só nosso obrigaria a traduzir um no outro

        antes de ter um token — e a tradução exigiria uma chamada escopada, que

        é justamente a que ainda não dá para fazer.


        O uuid interno da organização não aparece no contrato: ele é o que as

        chaves estrangeiras do domínio referenciam, e continua sendo nosso.
      schema:
        type: string
        format: uuid
    StudentId:
      name: studentId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    StudentActivityList:
      type: object
      required:
        - data
        - total
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/StudentActivity'
        total:
          description: Quantos eventos a linha do tempo inteira tem.
          type: integer
    StudentActivity:
      type: object
      required:
        - id
        - kind
        - occurred_at
        - title
      properties:
        id:
          description: >-
            Único DENTRO da lista (a origem mais a chave da linha); não é id de
            recurso.
          type: string
        kind:
          $ref: '#/components/schemas/StudentActivityKind'
        occurred_at:
          type: string
          format: date-time
        title:
          description: O que aconteceu, em pt-BR, já escrito pelo servidor.
          type: string
        detail:
          description: A segunda linha, quando a origem tem o que acrescentar.
          type: string
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
    StudentActivityKind:
      description: |
        A origem do evento. Lista aberta por natureza — a tela desenha o
        `title` que vier e usa o `kind` só para o ícone, então cliente antigo
        não quebra quando uma origem nova entrar.
      type: string
      enum:
        - purchase
        - refund
        - access_granted
        - access_revoked
        - lesson_completed
        - comment
        - certificate
        - live
        - mentorship
  responses:
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >
        A sessão é válida, mas não age nesta organização. É a mesma resposta
        para

        uma organização que não existe — distinguir as duas deixaria enumerar

        organizações alheias.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    userSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de quem administra, emitido por
        `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo
        desenho do `studentSession`, para a outra identidade.

        É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
        `studentSession`; uma rota consumida pelos dois declara os dois
        esquemas, e o middleware aceita qualquer um deles. As duas credenciais
        são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
        que cada uma existe.

        O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
        `Authorization` a cada chamada.

````

## Related topics

- [Weve DRM](/essentials/watermark.md)
- [Campanhas e automações](/essentials/campaigns-and-workflows.md)
- [Biblioteca de mídia](/essentials/media.md)
- [Webhooks de saída](/essentials/webhooks.md)
- [Lives](/essentials/lives.md)
