Para obtener estadísticas acerca de velatorios totales, administradores, fotografías subidas, etc. es necesario realizar una petición HTTP GET contra la URL https://api.vivorecuerdo.es/v1/estadisticas (con un token válido en el header Authorization).
La petición admite dos parámetros opcionales, "inicio" y "fin" (siendo "inicio" la fecha de inicio desde la que se quieren obtener las estadísticas, y "fin" la fecha de fin, ambas en formato yyyy-MM-dd). Por ejemplo, para obtener las estadísticas desde el 1 de noviembre de 2019 hasta el 1 de mayo de 2020:
Los parámetros "inicio" y "fin" son independientes el uno del otro, se puede usar sólo el parámetro "inicio" o sólo el parámetro "fin". En el primer caso, la petición devolverá las estadísticas desde la fecha definida en el parámetro "inicio" hasta la actualidad, en el segundo, la petición devolverá las estadísticas desde que comenzasteis a trabajar con Vivo Recuerdo® hasta la fecha indicada en el parámetro "fin".
Un ejemplo de la petición con cURL:
curl -X GET https://api.vivorecuerdo.es/v1/estadisticas -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJkZXNhcnJvbGxvIiwiaXNzIjoidml2b3JlY3VlcmRvIiwidHlwZSI6IkFVVEhFTlRJQ0FUSU9OIiwiaWF0IjoxNTY1MjY5MDkwLCJleHAiOjE1NjUyNzI2OTB9.mUwuoy6LJF8hI3v9w4hZPaLLqkFLSTani5tlKr8Q2_4OzcCGC-TSc8zNY7oVRT7bGiOdtr5QI7cPbaQdelhG-A'
Esta petición devolverá un JSON con el siguiente 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
}
Siendo "velatorios" el número total* de velatorios registrados en la plataforma, "fotos" el número total* de fotografías subidas por los administradores/usuarios, "condolencias" el número total* de mensajes de condolencia escritos por los administradores/usuarios, "administradores" el número total* de administradores registrados en la plataforma, "usuarios" el número total* de usuarios que han interactuado con la plataforma, "velatorios_con_fotos" el número total* de velatorios en los que se ha subido al menos una fotografía, "porcentaje_interacción" el porcentaje† de velatorios en los que se ha subido alguna fotografía respecto a los velatorios totales*, "velatorios_aptos_videolibro" el número de velatorios en los que se han subido al menos 16 fotografías y de los que, por tanto, se podría generar un videolibro, "porcentaje_aptos_videolibro" el porcentaje† de velatorios con al menos 16 fotografías respecto a los velatorios totales* y "videolibros_generados", el número total* de videolibros generados.
*Se habla de "total"/"totales" teniendo en cuenta el intervalo definido en la petición GET.
†Los porcentajes se muestran como un número entero (sin %).