> ## 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. # Funil de um curso > Dos alunos com acesso ao curso, quantos concluíram cada módulo, cada aula e receberam o certificado. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/engagement/courses/{courseId} 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/courses/{courseId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/CourseId' get: tags: - clubs summary: Onde a turma de um curso para description: | O funil de um curso: dos alunos ativos com acesso a ele, quantos concluíram cada módulo e cada aula publicada, na ordem do curso, e quantos receberam o certificado quando o curso emite um. Concluir um módulo é ter concluído todas as aulas publicadas dele. É uma fotografia de agora, sem período. Exige administrar o club. operationId: getCourseFunnel responses: '200': description: O funil content: application/json: schema: $ref: '#/components/schemas/CourseFunnelResponse' '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 CourseId: name: courseId in: path required: true schema: type: string format: uuid schemas: CourseFunnelResponse: type: object required: - data properties: data: $ref: '#/components/schemas/CourseFunnel' CourseFunnel: type: object required: - course_id - title - students - modules properties: course_id: type: string format: uuid title: type: string students: description: Alunos ativos com acesso ao curso — a base das frações. type: integer modules: description: Os módulos com aula publicada, na ordem do curso. type: array items: $ref: '#/components/schemas/FunnelModule' certificates: description: | Certificados válidos (não revogados) de alunos ativos. Nulo quando o curso não emite certificado. type: integer nullable: true 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 FunnelModule: type: object required: - module_id - title - number - completed - lessons properties: module_id: type: string format: uuid title: type: string number: description: A posição do módulo no curso, contando de 1. type: integer completed: description: Alunos que concluíram todas as aulas publicadas do módulo. type: integer lessons: type: array items: $ref: '#/components/schemas/FunnelLesson' FunnelLesson: type: object required: - lesson_id - title - number - completed properties: lesson_id: type: string format: uuid title: type: string number: description: A posição da aula no curso, contando de 1. type: integer completed: description: Alunos que concluíram a aula. 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' 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 - [Cursos de um aluno](/api-reference/students/courses.md) - [Listar cursos](/api-reference/content/courses-list.md) - [Criar curso](/api-reference/content/courses-create.md) - [Reordenar o curso](/api-reference/content/course-structure.md) - [Ler curso](/api-reference/content/courses-get.md)