Aller au contenu

Obtenir les statistiques d’état des tâches d’un locataire.

Méthode

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

Description

Renvoie les statistiques des tâches agrégées par état de tâche pour une période donnée. La période ne doit pas dépasser 31 jours et doit se situer dans les 35 derniers jours. Le paramètre de chemin tenant_id indique le locataire dont les statistiques doivent être obtenues.

Paramètres de chemin
tenant_id string obligatoire

Identifiant du locataire dont les statistiques des tâches doivent être obtenues.

Paramètres de requête
start_time date-time obligatoire

Début de la période couverte par les statistiques des tâches du locataire. Indiquez l’horodatage avec une granularité horaire afin d’aligner les statistiques quotidiennes sur un fuseau horaire donné. Les valeurs sont arrondies à l’heure la plus proche si l’appelant ne les a pas déjà arrondies. Utilisez le format d’horodatage RFC 3339.
end_time date-time obligatoire

Fin de la période couverte par les statistiques.

 
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}

Schéma de la réponse réussie (200)
object

total object
object

done int32
failed int32
warnings int32
by_action map
object

done int32
failed int32
warnings int32

Exemple de réponse
{
  "total": {
    "done": 0,
    "failed": 0,
    "warnings": 0
  },
  "by_action": {
    "key1": {
      "done": 0,
      "failed": 0,
      "warnings": 0
    },
    "keyN": {
      "done": 0,
      "failed": 0,
      "warnings": 0
    }
  }
}