Aufgabenstatusstatistiken für einen Mandanten abrufen.¶

Methode¶

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

Beschreibung¶

Gibt nach Aufgabenstatus aggregierte Aufgabenstatistiken für einen bestimmten Zeitraum zurück. Der Zeitraum darf höchstens 31 Tage umfassen und muss innerhalb der letzten 35 Tage liegen. Der Pfadparameter tenant_id gibt an, für welchen Mandanten Statistiken abgerufen werden.

Pfadparameter¶

tenant_id string erforderlich

ID des Mandanten, dessen Aufgabenstatistiken abgerufen werden sollen.

Abfrageparameter¶

start_time date-time erforderlich

Beginn des Zeitraums zum Abrufen der Aufgabenstatistiken des Mandanten. Geben Sie den Zeitstempel stundengenau an, um Tagesstatistiken an einer bestimmten Zeitzone auszurichten. Werte werden auf die nächste Stunde gerundet, sofern dies nicht bereits durch den Aufrufer erfolgt ist. Verwenden Sie das RFC-3339-Zeitstempelformat.

end_time date-time erforderlich

Ende des Zeitraums zum Abrufen der 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
    }
  }
}