Quota endpoint
- Topics:
- Data Hygiene
CREATED FOR:
- Developer
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.
Quota usage is tracked for each Data Lifecycle job type. Your actual quota limits depend on your organization’s entitlement and may be reviewed periodically. Dataset expirations are subject to a hard limit on the number of concurrently active jobs.
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
Quotas and processing timelines
Record delete requests are subject to quotas and service-level expectations based on your license entitlement. These limits apply to both UI- and API-based delete requests.
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}
Parameter | Description |
---|---|
{QUOTA_TYPE} |
An optional query parameter that specifies the type of quota to retrieve. If no
|
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": 1000000
},
{
"name": "monthlyConsumerDeleteIdentitiesQuota",
"description": "The consumed number of deleted identities in all workorder requests for the organization for this month.",
"consumed": 841,
"quota": 2000000
},
{
"name": "monthlyUpdatedFieldIdentitiesQuota",
"description": "The consumed number of updated identities in all workorder requests for the organization for this month.",
"consumed": 0,
"quota": 0
}
]
}
quotas
Lists 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.