Get organization usage | Documentation

curl -G https://api.contentful.com/organizations/0D9ZC8rLWiw6x5qizZGiRs/organization_periodic_usages \
     -H "Authorization: Bearer <token>" \
     --data-urlencode metric="cma,cpa,gql" \
     --data-urlencode startAt="2020-01-01" \
     --data-urlencode endAt="2020-01-03" \
     --data-urlencode order="-usage"

{
  "sys": {
    "type": "Array"
  },
  "total": 100,
  "skip": 0,
  "limit": 25,
  "items": [
    {
      "sys": {
        "id": "<usage_metric_id>",
        "type": "OrganizationPeriodicUsage",
        "organization": {
          "sys": {
            "id": "0D9ZC8rLWiw6x5qizZGiRs",
            "type": "Link",
            "linkType": "Organization"
          }
        }
      },
      "unitOfMeasure": "apiRequestCount",
      "metric": "cma",
      "dateRange": {
        "startAt": "2020-01-01",
        "endAt": "2020-01-03"
      },
      "usage": 100,
      "usagePerDay": {
        "2020-01-01": 30,
        "2020-01-02": 30,
        "2020-01-03": 40
      }
    }
  ]
}

Query organization usage by metric for a given date range. If startAt and endAt are not passed through the query a historical data for the last 45 days will be returned by default.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organization_idstringRequired

Id of organization

Query parameters

metricstringOptional

Comma separated list of API types (cma,cda,cpa,gql)

startAtstringOptional

Date in yyyy-mm-dd format

endAtstringOptional

Date in yyyy-mm-dd format

orderstringOptional

Order by usage. Default value is "-usage" and describes a descending usage order.

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful