Skip to content

Commit

Permalink
feat: add missing reports params
Browse files Browse the repository at this point in the history
  • Loading branch information
@EvertonMJunior
EvertonMJunior committed Jan 21, 2025
1 parent 741e965 commit 723514c
Showing 1 changed file with 144 additions and 153 deletions.
297 changes: 144 additions & 153 deletions docs/reports.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,12 @@ POST /reports/bookings

#### Parameters

| Parameter | Location | Type | Description | Required |
| -------------- | -------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| **start_date** | Body | Milliseconds since epoch | The date to start the report data in milliseconds since UNIX Epoch. For scheduled meetings, considers the date the booking is scheduled for. | Yes |
| **end_date** | Body | Milliseconds since epoch | The date to end the report data in milliseconds since UNIX Epoch. For scheduled meetings, considers the date the booking is scheduled for. | Yes |
| **school_ids** | Body | string[] | List of the school ids you want to generate the report about. If not specified, it will bring data about all schools you have access to. | No |
| **Accept** | Header | Mime type | The format you want the report to be in. Supported values are `application/json` and `text/csv`. It defaults to `application/json`. In CSV mode, column names will be in Portuguese. | No |
| Parameter | Location | Type | Description | Required |
| -------------- | -------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
| **start_date** | Body | Milliseconds since epoch | The date to start the report data in milliseconds since UNIX Epoch. For scheduled meetings, considers the date the booking is scheduled for. | Yes |
| **end_date** | Body | Milliseconds since epoch | The date to end the report data in milliseconds since UNIX Epoch. For scheduled meetings, considers the date the booking is scheduled for. | Yes |
| **school_ids** | Body | string[] | List of the school ids you want to generate the report about. If not specified, it will bring data about all schools you have access to. | No |
| **Accept** | Header | Mime type | The format you want the report to be in. Supported values are `application/json` and `text/csv`. It defaults to `application/json`. In CSV mode, column names will be in Portuguese. | No |

### Response

Expand All @@ -91,48 +91,47 @@ POST /reports/bookings
| 200 | The report was generated succesfully. |
| 401 | Unauthorized. |


#### Booking Status (Status field)

| Status | Description |
| -------- | ----------- |
| PRESENT | Meeting exists and has at least started. |
| NO_SHOW | Scheduled meeting has passed, no meeting exists. |
| Status | Description |
| ----------------------- | ------------------------------------------------------------------------------------------------ |
| PRESENT | Meeting exists and has at least started. |
| NO_SHOW | Scheduled meeting has passed, no meeting exists. |
| OUTSIDE_SCHEDULE_CANCEL | The student cancelled the booking later than the minimum hours to cancel without losing credits. |
| INSIDE_SCHEDULE_CANCEL | The student cancelled the booking within the minimum hours to cancel without losing credits. |
| CANCELLED | The booking was cancelled by someone else (teacher, group admin). |
| PENDING | The booking is scheduled to happen. |
| QUEUE | The booking is in the queue. |
| LEFT_QUEUE | The student left the queue without joining a meeting. |
| NOT_REALIZED | The student joined the queue and the meeting was not held, or the user is still in the queue. |
| INSIDE_SCHEDULE_CANCEL | The student cancelled the booking within the minimum hours to cancel without losing credits. |
| CANCELLED | The booking was cancelled by someone else (teacher, group admin). |
| PENDING | The booking is scheduled to happen. |
| QUEUE | The booking is in the queue. |
| LEFT_QUEUE | The student left the queue without joining a meeting. |
| NOT_REALIZED | The student joined the queue and the meeting was not held, or the user is still in the queue. |

#### Example

