Saltar a contenido

Obtener estadísticas de tareas por estado para un inquilino.

Método

GET https://papi.afi.ai/api/v1/tenants/{tenant_id}/tasks/statistics/summary

Descripción

Devuelve las estadísticas de tareas agrupadas por estado para un periodo determinado. El periodo no puede superar los 31 días y debe estar comprendido en los últimos 35 días. El parámetro de ruta tenant_id indica de qué inquilino se consultan las estadísticas.

Parámetros de ruta
tenant_id string obligatorio

ID del inquilino cuyas estadísticas de tareas se van a consultar.

Parámetros de consulta
start_time date-time obligatorio

Inicio del periodo de consulta de las estadísticas de tareas del inquilino. Indique la marca de tiempo con precisión de horas para que las estadísticas diarias se ajusten a una zona horaria concreta. Si el cliente no ha redondeado el valor, se redondea a la hora más cercana. Utilice el formato RFC 3339.

end_time date-time obligatorio

Fin del periodo de consulta de las estadísticas.

curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{tenant_id}/tasks/statistics/summary?start_time={value}&end_time={value}

Esquema de respuesta correcta (200)
object

total object
object

done int32
failed int32
warnings int32
by_action map
object

done int32
failed int32
warnings int32

Ejemplo de respuesta
{
  "total": {
    "done": 0,
    "failed": 0,
    "warnings": 0
  },
  "by_action": {
    "key1": {
      "done": 0,
      "failed": 0,
      "warnings": 0
    },
    "keyN": {
      "done": 0,
      "failed": 0,
      "warnings": 0
    }
  }
}