{ "info": { "_postman_id": "75308ab5-5b3f-5c96-87a1-bea00b6d95a1", "name": "Data Ingestion API", "description": "Data Ingestion allows you to bring your data into Adobe Experience Platform through batch ingestion and streaming ingestion. Batch ingestion lets you import data in batch, from any number of data sources. Streaming ingestion lets users send data to Platform in real time from client and server-side devices.\n- Related documentation:\n - [Data ingestion documentation](http://www.adobe.com/go/data-ingestion-overview-en)\n\n- Visualize API calls with Postman (a free, third-party software):\n - [Data Ingestion Service API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Data%20Ingestion%20API.postman_collection.json)\n - [Video guide for creating the Postman environment](https://video.tv.adobe.com/v/28832)\n - [Steps for importing environments and collections in Postman](https://learning.getpostman.com/docs/postman/collection_runs/using_environments_in_collection_runs/)\n\n- API paths:\n - Base path for batch ingestion APIs: https://platform.adobe.io/data/foundation/import\n - Base path for streaming ingestion APIs:\n - Data inlet management: https://platform.adobe.io/data/core/edge\n - Data collection: https://dcs.adobedc.net/\n - Example of a complete path for batch ingestion: https://platform.adobe.io/data/foundation/import/batches\n \n- Required headers:\n - 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](http://www.adobe.com/go/platform-api-authentication-en).\n - 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](https://adobe.com/go/sandbox-overview-en) for more information.\n - Requests with a payload in the request body (such as POST, PUT, and PATCH calls) may require the header `Content-Type`. Accepted values specific to each call are provided in the call parameters. ", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Streaming Ingestion", "item": [ { "name": "Send messages to Adobe Experience Platform", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "4ed430f9-2b13-51c1-8c45-fe47655502a5", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "Cache-Control", "value": "{{Cache-Control}}", "description": "", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "Identifies the Adobe Experience Platform sandbox to use. Default sandbox is 'prod'", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{body}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/import/collection/:CONNECTION_ID?syncValidation={{syncValidation}}&synchronousValidation={{synchronousValidation}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "import", "collection", ":CONNECTION_ID" ], "query": [ { "key": "syncValidation", "value": "{{syncValidation}}" }, { "key": "synchronousValidation", "value": "{{synchronousValidation}}" } ], "variable": [ { "value": "{{CONNECTION_ID}}", "id": "CONNECTION_ID" } ] } }, "response": [] }, { "name": "Send multiple messages to Adobe Experience Platform", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "064d4c24-0bf6-5aa8-86ae-2d52498cd3d5", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "Identifies the Adobe Experience Platform sandbox to use. Default sandbox is 'prod'", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{body}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/import/collection/batch/:CONNECTION_ID?synchronousValidation={{synchronousValidation}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "import", "collection", "batch", ":CONNECTION_ID" ], "query": [ { "key": "synchronousValidation", "value": "{{synchronousValidation}}" } ], "variable": [ { "value": "{{CONNECTION_ID}}", "id": "CONNECTION_ID" } ] } }, "response": [] } ], "_postman_id": "9e5706b9-c7ef-5b63-a70d-ac55b2935755", "description": "Streaming ingestion allows you to send data from client and server-side devices to Experience Platform in real-time. It drives Real-time Customer Profile creating personalized experiences." }, { "name": "Batch Ingestion", "item": [ { "name": "Create a new batch", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "65c249c5-b7c8-5e4a-a1a0-7a4287f350de", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "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](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{body}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/import/batches", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "import", "batches" ] } }, "response": [] }, { "name": "Upload a small file to a dataset", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "690c4c44-c12f-58ce-9107-396a399f0cfc", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "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](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/import/batches/:batchId/datasets/:datasetId/files/:filePath", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "import", "batches", ":batchId", "datasets", ":datasetId", "files", ":filePath" ], "variable": [ { "value": "{{batchId}}", "id": "batchId" }, { "value": "{{datasetId}}", "id": "datasetId" }, { "value": "{{filePath}}", "id": "filePath" } ] }, "description": "This endpoint lets you upload files under datasets for a batch initialized by the bulk ingestion API. This puts the entire request stream as the file bytes under the path denoted by the `filePath` and is idempotent. Subsequent calls to this endpoint will replace the file that exists on the referenced path.\n**Note:** Due to gateway size and timeout limits, there is a size threshold(currently 256MB). If the file is larger than that, you **must** use the large file upload mechanism." }, "response": [] }, { "name": "Either initialize or finish uploading a large file", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "d0fcf3f9-e07a-58f0-9845-1004718446b7", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "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](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/import/batches/:batchId/datasets/:datasetId/files/:filePath?action={{action}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "import", "batches", ":batchId", "datasets", ":datasetId", "files", ":filePath" ], "query": [ { "key": "action", "value": "{{action}}" } ], "variable": [ { "value": "{{batchId}}", "id": "batchId" }, { "value": "{{datasetId}}", "id": "datasetId" }, { "value": "{{filePath}}", "id": "filePath" } ] }, "description": "This endpoint should only be used when uploading a large file to the batch. Large file upload should be used for files larger than 256MB." }, "response": [] }, { "name": "Upload part of a large file to a batch", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "2eed79c3-4915-578c-b200-480ed90caabd", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "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](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "Content-Range", "value": "{{Content-Range}}", "description": "The range of bytes of the file being uploaded with this request.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "{{file}}", "description": "The content bytes for the file or file part being uploaded.", "type": "text" } ] }, "url": { "raw": "https://platform.adobe.io/data/foundation/import/batches/:batchId/datasets/:datasetId/files/:filePath", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "import", "batches", ":batchId", "datasets", ":datasetId", "files", ":filePath" ], "variable": [ { "value": "{{batchId}}", "id": "batchId" }, { "value": "{{datasetId}}", "id": "datasetId" }, { "value": "{{filePath}}", "id": "filePath" } ] }, "description": "Files larger than 256MB are uploaded in parts. The PATCH endpoint provides you a way to upload a part of your large file that was initialized via the POST endpoint." }, "response": [] }, { "name": "Get the current status of the large file", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "4a81b96c-849b-5e66-b96f-86dea0e09de8", "request": { "method": "HEAD", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "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](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/import/batches/:batchId/datasets/:datasetId/files/:filePath", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "import", "batches", ":batchId", "datasets", ":datasetId", "files", ":filePath" ], "variable": [ { "value": "{{batchId}}", "id": "batchId" }, { "value": "{{datasetId}}", "id": "datasetId" }, { "value": "{{filePath}}", "id": "filePath" } ] }, "description": "Files larger than 256MB are uploaded in parts. The HEAD endpoint provides a way to get the byte range information received by the server so far." }, "response": [] }, { "name": "Retrieve a preview for a batch", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "a6849435-c69c-5db2-a95a-8cabfdd4caaa", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "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](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/import/batches/:batchId/datasets/:datasetId/preview?format={{format}}&delimiter=,"e=\"&escape=\\&charset=UTF-8&header=true&nrow=0", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "import", "batches", ":batchId", "datasets", ":datasetId", "preview" ], "query": [ { "key": "format", "value": "{{format}}" }, { "key": "delimiter", "value": "," }, { "key": "quote", "value": "\"" }, { "key": "escape", "value": "\\" }, { "key": "charset", "value": "UTF-8" }, { "key": "header", "value": "true" }, { "key": "nrow", "value": "0" } ], "variable": [ { "value": "{{batchId}}", "id": "batchId" }, { "value": "{{datasetId}}", "id": "datasetId" } ] }, "description": "Generates a data preview for the files uploaded to the batch so far. The preview can be generated for all the batch datasets collectively or for the selected datasets." }, "response": [] }, { "name": "Finish uploading a file", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "6cd32898-9b6c-5bf1-872a-4897933dcb3a", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "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](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/import/batches/:batchId?action={{action}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "import", "batches", ":batchId" ], "query": [ { "key": "action", "value": "{{action}}" } ], "variable": [ { "value": "{{batchId}}", "id": "batchId" } ] }, "description": "Small file upload is used for files 256MB or smaller." }, "response": [] } ], "_postman_id": "8d6002f6-2c2b-534b-ad0b-a513afd4b725", "description": "Batch ingestion is used to ingest data into Experience Platform as batch files. For example, data being ingested can be the profile data from a flat file in a CRM system (for example: Parquet or JSON) or data that conforms to a known Experience Data Model (XDM) schema within the Schema Registry." } ] }