Dados de Progressão da Unidade
curl --request GET \
--url https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentageimport requests
url = "https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"current_page": 123,
"data": [
{
"user_id": 123,
"user_name": "<string>",
"user_email": "<string>",
"user_cpf": "<string>",
"course_name": "<string>",
"percentual_usage": 123,
"content_total": 123,
"percentual_progress": "<string>"
}
]
}
}Relatorios
Dados de Progressão da Unidade
Recupere os dados atualizados de progressão nos cursos de uma escola específica.
GET
/
api
/
reports
/
school
/
{school_id}
/
percentage
Dados de Progressão da Unidade
curl --request GET \
--url https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentageimport requests
url = "https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"current_page": 123,
"data": [
{
"user_id": 123,
"user_name": "<string>",
"user_email": "<string>",
"user_cpf": "<string>",
"course_name": "<string>",
"percentual_usage": 123,
"content_total": 123,
"percentual_progress": "<string>"
}
]
}
}Parâmetros
string
required
Identificador da escola no sistema.
string
Data inicial do intervalo da consulta.
string
Data final do intervalo da consulta.
boolean
Indica se a consulta deve considerar múltiplas instituições (valor esperado: “on”).
string
CPF do usuário a ser consultado.
string
E-mail do usuário a ser consultado.
string
Data de atualização dos dados.
Antes de utilizar este endpoint, certifique-se de possuir o seguinte parâmetro:
- school_id é
obrigatório: número identificador da unidade, que deverá ser passado na URL da requisição.
Segurança
Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.Descrição da Resposta
Abaixo está um exemplo da resposta retornada por este endpoint.object
Contém a lista paginada de usuários com estatísticas de progresso em cursos.
Show properties
Show properties
number
Página atual da listagem.
array
Lista de registros de usuários.
Show items
Show items
number
Identificador único do usuário.
string
Nome completo do usuário.
string
Endereço de e-mail do usuário.
string
CPF do usuário (pode estar vazio).
string
Nome do curso ao qual o progresso pertence.
number
Quantidade de conteúdos consumidos.
number
Total de conteúdos disponíveis no curso.
string
Progresso percentual do curso (ex: “95%”).