Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Data Access API (1.0.0)

Download OpenAPI specification:Download

Data Access supports limited data egress from Adobe Experience Platform for very particular synchronous use cases. This API has a 60-second response time limit. For large data exports or regular data integration, you should use dataset export destinations.

Related documentation:
- Data Access documentation
Visualize API calls with Postman (a free, third-party software):
API paths:
- PLATFORM Gateway URL: https://platform.adobe.io/
- Base path for this API: /data/foundation/export
- Example of a complete path: https://platform.adobe.io/data/foundation/export/batches/{batchId}/files
Required headers:
- All calls require the headers Authorization, x-gw-ims-org-id, and x-api-key. For more information on how to obtain these values, see the authentication tutorial.
- All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header x-sandbox-name whose value is the all-lowercase name of the sandbox the operation will take place in (for example, "prod"). See the sandboxes overview for more information.
- All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header Content-Type with a value of application/json.
API error handling:
- Refer to the Experience Platform API troubleshooting guide for FAQs, API status codes, and request header errors.

(NEW) Interactive API documentation

You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your authentication credentials and use the Try it functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.

Data Access

Configure data access and egress for Experience Platform.

List a batch's dataset files

By default, 100 dataset files are shown. Additionally, 100 dataset files is the maximum number of files that can be returned in a single API request.

Request

path Parameters

batchId

required

string

The batch ID.

query Parameters

start	string A paging parameter to specify the start of the page of results. For example: `page=1`
limit	string A paging parameter to specify the number of results per page. For example: `limit=10`

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, see the authentication tutorial.
x-sandbox-name required	string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

The request was successful.

401

Access is unauthorized.

500

An internal server error has ocurred.

get/batches/{batchId}/files

Response samples

application/json

{"data": [{"dataSetFileId": "string",
"dataSetViewId": "string",
"version": "string",
"created": "string",
"updated": "string",
"records": "string",
"size": "string",
"isValid": true,
"_links": {"self": {"href": "string"
}
}
}
],
"_page": {"limit": 0,
"count": 0
},
"_links": {"next": {"href": "string"
},
"page": {"href": "string",
"templated": true
}
}
}

Retrieve a failed batch's dataset files

By default, 100 failed files are shown. Additionally, 100 failed files is the maximum number of files that can be returned in a single API request.

Request

path Parameters

batchId

required

string

The ID of the batch.

query Parameters

start	string A paging parameter to specify the start of the page of results. For example: `page=1`
limit	string A paging parameter to specify the number of results per page. For example: `limit=10`
path	string The full name of the file. The contents of the file would be downloaded if this parameter is provided. For example: `path=profiles.csv`

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, see the authentication tutorial.
x-sandbox-name required	string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

The request was successful.

401

Access is unauthorized.

500

An internal server error has ocurred.

get/batches/{batchId}/failed

Response samples

application/json

{"data": [{"name": "string",
"length": "string",
"_links": {"self": {"href": "string"
}
}
}
],
"_page": {"limit": 0,
"count": 0
},
"_links": {"next": {"href": "string"
},
"page": {"href": "string",
"templated": true
}
}
}

Retrieve a batch's meta files

Lists files under a batch's meta directory or download a specific file under it. The files under a batch's meta directory may include the following:

row_errors: A directory containing 0 or more files with parsing, conversion, and/or validation errors found at the row level.
input_files: A directory containing metadata for 1 or more input files submitted with the batch.
row_errors_sample.json: A root level file containing the sampled set of row errors for the UX.

By default, 100 meta files are shown. Additionally, 100 meta files is the maximum number of files that can be returned in a single API request.

Request

path Parameters

batchId

required

string

The ID of the batch.

query Parameters

start	string A paging parameter to specify the start of the page of results. For example: `page=1`
limit	string A paging parameter to specify the number of results per page. For example: `limit=10`
path	string The full name of the file. The contents of the file would be downloaded if this parameter is provided. For example: `path=row_error_samples.json` Possible values for this query include the following: `row_errors` `input_files` `row_errors_sample.json`

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, see the authentication tutorial.
x-sandbox-name required	string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

The request was successful.

401

Access is unauthorized.

404

The path is not found.

500

An internal service error has ocurred.

get/batches/{batchId}/meta

Response samples

application/json

{"path": "F1.json"
}

Files

Retrieve headers containing metadata for a file specified by ID.

Retrieve a file

Returns either a complete file or a directory of chunked data that makes up the file. The response contains a data array that may contain a single entry or a list of files belonging to that directory.

Request

path Parameters

dataSetFileId

required

string

The ID of the dataset file you are retrieving.

query Parameters

start	string A paging parameter to specify the start of the page of results. For example: `page=1`
limit	string A paging parameter to specify the number of results per page. For example: `limit=10`
path	string The full name of the file. The contents of the file would be downloaded if this parameter is provided. For example: `path=profiles.csv`

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, see the authentication tutorial.
x-sandbox-name required	string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.
Range	string The range of bytes requested. For example: `Range: bytes=0-100000`

Responses

200

The request has succeeded.

206

The request has succeeded, returning only partial content. The body will contain the requested range of data.

401

Access is unauthorized.

404

The requested file was not found.

500

An internal server error has ocurred.

get/files/{dataSetFileId}

Response samples

{"path": "F1.json"
}

Retrieve a file's headers

Request

path Parameters

dataSetFileId

required

string

The ID of the dataset file you are retrieving.

query Parameters

path

required

string

The full name of the file identified. For example: path=profiles.csv

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, see the authentication tutorial.
x-sandbox-name required	string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

The request was successful.

401

Access is unauthorized.

404

The dataset file was not found.

500

An internal server error has ocurred.

head/files/{dataSetFileId}

Preview

Retrieve the first 100 rows of CSV or Parquet files.

Preview the files

This endpoint lets you preview the first 100 rows of the retrieved CSV or Parquet files.

Request

path Parameters

required

string

The ID of the dataset you want to preview.

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, see the authentication tutorial.
x-sandbox-name required	string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

The request has succeeded.

401

Access is unauthorized.

404

The requested dataset was not found.

500

An internal server error has ocurred.

get/datasets/{id}/preview

Response samples

application/json

{"data": [{"column1": "string",
"column2": "string",
"column3": "string"
}
]
}