Get organization usage

GET

https://api.contentful.com/organizations/:organization_id/organization_periodic_usages

GET

/organizations/:organization_id/organization_periodic_usages

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

200Usage_getOrganizationUsage_example

1 {
2   "items": [
3     {
4       "dateRange": {
5         "endAt": "2020-01-03",
6         "startAt": "2020-01-01"
7       },
8       "metric": "cma",
9       "sys": {
10         "id": "<usage_metric_id>",
11         "organization": {
12           "sys": {
13             "id": "0D9ZC8rLWiw6x5qizZGiRs",
14             "linkType": "Organization",
15             "type": "Link"
16           }
17         },
18         "type": "OrganizationPeriodicUsage"
19       },
20       "unitOfMeasure": "apiRequestCount",
21       "usage": 100,
22       "usagePerDay": {
23         "2020-01-01": 30,
24         "2020-01-02": 30,
25         "2020-01-03": 40
26       }
27     }
28   ],
29   "limit": 25,
30   "skip": 0,
31   "sys": {
32     "type": "Array"
33   },
34   "total": 100
35 }

Deprecated. Sunset: 2027-02-28. Use Get aggregated usage instead. See the Usage migration guide for a full mapping of parameters and response shapes.

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.

<Info>**Deprecated. Sunset: 2027-02-28.** Use [Get aggregated usage](/references/content-management-api/usage/get-usage-aggregated) instead. See the [Usage migration guide](/references/content-management-api/usage-migration-guide) for a full mapping of parameters and response shapes.</Info> 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-TypestringOptional

Content-Type

Response

OK - Request successful