> For the complete documentation index, see [llms.txt](https://documentation.themembers.dev.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.themembers.dev.br/relatorios/relatorio-de-curso-depreciado.md).

# Relatório de Curso DEPRECIADO

#### Consumo do aluno sobre um curso

Filtro de aluno em cursos, onde recuperamos dados dos alunos no curso, data de primeiro e ultimo acesso e data de finalização do curso.

<mark style="color:$success;">`GET`</mark>`URL_BASE/partners/reports/courses/{token_do_desenvolvedor}/{token_da_plataforma}`

| Nome                  | Valor                                                                                               |
| --------------------- | --------------------------------------------------------------------------------------------------- |
| `limit`               | 1 até 500                                                                                           |
| `subscription_status` | `active`, `inactive`                                                                                |
| `accessed`            | `TRUE`, `FALSE`                                                                                     |
| `course_finished`     | `TRUE`, `FALSE`                                                                                     |
| `order_by[campo]`     | Chaves: `'user_name'`, `'course_name'`, `'course_created_at'`, `'created_at'`; Valor: `asc`, `desc` |
| `course_id`           | ID do curso                                                                                         |
| `user_id`             | ID do usuário                                                                                       |
| `course_started_at`   | Data/hora do primeiro acesso do aluno ao curso (formato: `Y-m-d H:i:s`)                             |

#### Exemplo de Resposta

```json
{
    "data": [
        {
            "id": "30cdedb8-a3aa-4ba9-9695-714c7f115e0d",
            "name": "Curso",
            "description": "Descrição do curso",
            "user_id": "e3b55d11-b568-40a2-87d1-2a67e5033619",
            "user_name": "John Doe",
            "user_email": "johndoe@example.com",
            "subscription_status": "active",
            "accessed": true,
            "last_access_at": "2025-09-01 17:31:10",
            "course_finished": false,
            "course_started_at": "2025-09-01 13:56:09",
            "course_finished_at": null,
            "updated_at": "2025-09-01 13:56:09"
        }
    ],
    "path": "http://registration.themembers.dev.br/api/partners/reports/courses/{token_do_desenvolvedor}/{token_da_plataforma}",
    "per_page": 500,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null
}
```

#### Quantidade de usuários no curso

Este endpoint permite recuperar a quantidade de alunos no curso.

<mark style="color:$success;">`GET`</mark>`URL_BASE/partners/reports/courses/user-count/{token_do_desenvolvedor}/{token_da_plataforma}`<br>

**Filtros Disponíveis**:

| Nome                  | Valor                                                                                               |
| --------------------- | --------------------------------------------------------------------------------------------------- |
| `limit`               | 1 até 500                                                                                           |
| `subscription_status` | `active`, `inactive`(contar somente usuários com este status de assinatura)                         |
| `accessed`            | `TRUE`, `FALSE` (contar somente usuários que acessaram)                                             |
| `course_finished`     | `TRUE`, `FALSE`(contar somente usuários que concluíram)                                             |
| `order_by[campo]`     | Chaves: `'user_name'`, `'course_name'`, `'course_created_at'`, `'created_at'`; Valor: `asc`, `desc` |
| `course_id`           | ID do curso (buscar quantos alunos um único curso possui)                                           |
| `user_id`             | ID do usuário (saber quais cursos o aluno tem em sua assinatura)                                    |

#### Exemplo de Resposta

```json
{
    "data": [
        {
            "id": "6754aabe-1d8e-4a12-9f5d-686c7e79e0b1",
            "name": "Teste TMS 4723",
            "description": "Teste TMS 4723",
            "created_at": "2025-01-17 08:26:40",
            "users_quantity": 38
        }
    ],
    "path": "http://registration.themembers.dev.br/api/partners/reports/courses/{token_do_desenvolvedor}/{token_da_plataforma}",
    "per_page": 500,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null
}
```