Aller au contenu

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

Méthode

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

Description

Renvoie les statistiques des tâches pour une période donnée, regroupées par état. 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 désigne le locataire dont les statistiques sont demandées.

Paramètres de chemin
tenant_id string obligatoire

Identifiant du locataire.

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 un horodatage à l’heure près pour aligner les statistiques quotidiennes sur un fuseau horaire donné. Si l’appelant ne l’a pas déjà fait, l’horodatage est arrondi à l’heure la plus proche. Utilisez le format 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 en cas de succès (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
    }
  }
}