Skip to content

Resources protection statistics

Method

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

Description

Retrieves protection statistics for resources in a given tenant grouped by resource kind.

Path params
tenant_id string required

Tenant for which one wants to get resource statistics for.

curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{tenant_id}/resources/statistics/summary

Successful response (200) schema
object

tenants array of objects
object

tenant_id string

Tenant where the resource belongs to.

kind string

Tenant kind: gsuite for Google Workspace, o365 for Microsoft 365 etc.

name string

Tenant name.

resource_details array of objects

Detailed resource statistics for the tenant aggregated per resource kind.

object

kind string

Resource kind.

count int32

Count of resources with the given kind.

protected_count int32

Count of protected resources with the given kind.

resources_total object

Aggregated information about all tenant resources.

object

count int32

Total count of resources.

protected_count int32

Total count of protected resources.

size_total int64

Total resource storage in KB.

Response example
{
  "tenants": [
    {
      "tenant_id": "string",
      "kind": "string",
      "name": "string",
      "resource_details": [
        {
          "kind": "string",
          "count": 0,
          "protected_count": 0
        }
      ],
      "resources_total": {
        "count": 0,
        "protected_count": 0,
        "size_total": "int64-as-string"
      }
    }
  ]
}