Quota endpoint

The /quota endpoint in the Data Hygiene API allows you to monitor your Advanced Data Lifecycle Management usage against your organization’s quota limits for each job type.

Quotas are enforced for each Data Lifecycle job type in the following ways:

• Record deletes and updates are limited to a certain number of requests each month.
• Dataset expirations have a flat limit for the number of concurrently active jobs, regardless of when the expirations will be executed.

Getting started

The endpoint used in this guide is part of the Data Hygiene API. Before continuing, please review the overview for the following information:

• Links to related documentation
• A guide to reading the sample API calls in this document
• Important information regarding the required headers that are needed to make calls to any Experience Platform API

List quotas

You can view your organization’s quota information by making a GET request to the /quota endpoint.

API format

GET /quota
GET /quota?quotaType={QUOTA_TYPE}

Request

curl -X GET \
  https://platform.adobe.io/data/core/hygiene/quota \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json'

Response

A successful response returns the details of your data lifecycle quotas.

{
  "quotas": [
    {
      "name": "datasetExpirationQuota",
      "description": "The number of concurrently active Expiration Dataset Delete in all workorder requests for the organization.",
      "consumed": 12,
      "quota": 50
    },
    {
      "name": "dailyConsumerDeleteIdentitiesQuota",
      "description": "The consumed number of deleted identities in all workorder requests for the organization for today.",
      "consumed": 0,
      "quota": 600000
    },
    {
      "name": "monthlyConsumerDeleteIdentitiesQuota",
      "description": "The consumed number of deleted identities in all workorder requests for the organization for this month.",
      "consumed": 841,
      "quota": 600000
    },
    {
      "name": "monthlyUpdatedFieldIdentitiesQuota",
      "description": "The consumed number of updated identities in all workorder requests for the organization for this month.",
      "consumed": 0,
      "quota": 0
    }
  ]
}