AEM Data Service API (2024.11-experimental)

Download OpenAPI specification:Download

Statistic

Statistic API

AEM Entitlements

Retrieve the entitlement information, including both used and available entitlements.

SecurityBearer and ApiKeyAuth
Request
query Parameters
imsOrgId
required
string (ImsOrgId) non-empty

This represents the Adobe IMS Organization ID assigned to then tenant.

Example: imsOrgId=0123456789ABCDEF0123456789ABCDEF@AdobeOrg
header Parameters
X-Adobe-Accept-Experimental
required
integer
Value: 1
x-gw-ims-org-id
required
string non-empty

x-gw-ims-org-id header will be used for authentication and authorization. This represents the Adobe IMS Organization ID assigned to the tenant.

Example: 0123456789ABCDEF0123456789ABCDEF@AdobeOrg
Responses
200

OK

400

Bad Request. The Problem Details object will provide more information about the exact cause.

403

Forbidden

404

Not Found

429

Too Many Requests

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

503

The service is temporarily unavailable. Please try again later.

get/statistics/entitlements
Request samples 
Response samples 
application/json
{
  • "filters": {
    },
  • "data": {
    }
}
AEM Sites Content Requests Quota
Retrieves the contractual limits for AEM Sites Content Requests, helping customers understand their compliant contractual limit.


SecurityBearer and ApiKeyAuth 
Request 
query Parameters
imsOrgId
required
string (ImsOrgId)   non-empty 
This represents the Adobe IMS Organization ID assigned to then tenant.


 
 Example:  imsOrgId=0123456789ABCDEF0123456789ABCDEF@AdobeOrg
current
boolean
 Default:  true
Get the quota valid as of today


 
header Parameters
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
x-gw-ims-org-id
required
string  non-empty 
x-gw-ims-org-id header will be used for authentication and authorization. This represents the Adobe IMS Organization ID assigned to the tenant.


 
 Example:  0123456789ABCDEF0123456789ABCDEF@AdobeOrg
Responses 
200
OK


400
Bad Request. The Problem Details object will provide more information about the exact cause.


403
Forbidden


404
Not Found


429
Too Many Requests


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


503
The service is temporarily unavailable. Please try again later.


get/statistics/contentRequestsQuota
Request samples 
Response samples 
application/json
{
  • "filters": {
    },
  • "data": {
    }
}
AEM Sites Content Requests Usage
Retrieve AEM Sites Content Requests Usage Statistics that can be filtered at Program level (monthly or daily).


SecurityBearer and ApiKeyAuth 
Request 
query Parameters
imsOrgId
required
string (ImsOrgId)   non-empty 
This represents the Adobe IMS Organization ID assigned to then tenant.


 
 Example:  imsOrgId=0123456789ABCDEF0123456789ABCDEF@AdobeOrg
programId
integer <int64>  (ProgramId) 
Cloud Manager Program ID


 
 Example:  programId=123456
startDate
string <date-time>  (StartDateTime) 
Start Date


 
 Example:  startDate=2022-07-21T17:32:28Z
endDate
string <date-time>  (EndDateTime) 
End Date


 
 Example:  endDate=2022-07-21T17:32:28Z
timeUnit
required
string (timeUnit) 
Time Unit


 Enum: "DAILY" "MONTHLY"  
 Example:  timeUnit=DAILY
header Parameters
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
x-gw-ims-org-id
required
string  non-empty 
x-gw-ims-org-id header will be used for authentication and authorization. This represents the Adobe IMS Organization ID assigned to the tenant.


 
 Example:  0123456789ABCDEF0123456789ABCDEF@AdobeOrg
Responses 
200
OK


400
Bad Request. The Problem Details object will provide more information about the exact cause.


403
Forbidden


404
Not Found


429
Too Many Requests


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


503
The service is temporarily unavailable. Please try again later.


get/statistics/contentRequestsUsage
Request samples 
Response samples 
application/json
{
  • "filters": {
    },
  • "data": {
    }
}
Reports
Reports API