```json
[
{
"id": "a300c187-5883-41dd-a7dc-03d4ebdd5a4d",
"school_name": "School",
"created_at": "15/10/2024 15:41",
"scheduled_for": "17/10/2024 17:00",
"start_time": "",
"end_time": "",
"duration": "",
"student_external_id": "123456",
"student_name": "Student Name",
"student_email": "[email protected]",
"teacher_name": "Teacher Name",
"teacher_email": "[email protected]",
"group_name": "Group Name",
"discipline_name": "Discipline Name",
"booking_room_name": "Booking Room Name",
"booking_room_modal": "Online",
"rating_by_student": 4.9,
"rating_by_teacher": "",
"status": "Pendente",
"cancelled_at": "",
"cancelled_by_name": ""
}
{
"id": "a300c187-5883-41dd-a7dc-03d4ebdd5a4d",
"school_name": "School",
"created_at": "15/10/2024 15:41",
"scheduled_for": "17/10/2024 17:00",
"start_time": "",
"end_time": "",
"duration": "",
"student_external_id": "123456",
"student_name": "Student Name",
"student_email": "[email protected]",
"teacher_name": "Teacher Name",
"teacher_email": "[email protected]",
"group_name": "Group Name",
"discipline_name": "Discipline Name",
"booking_room_name": "Booking Room Name",
"booking_room_modal": "Online",
"rating_by_student": 4.9,
"rating_by_teacher": "",
"status": "Pendente",
"cancelled_at": "",
"cancelled_by_name": ""
}
]
```

Expand All @@ -148,10 +147,10 @@ POST /reports/bookings-workload

#### Parameters

| Parameter | Location | Type | Description | Required |
| -------------- | -------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| **school_ids** | Body | string[] | List of the school ids you want to generate the report about. If not specified, it will bring data about all schools you have access to. | No |
| **Accept** | Header | Mime type | The format you want the report to be in. Supported values are `application/json` and `text/csv`. It defaults to `application/json`. In CSV mode, column names will be in Portuguese. | No |
| Parameter | Location | Type | Description | Required |
| -------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
| **school_ids** | Body | string[] | List of the school ids you want to generate the report about. If not specified, it will bring data about all schools you have access to. | No |
| **Accept** | Header | Mime type | The format you want the report to be in. Supported values are `application/json` and `text/csv`. It defaults to `application/json`. In CSV mode, column names will be in Portuguese. | No |

### Response

Expand All @@ -166,16 +165,15 @@ POST /reports/bookings-workload

```json
[
{
"teacher_name": "Teacher Name",
"teacher_email": "[email protected]",
"weekly_minutes": 60,
"discipline_name": "Discipline Name"
},
{
"teacher_name": "Teacher Name",
"teacher_email": "[email protected]",
"weekly_minutes": 60,
"discipline_name": "Discipline Name"
}
]
```


## Groups Usage Report

To generate a Groups Usage report, send the following `POST` request:
Expand All @@ -188,122 +186,115 @@ POST /reports/groups-usage

#### Parameters

