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 list
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}
{QUOTA_TYPE}An optional query parameter that specifies the type of quota to retrieve. If no quotaType parameter is provided, all quota values are returned in the API response. Accepted type values include:
datasetExpirationQuota: This object shows the number of concurrently active dataset expirations for your organization, and your total allowance of expirations.dailyConsumerDeleteIdentitiesQuota: This object shows the total number of record delete requests made by your organization today and your total daily allowance.
Note: Only accepted requests are counted. If a work order is rejected because it fails validation, those identity deletions do not count against your quota.monthlyConsumerDeleteIdentitiesQuota: This object shows the total number of record delete requests made by your organization this month and your total monthly allowance.monthlyUpdatedFieldIdentitiesQuota: This object shows the total number of record updates requests made by your organization this month and your total monthly allowance.
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
}
]
}
quotasLists the quota information for each data lifecycle job type. Each quota object contains the following properties:
-
name: The data lifecycle job type:expirationDatasetQuota: Dataset expirationsdeleteIdentityWorkOrderDatasetQuota: Record deletes
-
description: A description of the data lifecycle job type. -
consumed: The number of jobs of this type run in the current period. The object name indicates the quota period. -
quota: The allotment for this job type for your organization. For record deletions and updates, the quota represents the number of jobs that can be run for each monthly period. For dataset expirations, the quota represents the number of jobs that can be concurrently active at any given time.