ONonetrust
Bulk Export

Get Bulk Export Credit Details

Use this API to retrieve bulk export credit details for the account. The response will include the total number of credits available for the account along with the number of credits remaining and the number of credits used.

🗒 Things to Know

  • Each account is limited to 20 bulk exports per month. If you cancel a bulk export before it completes, it will not be counted towards this limit. Please contact OneTrust Support or your Customer Success Manager (CSM) to increase your export limit.
get/api/ot-insights/v1/bulk-export-jobs/credits

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/ot-insights/v1/bulk-export-jobs/credits
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: BULK_EXPORT

Response

OK

totalCreditsinteger

The total number of credits available for the account.

creditsRemaininginteger

The number of credits remaining for the account.

creditsUsedinteger

The number of credits used for the account.

Example response

{
  "totalCredits": 6,
  "creditsRemaining": 5,
  "creditsUsed": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.