Saltar al contenido principal

Reporte de Puntaje de Calidad

Puntaje de calidad de finalización por grupo basado en los campos de formulario capturados, las fotos y la firma en las tareas finalizadas.

GET/apidev/v1/reports/gt/quality-score
PermisoAPICLI_RPTGT_QUALITYSCORE
Límite de tasa10 req/min
Caché300s
Rango máximo92 días

Resumen​

Puntúa qué tan completamente se documentó cada tarea finalizada y promedia ese puntaje por grupo. El puntaje de calidad combina tres componentes por tarea:

  • 40% — campos de formulario completados versus los campos esperados para el producto de la tarea.
  • 30% — al menos una foto adjunta.
  • 30% — una firma capturada.

Una tarea con todos los campos esperados completados, una foto y una firma obtiene 100. El reporte devuelve el puntaje promedio por grupo junto con la cantidad de soporte (tareas con fotos, tareas con firma, total de campos de formulario completados versus esperados), para que puedas ver qué componente está bajando el puntaje. Elegí cómo se agrupan las filas con group_by (por defecto es prestador).


Solicitud​

Encabezados de la solicitud​

Every request to a protected endpoint requires these headers:

HeaderRequiredDescription
AuthorizationYesBearer token obtained from the Login endpoint. Format: Bearer <token>
X-API-KeyYesCompany integration key provided during onboarding. Format: gtk_xxx...
tenantYesYour assigned tenant domain (default: geotareas.com) — always send your assigned tenant
Content-TypeConditionalapplication/json — required for POST and PUT requests

Parámetros de consulta​

ParámetroTipoRequeridoPor defectoDescripción
startdatestringSí—Fecha-hora de inicio en ISO 8601 (ej. 2026-03-01T00:00:00).
enddatestringSí—Fecha-hora de fin en ISO 8601. Rango máximo de 92 días desde startdate.
group_bystringNoproviderCómo se agrupan las filas. Uno de: provider, device, driver, cause, subcause, service_type, product, origin, shift, end_code, comm_media, route, country, department, city, zone, client, telephonist, operator, resource_type, date, month, weekday, hour.
devicesstringNo—IDs de dispositivos separados por coma. Máx 500.
driversstringNo—IDs de conductores separados por coma. Máx 500.
providersstringNo—IDs de prestadores separados por coma. Máx 100.
service_typesstringNo—IDs de tipos de servicio separados por coma. Máx 100.
causesstringNo—IDs de causas separados por coma. Máx 100.
subcausesstringNo—IDs de subcausas separados por coma. Máx 100.
statusesstringNo—Códigos de estado de tarea separados por coma. Máx 100.
device_groupsstringNoTodosIds de tipo de dispositivo separados por comas (el catálogo device_group que expone Flota / Dispositivos). Acota las tareas a los dispositivos de esos tipos; se combina con devices como intersección. Máximo 100
originsstringNo—IDs de orígenes separados por coma. Máx 100.
route_idsstringNo—IDs de rutas separados por coma. Máx 100.
operatorsstringNo—IDs de operadores separados por coma. Máx 100.
client_idstringNo—ID de un solo cliente.
account_idstringNo—ID de una sola cuenta.
shift_idstringNo—ID de un solo turno.
limitintegerNo25Cantidad de registros por página (1–100).
offsetintegerNo0Cantidad de registros a omitir para la paginación.
Cómo se combina device_groups con devices

device_groups se expande a todos los dispositivos de esos tipos, y si además mandás devices, se quedan solo los dispositivos que están en las dos listas. Si esa intersección queda vacía, el reporte no devuelve filas.


Ejemplos de código​

curl -s -H "Authorization: Bearer $TOKEN" \
-H "X-API-Key: $APIKEY" \
-H "tenant: $TENANT" \
"https://$TENANT/apidev/v1/reports/gt/quality-score?startdate=2026-03-01T00:00:00&enddate=2026-03-15T23:59:59&group_by=driver&limit=25"

Respuesta​

Campos de la respuesta​

CampoTipoDescripción
group_labelstringNombre visible del grupo (ej. conductor, dispositivo, prestador).
group_idstring | nullID interno del grupo, o null cuando no se puede resolver.
totalnumberTotal de tareas finalizadas en el grupo.
score_promedionumberPuntaje de calidad promedio (0–100) de las tareas del grupo.
con_fotosnumberTareas que tienen al menos una foto adjunta.
con_firmanumberTareas que tienen una firma capturada.
oav_completos_totalnumberTotal de campos de formulario completados en el grupo.
oav_esperados_totalnumberTotal de campos de formulario esperados para las tareas del grupo.

Ejemplo de respuesta​

{
"success": true,
"data": [
{
"group_label": "Carlos Martinez",
"group_id": "10293",
"total": 120,
"score_promedio": 87.34,
"con_fotos": 112,
"con_firma": 98,
"oav_completos_total": 540,
"oav_esperados_total": 600
}
],
"meta": {
"total": 1,
"limit": 25,
"offset": 0
}
}

Errores​

CódigoHTTPDescripción
VALIDATION_ERROR400Parámetros inválidos: fechas faltantes, rango > 92 días, valores de enum inválidos.
UNAUTHORIZED401tenant / Authorization / X-API-Key faltante, inválido o expirado
FORBIDDEN403El usuario no tiene el permiso requerido.
RATE_LIMITED429Se superó el límite de 10 req/min.
INTERNAL_ERROR500Error inesperado del servidor.