Skip to content

Task status statistics for a tenant

Method

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

Description

Returns task statistics aggregated by task status for a given time period. Period should be no longer than 31 days and have to be within the last 35 days. TenantID is used to specify the tenant for which statistics should be retrieved.

Path params
tenant_id string required

Tenant to fetch task statistics for.
Query params
start_time date-time required

Start time of the period for which one wants to retrieve the tenant tasks statistics. Should be specified with an hour granularity, which allows to get day statistics according to specific time zone. Would be rounded to the nearest hour if not already rounded by the caller. Date format should be specified in RFC3339 format.
end_time date-time required

End time of the period for which one wants to get the statistics.

 
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}
Successful response (200) schema
object

total object
object

done int32
failed int32
warnings int32
by_action map
object

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