Get all reports for the given repository
Get all async reports created for a given repository and limit the number of results based on permissible pagination limits.


SecurityBearer and ApiKeyAuth 
Request 
query Parameters
repositoryId
required
string  non-empty 
The repository ID for the request.


 
 Example:  repositoryId=author-p123456-e123456.adobeaemcloud.com
reportType
string (ReportType) 
Pass the reportType to filter the list reports by Report Type.


 Enum: "assetDownload" "assetUpload" "assetSmartTags" "assetLinkShare"  
 Example:  reportType=assetDownload
limit
integer <int32>   <= 50 
 Default:  10
 
cursor
string (Cursor)   non-empty 
For a paginated request, this parameter defines the cursor from which to retrieve the next set of items.


 
header Parameters
x-gw-ims-org-id
required
string  non-empty 
x-gw-ims-org-id header will be used for authentication and authorization. This represents the Adobe IMS Organization ID assigned to the tenant.


 
 Example:  0123456789ABCDEF0123456789ABCDEF@AdobeOrg
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Responses 
200
OK


400
Bad Request. The Problem Details object will provide more information about the exact cause.


403
Forbidden


404
Not Found


429
Too Many Requests


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


503
The service is temporarily unavailable. Please try again later.


get/reports
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "cursor": "string"
}
Create a report in the given repository
Asynchronously Create a report for the given repository with the given query criteria.


SecurityBearer and ApiKeyAuth 
Request 
query Parameters
repositoryId
required
string  non-empty 
The repository ID for the request.


 
 Example:  repositoryId=author-p123456-e123456.adobeaemcloud.com
header Parameters
x-gw-ims-org-id
required
string  non-empty 
x-gw-ims-org-id header will be used for authentication and authorization. This represents the Adobe IMS Organization ID assigned to the tenant.


 
 Example:  0123456789ABCDEF0123456789ABCDEF@AdobeOrg
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Request Body schema: application/json
required
Array of AssetDownloadReportColumns (strings) or Array of AssetUploadReportColumns (strings) or Array of AssetSmartTagsReportColumns (strings) or Array of AssetLinkShareReportColumns (strings) (ReportColumns) 
The columns to be included in the report. The columns are specific to the report type.


 
customColumns
Array of strings (ReportCustomColumns)   unique 
List of custom asset metadata columns to be included in the report


 
creator
string (ReportCreator) 
Creator of the report


 
description
string (ReportDescription) 
Description of the report


 
title
string (ReportTitle) 
Title of the report


 
reportType
string (ReportType) 
Type of the report


 Enum: "assetDownload" "assetUpload" "assetSmartTags" "assetLinkShare"  
AssetDownloadReportFilter (object) or AssetUploadReportFilter (object) or AssetSmartTagsReportFilter (object) or AssetLinkShareReportFilter (object) (ReportFilter) 
Report Request with all metadata and filter properties. Report Filters are specific to the report type.


 
Responses 
202
Accepted


400
Bad Request. The Problem Details object will provide more information about the exact cause.


403
Forbidden


404
Not Found


429
Too Many Requests


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


503
The service is temporarily unavailable. Please try again later.


post/reports
Request samples 
application/json
{
  • "columns": [
    ],
  • "customColumns": [
    ],
  • "creator": "johndoe@adobe.com",
  • "description": "Report for assets uploaded in the last 30 days",
  • "title": "DownloadReportLast30days",
  • "reportType": "assetDownload",
  • "filters": {
    }
}
Response samples 
application/json
{
  • "columns": [
    ],
  • "customColumns": [
    ],
  • "creator": "johndoe@adobe.com",
  • "description": "Report for assets uploaded in the last 30 days",
  • "id": "c7c15fc9-0628-447e-8e1b-fcbc1c207a0e",
  • "status": "completed",
  • "statusMessage": "Report failed to generate due to large volume of data",
  • "title": "DownloadReportLast30days",
  • "reportType": "assetDownload",
  • "filters": {
    },
  • "completedDate": "2022-09-13T16:49:04.133Z",
  • "createdDate": "2022-09-13T16:48:54.133Z"
}
Get a report based on reportId
Get a report based on reportId and the response would be the same irrespective of the report type.