| Parameter | Location | Type | Description | Required |
| -------------- | -------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| **name** | Body | string | The name of the report being generated. | Yes |
| **start_date** | Body | Milliseconds since epoch | The date to start the report data in milliseconds since UNIX Epoch. | Yes |
| **end_date** | Body | Milliseconds since epoch | The date to end the report data in milliseconds since UNIX Epoch. | Yes |
| **group_ids** | Body | string[] | List of the group ids you want to generate the report about. | Yes |
| **Accept** | Header | Mime type | The format you want the report to be in. Supported values are `application/json`, `text/csv`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, and `*/*`. It defaults to `application/json`. | Yes |
| Parameter | Location | Type | Description | Required |
| -------------------- | -------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| **start_date** | Body | Milliseconds since epoch | The date to start the report data in milliseconds since UNIX Epoch. | Yes |
| **end_date** | Body | Milliseconds since epoch | The date to end the report data in milliseconds since UNIX Epoch. | Yes |
| **group_ids** | Body | string[] | List of the group ids you want to generate the report about. | Yes |
| **name** | Body | string | The name of the report being generated. | No |
| **show_disciplines** | Body | boolean | Whether to show the disciplines data in the report. It defaults to `false`. | No |
| **show_teachers** | Body | boolean | Whether to show the teachers data in the report. It defaults to `false`. | No |
| **Accept** | Header | Mime type | The format you want the report to be in. Supported values are `application/json` (json), `text/csv` (csv), and `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (xlsx). It defaults to `application/json`. | No |

### Response

#### Status

| Code | Description |
| ---- | ------------------------------------- |
| Code | Description |
| ---- | -------------------------------------- |
| 200 | The report was generated successfully. |
| 401 | Unauthorized. |
| 401 | Unauthorized. |

#### Example Response

```json
{
"start_date": "01/01/2024",
"end_date": "04/12/2024",
"total_questions": 41,
"average_adjusted_response_time_in_minutes": 43615.19,
"questions_count_by_discipline": {
"Matemática": 41
},
"active_users_percentage": 1,
"average_answer_rating": null,
"average_nps": null,
"average_response_time_nps": null,
"nps_answers": [],
"answer_ratings": [],
"students": [
{
"name": "Aluno Teste",
"groups": [
"Turma de Testes"
],
"email": "[email protected]",
"active": true,
"created_at": "2023-04-26",
"blocked_at": null,
"deleted_at": null,
"questions_count": 41,
"questions": [
{
"discipline": {
"id": 1,
"name": "Matemática"
},
"subject": {
"id": 1,
"name": "Álgebra"
}
},
{
"discipline": {
"id": 1,
"name": "Matemática"
},
"subject": {
"id": 1,
"name": "Álgebra"
}
}
]
}
],
"teachers": [
"start_date": "01/01/2024",
"end_date": "04/12/2024",
"total_questions": 41,
"average_adjusted_response_time_in_minutes": 43615.19,
"questions_count_by_discipline": {
"Matemática": 41
},
"active_users_percentage": 1,
"average_answer_rating": null,
"average_nps": null,
"average_response_time_nps": null,
"nps_answers": [],
"answer_ratings": [],
"students": [
{
"name": "Aluno Teste",
"groups": ["Turma de Testes"],
"email": "[email protected]",
"active": true,
"created_at": "2023-04-26",
"blocked_at": null,
"deleted_at": null,
"questions_count": 41,
"questions": [
{
"first_name": "Professor",
"last_name": "Teste",
"email": "[email protected]",
"groups": [
"Turma de Testes"
],
"disciplines": [
"Matemática"
],
"active": true,
"answered_questions_count": 3,
"average_response_time_in_minutes": 43615.19,
"created_at": "2023-04-26",
"blocked_at": null,
"deleted_at": null
"discipline": {
"id": 1,
"name": "Matemática"
},
"subject": {
"id": 1,
"name": "Álgebra"
}
},
{
"first_name": "Prof Luccas",
"last_name": "Santos",
"email": "[email protected]",
"groups": [
"Turma de Testes"
],
"disciplines": [],
"active": false,
"answered_questions_count": 0,
"average_response_time_in_minutes": null,
"created_at": "2024-06-03",
"blocked_at": null,
"deleted_at": null
}
],
"disciplines": [
{
"name": "Matemática",
"top_subjects": {
"Álgebra": 38,
"Aritmética": 2,
"Análise combinatória": 1
},
"total_questions": 41,
"average_response_time_in_minutes": 3191.36
"discipline": {
"id": 1,
"name": "Matemática"
},
"subject": {
"id": 1,
"name": "Álgebra"
}
}
]
]
}
],
"teachers": [
{
"first_name": "Professor",
"last_name": "Teste",
"email": "[email protected]",
"groups": ["Turma de Testes"],
"disciplines": ["Matemática"],
"active": true,
"answered_questions_count": 3,
"average_response_time_in_minutes": 43615.19,
"created_at": "2023-04-26",
"blocked_at": null,
"deleted_at": null
},
{
"first_name": "Prof Luccas",
"last_name": "Santos",
"email": "[email protected]",
"groups": ["Turma de Testes"],
"disciplines": [],
"active": false,
"answered_questions_count": 0,
"average_response_time_in_minutes": null,
"created_at": "2024-06-03",
"blocked_at": null,
"deleted_at": null
}
],
"disciplines": [
{
"name": "Matemática",
"top_subjects": {
"Álgebra": 38,
"Aritmética": 2,
"Análise combinatória": 1
},
"total_questions": 41,
"average_response_time_in_minutes": 3191.36
}
]
}
```

0 comments on commit 723514c

Please sign in to comment.