School Unit Progression Report

Endpoint used to retrieve updated course progression data for a specific school unit in Toolzz LMS.

Request Example

curl --request GET \
  --url 'https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage?startDate=2025-01-01&endDate=2025-12-31' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "data": {
    "current_page": 1,
    "data": [
      {
        "user_id": 1,
        "user_name": "<string>",
        "user_email": "<string>",
        "user_cpf": "<string>",
        "course_name": "<string>",
        "percentual_usage": 9,
        "content_total": 10,
        "percentual_progress": "95%"
      }
    ]
  }
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters (Path)

Parameter	Type	Description	Required
school_id	string	School identifier in the system.	Yes

URL Parameters (Query)

Parameter	Type	Description	Required
startDate	string	Start date of the query range.	No
endDate	string	End date of the query range.	No
multiInst	boolean	Indicates if the query should consider multiple institutions (expected value: “on”).	No
cpf	string	CPF of the user to be queried.	No
email	string	Email of the user to be queried.	No
updatedAt	string	Data update date.	No

---

Response description

Key	Type	Description
data	object	Contains the paginated list of users with course progress statistics.
data.current_page	number	Current page of the listing.
data.data	array	List of user records.
data.data.user_id	number	Unique identifier of the user.
data.data.user_name	string	Full name of the user.
data.data.user_email	string	Email address of the user.
data.data.user_cpf	string	CPF of the user (may be empty).
data.data.course_name	string	Name of the course to which the progress belongs.
data.data.percentual_usage	number	Number of content items consumed.
data.data.content_total	number	Total content items available in the course.
data.data.percentual_progress	string	Percentage progress of the course (e.g., “95%”).

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.