SecurityBearer and ApiKeyAuth 
Request 
path Parameters
reportId
required
string (ReportId)   non-empty 
Id of the report


 
 Example:  c7c15fc9-0628-447e-8e1b-fcbc1c207a0e
query Parameters
repositoryId
required
string  non-empty 
The repository ID for the request.


 
 Example:  repositoryId=author-p123456-e123456.adobeaemcloud.com
header Parameters
x-gw-ims-org-id
required
string  non-empty 
x-gw-ims-org-id header will be used for authentication and authorization. This represents the Adobe IMS Organization ID assigned to the tenant.


 
 Example:  0123456789ABCDEF0123456789ABCDEF@AdobeOrg
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Responses 
200
OK


400
Bad Request. The Problem Details object will provide more information about the exact cause.


403
Forbidden


404
Not Found


429
Too Many Requests


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


503
The service is temporarily unavailable. Please try again later.


get/reports/{reportId}
Request samples 
Response samples 
application/json
{
  • "columns": [
    ],
  • "customColumns": [
    ],
  • "creator": "johndoe@adobe.com",
  • "description": "Report for assets uploaded in the last 30 days",
  • "id": "c7c15fc9-0628-447e-8e1b-fcbc1c207a0e",
  • "status": "completed",
  • "statusMessage": "Report failed to generate due to large volume of data",
  • "title": "DownloadReportLast30days",
  • "reportType": "assetDownload",
  • "filters": {
    },
  • "completedDate": "2022-09-13T16:49:04.133Z",
  • "createdDate": "2022-09-13T16:48:54.133Z"
}
Delete a report by reportId
Delete the report for a given reportId in a repository.


SecurityBearer and ApiKeyAuth 
Request 
path Parameters
reportId
required
string (ReportId)   non-empty 
Id of the report


 
 Example:  c7c15fc9-0628-447e-8e1b-fcbc1c207a0e
query Parameters
repositoryId
required
string  non-empty 
The repository ID for the request.


 
 Example:  repositoryId=author-p123456-e123456.adobeaemcloud.com
header Parameters
x-gw-ims-org-id
required
string  non-empty 
x-gw-ims-org-id header will be used for authentication and authorization. This represents the Adobe IMS Organization ID assigned to the tenant.


 
 Example:  0123456789ABCDEF0123456789ABCDEF@AdobeOrg
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Responses 
204
deleted


400
Bad Request. The Problem Details object will provide more information about the exact cause.


403
Forbidden


404
Not Found


429
Too Many Requests


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


503
The service is temporarily unavailable. Please try again later.


delete/reports/{reportId}
Request samples 
Response samples 
text/html
Get a download URL link to CSV report by reportId
Generates download URL for given reportId and returns the generated URL as a JSON response.


SecurityBearer and ApiKeyAuth 
Request 
path Parameters
reportId
required
string (ReportId)   non-empty 
Id of the report


 
 Example:  c7c15fc9-0628-447e-8e1b-fcbc1c207a0e
query Parameters
repositoryId
required
string  non-empty 
The repository ID for the request.


 
 Example:  repositoryId=author-p123456-e123456.adobeaemcloud.com
header Parameters
x-gw-ims-org-id
required
string  non-empty 
x-gw-ims-org-id header will be used for authentication and authorization. This represents the Adobe IMS Organization ID assigned to the tenant.


 
 Example:  0123456789ABCDEF0123456789ABCDEF@AdobeOrg
X-Adobe-Accept-Experimental
required
integer
 Value: 1  
Responses 
200
OK


400
Bad Request. The Problem Details object will provide more information about the exact cause.


403
Forbidden


404
Not Found


429
Too Many Requests


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


503
The service is temporarily unavailable. Please try again later.


get/reports/{reportId}/download
Request samples 
Response samples 
application/json
{}