> ## 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. # Engajamento > Quem estudou no período, a sequência de dias de estudo, os posts na comunidade, quem sumiu e onde cada curso para. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/engagement 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}/engagement: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - clubs summary: O engajamento do club description: | Os números da tela de Engajamento: quantos alunos estudaram no período, a sequência de dias de estudo, os posts na comunidade, quem sumiu e, curso a curso, quantos terminaram e quantos estão parados — e onde. `period` recorta só o "no ritmo" e os posts, com o mesmo corte do Painel (`GET .../overview`) e o número do período anterior para comparar. O resto tem janela própria: a sequência é a de HOJE, "sumido" é quem já estudou e não estuda há 21 dias, e "parado" num curso é quem o começou, não o terminou e não o toca há 7 dias. As definições de aluno ativo e de "estudou" são as do Painel. Exige administrar o club. operationId: getClubEngagement parameters: - name: period in: query required: false schema: $ref: '#/components/schemas/OverviewPeriod' responses: '200': description: O engajamento content: application/json: schema: $ref: '#/components/schemas/ClubEngagementResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' '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 schemas: OverviewPeriod: description: | O recorte do Painel: a semana corrente (segunda a domingo), os últimos 30 dias (hoje incluído), o mês corrente ou desde a criação do club. type: string enum: - week - last_30_days - month - all default: week x-enum-varnames: - OverviewPeriodWeek - OverviewPeriodLast30Days - OverviewPeriodMonth - OverviewPeriodAll ClubEngagementResponse: type: object required: - data properties: data: $ref: '#/components/schemas/ClubEngagement' ClubEngagement: type: object required: - period - from - to - students - on_pace - streak - posts - gone - courses properties: period: $ref: '#/components/schemas/OverviewPeriod' from: description: O primeiro dia do período. type: string format: date to: description: O último dia do período (incluído). type: string format: date students: description: Alunos ativos. type: integer on_pace: description: Alunos ativos que estudaram em algum dia do período. type: integer previous_on_pace: description: O mesmo, no período anterior. Nulo em `all`. type: integer nullable: true streak: $ref: '#/components/schemas/EngagementStreak' posts: description: Posts que alunos abriram na comunidade no período, sem os removidos. type: integer previous_posts: description: O mesmo, no período anterior. Nulo em `all`. type: integer nullable: true gone: $ref: '#/components/schemas/EngagementGone' courses: description: > Os cursos publicados a que algum aluno ativo tem acesso, dos com mais parados para os com menos. type: array items: $ref: '#/components/schemas/EngagementCourse' 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 EngagementStreak: description: | A sequência de cada aluno ativo é o número de dias seguidos de estudo que termina hoje ou ontem — quem ainda não estudou hoje não a perdeu. type: object required: - students - best_days properties: students: description: Quantos alunos ativos têm uma sequência em curso. type: integer average_days: description: A média entre eles. Nula quando ninguém tem. type: number format: double nullable: true best_days: description: A maior sequência em curso; zero quando ninguém tem. type: integer EngagementGone: description: Alunos ativos que já estudaram e não estudam há 21 dias ou mais. type: object required: - students properties: students: type: integer top: description: | A aula do último toque em que mais deles pararam, com quantos. Nula quando não há sumido. nullable: true allOf: - $ref: '#/components/schemas/OverviewStuckCourse' EngagementCourse: type: object required: - course_id - title - students - completed - stuck properties: course_id: type: string format: uuid title: type: string students: description: Alunos ativos com acesso ao curso. type: integer completed: description: Os que concluíram todas as aulas publicadas. type: integer stuck: description: | Os que começaram, não terminaram e não tocam no curso há 7 dias. type: integer stuck_lesson: description: A aula em que mais deles pararam. Nula sem parado. nullable: true allOf: - $ref: '#/components/schemas/EngagementLesson' OverviewStuckCourse: type: object required: - course_id - course_title - lesson_id - lesson_title - lesson_number - students properties: course_id: type: string format: uuid course_title: type: string lesson_id: type: string format: uuid lesson_title: type: string lesson_number: description: A posição da aula no curso, contando de 1. type: integer students: type: integer EngagementLesson: type: object required: - lesson_id - title - number - students properties: lesson_id: type: string format: uuid title: type: string number: description: A posição da aula no curso, contando de 1. type: integer students: type: integer 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' UnprocessableEntity: description: Campos obrigatórios ausentes ou inválidos 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 - [Campanha](/api-reference/campaigns/get.md) - [Desagendar campanha](/api-reference/campaigns/unschedule.md) - [Pausar campanha](/api-reference/campaigns/pause.md) - [Retomar campanha](/api-reference/campaigns/resume.md) - [Cancelar campanha](/api-reference/campaigns/cancel.md)