Data Access API guide
The Data Access API supports Adobe Experience Platform by providing users with a RESTful interface focused on the discoverability and accessibility of ingested datasets within Experience Platform.
API specification reference
The Swagger API reference documentation can be found here.
Terminology terminology
The table provides a description of some terms commonly used throughout this document.
Retrieve list of files within a batch retrieve-list-of-files-in-a-batch
To retrieve a list of files belonging to a particular batch, use the batch identifier (batchID) with the Data Access API.
API format
GET /batches/{BATCH_ID}/files
{BATCH_ID}
Request
curl -X GET https://platform.adobe.io/data/foundation/export/batches/{BATCH_ID}/files \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Response
{
"data": [
{
"dataSetFileId": "{FILE_ID_1}",
"dataSetViewId": "string",
"version": "1.0.0",
"created": "string",
"updated": "string",
"isValid": true,
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
}
}
},
{
"dataSetFileId": "{FILE_ID_2}",
"dataSetViewId": "string",
"version": "1.0.0",
"created": "string",
"updated": "string",
"isValid": true,
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
}
}
},
],
"_page": {
"limit": 100,
"count": 1
}
}
The "data"
array contains a list of all files within the specified batch. Each file returned has its own unique ID ({FILE_ID}
) contained within the "dataSetFileId"
field. You can use this unique ID to access or download the file.
data.dataSetFileId
data._links.self.href
Access and download files within a batch
To access specific details of a file, use a file identifier ({FILE_ID}
) with the Data Access API, including its name, size in bytes, and a link to download.
The response contains a data array. Depending on whether the file pointed to by the ID is an individual file or a directory, the data array returned may contain a single entry or a list of files belonging to that directory. Each file element includes the details of the file.
API format
GET /files/{FILE_ID}
{FILE_ID}
"dataSetFileId"
, the ID of the file to be accessed.Request
curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Single file response
{
"data": [
{
"name": "{FILE_NAME}",
"length": "{LENGTH}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME}"
}
}
}
],
"_page": {
"limit": 100,
"count": 1
}
}
data.name
profiles.csv
).data.length
data._links.self.href
Directory response
{
"data": [
{
"dataSetFileId": "{FILE_ID_1}",
"dataSetViewId": "string",
"version": "1.0.0",
"created": "string",
"updated": "string",
"isValid": true,
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
}
}
},
{
"dataSetFileId": "{FILE_ID_2}",
"dataSetViewId": "string",
"version": "1.0.0",
"created": "string",
"updated": "string",
"isValid": true,
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
}
}
}
],
"_page": {
"limit": 100,
"count": 2
}
}
When a directory is returned, it contains an array of all files within the directory.
data.name
profiles.csv
).data._links.self.href
Access the contents of a file access-file-contents
You can also use the Data Access API to access the contents of a file. You can then download the contents to an external source.
API format
GET /files/{dataSetFileId}?path={FILE_NAME}
{FILE_NAME}
Request
curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
{FILE_ID}
{FILE_NAME}
profiles.csv
).Response
Contents of the file
Additional code samples
For additional samples, refer to the data access tutorial.
Subscribe to data ingestion events subscribe-to-data-ingestion-events
You can subscribe to specific high-value events through the Adobe Developer Console. For instance, you can subscribe to data ingestion events to be notified of potential delays and failures. See the tutorial on subscribing to data ingestion notifications for more information.