Obtener estadísticas del estado de las tareas de un inquilino.¶

Método¶

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

Descripción¶

Devuelve estadísticas de las tareas agregadas por estado durante un periodo determinado. El periodo no puede superar los 31 días y debe estar comprendido en los 35 días más recientes. El parámetro de ruta tenant_id especifica el inquilino cuyas estadísticas se obtendrán.

Parámetros de ruta¶

tenant_id string obligatorio

Identificador del inquilino cuyas estadísticas de tareas se obtendrán.

Parámetros de consulta¶

start_time date-time obligatorio

Inicio del periodo para obtener las estadísticas de tareas del inquilino. Especifique la marca de tiempo con precisión horaria para adaptar las estadísticas diarias a una zona horaria concreta. Los valores se redondean a la hora más cercana si quien realiza la llamada no los ha redondeado previamente. Utilice el formato de marca de tiempo RFC 3339.

end_time date-time obligatorio

Fin del periodo cuyas estadísticas se obtendrán.

curl

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
    }
  }
}