Statistiken zum Aufgabenstatus eines Mandanten abrufen.¶

Methode¶

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

Beschreibung¶

Gibt Aufgabenstatistiken für einen bestimmten Zeitraum zurück, zusammengefasst nach Status. Der Zeitraum darf höchstens 31 Tage umfassen und muss innerhalb der letzten 35 Tage liegen. Der Pfadparameter tenant_id legt fest, für welchen Mandanten die Statistiken abgerufen werden.

Pfadparameter¶

tenant_id string erforderlich

ID des Mandanten, dessen Aufgabenstatistiken abgerufen werden.

Abfrageparameter¶

start_time date-time erforderlich

Beginn des Zeitraums für die Aufgabenstatistiken des Mandanten. Geben Sie den Zeitstempel mit Stundengenauigkeit an, um die Tagesstatistiken auf eine bestimmte Zeitzone abzustimmen. Falls der Aufrufer den Wert nicht bereits gerundet hat, wird er auf die nächstgelegene volle Stunde gerundet. Verwenden Sie das Zeitstempelformat RFC 3339.

end_time date-time erforderlich

Ende des Zeitraums für die Statistiken.

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}

Schema der erfolgreichen Antwort (200)¶

object

total object

object

done int32

failed int32

warnings int32

by_action map

object

done int32

failed int32

warnings int32

Antwortbeispiel¶

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