Para obter estatísticas sobre o total de wakes, administradores, fotos carregadas, etc. é necessário fazer uma solicitação HTTP GET contra a URL https://api.vivorecuerdo.es/v1/estadisticas (com um token válido no header Authorization).
A solicitação admite dois parâmetros opcionais, "início" e "fim" (onde "início" é a data de início a partir da qual as estatísticas devem ser obtidas e "fim" a data de término, ambos no formato aaaa-mm-dd). Por exemplo, para obter estatísticas de 1º de novembro de 2019 a 1º de maio de 2020:
Os parâmetros "start" e "end" são independentes um do outro, você pode usar apenas o parâmetro "start" ou apenas o parâmetro "end". No primeiro caso, a solicitação retornará as estatísticas desde a data definida no parâmetro "início" até a presente; no segundo, a solicitação retornará as estatísticas de quando você começou a trabalhar com o Vivo Recuerdo® até a data indicada no parâmetro "fim".
Um exemplo de solicitação cURL:
curl -X GET https://api.vivorecuerdo.es/v1/estadisticas -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJkZXNhcnJvbGxvIiwiaXNzIjoidml2b3JlY3VlcmRvIiwidHlwZSI6IkFVVEhFTlRJQ0FUSU9OIiwiaWF0IjoxNTY1MjY5MDkwLCJleHAiOjE1NjUyNzI2OTB9.mUwuoy6LJF8hI3v9w4hZPaLLqkFLSTani5tlKr8Q2_4OzcCGC-TSc8zNY7oVRT7bGiOdtr5QI7cPbaQdelhG-A'
Essa solicitação retornará um JSON no seguinte formato:
{
"velatorios": 92,
"fotos": 289,
"condolencias": 11,
"administradores": 101,
"usuarios": 20,
"velatorios_con_fotos": 28,
"porcentaje_interaccion": 30,
"velatorios_aptos_videolibro": 11,
"porcentaje_aptos_videolibro": 12,
"videolibros_generados": 8
}
Sendo "wakes" o número total * de wakes registrados na plataforma, "fotos" o número total * de fotos enviadas por administradores / usuários, "condolências" o número total * de mensagens de condolências escritas por administradores / usuários, "administradores" o número total * de administradores registrados na plataforma, "usuários" o número total * de usuários que interagiram com a plataforma, "wakes_with_photos" o número total * de wakes em que pelo menos uma fotografia foi carregada, "percent_interaction" o porcentagem † de wakes em que uma fotografia foi carregada em relação ao wakes total *, "wakes_aptos_videolibro" o número de wakes em que pelo menos 16 fotografias foram carregadas e das quais, portanto, poderia ser gerado um livro de vídeo, "percent_aptos_videolibro "a porcentagem † de wakes com pelo menos 16 fotografias em relação ao wakes total * e" video_generated ", o número total * de videol livros gerados.
* Falamos em "total" / "totais" tendo em conta o intervalo definido no pedido GET.
As porcentagens são exibidas como um número inteiro (sem%).