DocumentationExperience PlatformAdvanced Data Lifecycle Management Guide

Quota endpoint

Last update: Fri Oct 06 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User
  • Admin
  • Leader

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 required headers that are needed to successfully 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}
Parameter
Description
{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:

  • expirationDatasetQuota: Dataset expirations
  • deleteIdentityWorkOrderDatasetQuota: Record deletes
  • fieldUpdateWorkOrderDatasetQuota: Record updates

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": "expirationDatasetQuota",
      "description": "The number of concurrently active Expiration Dataset Delete Work Order requests for the organization.",
      "consumed": 3154,
      "quota": 10000
    },
    {
      "name": "deleteIdentityWorkOrderQuota",
      "description": "The number of Record Delete Work Order requests for the organization for this month.",
      "consumed": 390,
      "quota": 10000
    }
  ]
}
Property
Description
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 expirations
    • deleteIdentityWorkOrderDatasetQuota: Record deletes

  • description: A description of the data lifecycle job type.

  • consumed: The number of jobs of this type run in the current monthly period.

  • quota: The quota limit for this job type. For record deletes and updates, this represents the number of jobs that can be run for each monthly period. For dataset expirations, this represents the number of jobs that can be concurrently active at any given time.

recommendation-more-help
332f81c1-51e7-4bde-8327-2eb07f09604f