Get Credentials

Get credentials

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

Flow Service API - Destinations (1.0.0)

Download OpenAPI specification:Download

Use the Adobe Experience Platform Flow Service API to connect and activate data to various destinations within and outside of Adobe Experience Platform. This API reference is centered on exporting data to batch destinations like Amazon S3, SFTP, Azure Blob.

NOTE: Refer to Flow Service API - Sources if you are looking for API documentation to perform operations on sources in Experience Platform.

Related documentation:
API paths:
- PLATFORM Gateway URL: https://platform.adobe.io/
- Base path for this API: /data/foundation/flowservice
- Example of a complete path: https://platform.adobe.io/data/foundation/flowservice/flows
Required headers:
- All service 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. You can also view a list of common Flow Service error messages and resolution suggestions.
Sorting and filtering responses:
- When performing listing (GET) requests in the Flow Service API, you can use query parameters to sort and filter responses.

(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.

Glossary

This section describes the terms that you will be encountering in this API documentation. For a complete reference of Experience Platform API terms, read the Adobe Experience Platform glossary.

Term	Description
Base connection	Base connections retain authentication information regarding how to connect to a target destination. You must set up a base connection before you can create a target connection.
Source connection	Source connections create and manage a connection to the internal source from where data is exported. For destination connections, the source connection can be either the Experience Platform Profile Store when exporting segments or Experience Platform Data Lake, when exporting datasets.
Target connection	Target connections create and manage a destination connection to any location where exported data will land. Target connections contain information regarding data destination, data format, and the target connection ID needed to create a destination dataflow.
Dataflow	A dataflow is a virtual pipeline of data that flows into Platform from a source and out to a destination. This API reference focuses on destination dataflows.
Dataflow run	A dataflow run is an execution instance of a dataflow that lands in Experience Platform based on a user-specified schedule OR that is exported from Experience Platform to a destination of your choice, also based on a user-specified schedule and other criteria. This API reference focuses on dataflow runs to destinations.

Base connections

Base connections retain information regarding how to connect to a source or target. For destinations, the source that you are connecting to is Experience Platform data and the target is the desired destination. The base connection configuration always includes a unique connectionSpec ID, which is necessary in order to successfully access Experience Platform data and authorize a connection to the target destination.

Retrieve a list of destination base connections

You can retrieve a list of all destination base connections for your organization by making a GET request to the /connections endpoint.

You can use query parameters to return only the base connections for a specific destination type. To do this, pass in the connectionSpec.id of the desired destination by using the property query parameter, as shown further below.

NOTE: This operation allows you to retrieve a maximum of 100 entities. The most recently created or updated entities are returned first. Use filters to return the base connections that are most relevant to you.

Request

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. Used to cut down the amount of data returned in the response body. For example, `property=id==f2d1a98b-6b8c-420b-80a1-696c3f192eb2,b6730e09-7da6-40e2-b5cf-289545056dc3,49d17eff-9fa7-4e92-b84e-ab65fcb4730a`. Examples: Filter to return connections for Amazon S3 destinations only. property=connectionSpec.id==4fce964d-3f37-408f-9778-e597338a21ee Filter to return connections for SFTP destinations only. property=connectionSpec.id==36965a81-b1c6-401b-99f8-22508f1e6a26
limit	integer <= 100 Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`.
orderby	string Sort response by specified fields separated by `,` and/or prefix field with `-` for descending order.
count	boolean A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`).
continuationToken	string A token for fetching records for next page. This is a system-generated token.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

200

List of Base Connections Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

500

Internal Server Error

get/connections

Response samples

application/json

{"items": [{"id": "9d8159c6-9da6-4205-8507-d818d7ad7103",
"createdAt": 1654785125699,
"updatedAt": 1654791389756,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "amazon-s3",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
},
"auth": {"specName": "Access Key",
"params": {"authorizedDate": "2022-08-03",
"s3SecretKey": "{SECRET_KEY}",
"s3AccessKey": "{ACCESS_KEY}"
}
},
"state": "enabled",
"version": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\"",
"etag": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\""
},
{"id": "e6f3a300-0bf7-4755-b7f8-308dc2a99133",
"createdAt": 1654785125699,
"updatedAt": 1654791389756,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "amazon-s3",
"connectionSpec": {"id": "64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0",
"version": "1.0"
},
"state": "enabled",
"auth": {"specName": "Basic Authentication for sftp",
"params": {"authorizedDate": "2022-08-03",
"password": "testPassword",
"userName": "testUser",
"host": "ftp.test.com"
}
},
"version": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\"",
"etag": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\""
},
{"id": "340d288f-c020-435d-a41f-094520fa83eb",
"createdAt": 1634785125699,
"updatedAt": 1644791389756,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "(Beta) Amazon S3 Connection",
"connectionSpec": {"id": "4fce964d-3f37-408f-9778-e597338a21ee",
"version": "1.0"
},
"auth": {"specName": "Access Key",
"params": {"authorizedDate": "2022-11-03",
"s3SecretKey": "{SECRET_KEY}",
"s3AccessKey": "{ACCESS_KEY}"
}
},
"state": "enabled",
"version": "\"26013a41-0000-0200-0000-6361687a0000\"",
"etag": "\"26013a41-0000-0200-0000-6361687a0000\""
},
{"id": "63e0b47b-94bd-4b20-a395-81ff6b496335",
"createdAt": 1674785125699,
"updatedAt": 1684791389756,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "(Beta) SFTP Connection",
"connectionSpec": {"id": "36965a81-b1c6-401b-99f8-22508f1e6a26",
"version": "1.0"
},
"state": "enabled",
"auth": {"specName": "SFTP with Password",
"params": {"authorizedDate": "2022-08-03",
"username": "testUser",
"password": "testPassword",
"domain": "ftp.test.com"
}
},
"version": "\"56fda0d4-3858-4657-b679-adf65b9ddf9b\"",
"etag": "\"56fda0d4-3858-4657-b679-adf65b9ddf9b\""
}
]
}

Create a target base connection

A target base connection authorizes the connection to your desired destination type. The required authorization parameters vary based on the destination that you are looking to connect to.

Request

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, visit the authentication tutorial.
Content-type required	string Default: application/json The type of content being sent in the body of the request. Should be 'application/json'.
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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Request Body schema: application/json
required

One of:

API request to authorize the connection to an Amazon S3 instance.

name required	string (Name) The name of the base connection.
description	string (Description) An optional description for the base connection.
required	object (Authentication Parameters) The parameters in the base connection payload which are required to authorize a connection to an Amazon S3 instance.
required	object (Connection Spec.) Request model for connection spec information.

Responses

201

Base Connection Created Successfully

400

Bad Request - Invalid Connection Spec ID

401

Invalid Authorization Token

403

Authorization Error - Access Denied

422

Unprocessable Entity - Missing Required Version Parameter

500

Internal Server Error

post/connections

Request samples

Payload

application/json

{"name": "Amazon S3 Base Connection",
"auth": {"specName": "Access Key",
"params": {"s3SecretKey": "<Add secret key>",
"s3AccessKey": "<Add access key>"
}
},
"connectionSpec": {"id": "4fce964d-3f37-408f-9778-e597338a21ee",
"version": "1.0"
}
}

Response samples

application/json

{"id": "77eeb629-f08a-48e2-8c7b-e345e246ff45",
"etag": "\"ac00c7db-0000-0200-0000-62eabd5c0000\""
}

Retrieve the details of a base connection

You can retrieve detailed information about a specific base connection by making a GET request to the /connections endpoint and providing the ID of the connection you want to inspect.

Request

path Parameters

required

string

The ID of the connection you are looking to retrieve.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

200

Base Connection Details Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Base Connection ID Not Found

500

get/connections/{id}

Response samples

application/json

{"items": [{"id": "9d8159c6-9da6-4205-8507-d818d7ad7103",
"createdAt": 1654785125699,
"updatedAt": 1654791389756,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "amazon-s3",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
},
"auth": {"specName": "Access Key",
"params": {"authorizedDate": "2022-08-03",
"s3SecretKey": "{SECRET_KEY}",
"s3AccessKey": "{ACCESS_KEY}"
}
},
"state": "enabled",
"version": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\"",
"etag": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\""
}
]
}

Update a base connection

You can update a base connection by making a PATCH request to the /connections endpoint and providing the ID of the base connection you want to update. In the body of the request, provide the updated configuration of the connection.

Request

path Parameters

required

string

The ID of the connection you are looking to update.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.
Content-type required	string Default: application/json The type of content being sent in the body of the request. Should be 'application/json'.
if-match required	string A header containing the eTag value of the entity to be updated (destination dataflow, base or target connection, etc.). Perform a GET request to return the latest eTag version of the entity. Note that you always need to wrap this header in double quotes when using it.

Request Body schema: application/json
required

op required	string (PATCH operation) The operation that you are performing on the connection. You can add, replace, or remove items from connections. Enum: "add" "replace" "remove"
path required	string (Path) A json xpath where the value has to be added, updated, or removed.
required	Authentication parameters for Amazon S3 base connections (object) or Authentication parameters for SFTP With SSH Key base connections (object) or Authentication parameters for SFTP With Password base connections (object) Select the relevant schema to update authentication parameters for your destination.

Responses

200

Base Connection Updated Successfully

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Base Connection ID Not Found

412

Precondition Failed - ETag Mismatch

500

Internal Server Error

patch/connections/{id}

Request samples

Payload

application/json

[{"op": "remove",
"path": "/auth/params",
"value": {"accessId": "exampleAccessId",
"secretKey": "exampleSecretKey"
}
}
]

Response samples

application/json

null

Delete a base connection

You can delete the specified base connection by making a DELETE request to the /connections endpoint and providing the ID of the connection that you wish to delete in the request path.

Request

path Parameters

required

string

The ID of the connection you are looking to delete.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

202

Deletion Request Accepted

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Base Connection ID Not Found

500

Internal Server Error

delete/connections/{id}

Response samples

application/json

{"error_code": 401013,
"message": "Oauth token is not valid"
}

Source connections

Source connections create and manage a connection to the internal source from where data is exported. For destination connections, the source connection can be either the Experience Platform Profile Store or the Experience Platform Data Lake. Source connections contain information like data source, data format, and the source connection ID needed to create a dataflow. A source connection instance is specific to a tenant and organization.

Retrieve a list of source connections for destinations

You can retrieve a list of all source connections for destinations in your organization by making a GET request to the /sourceConnections endpoint.
You can use query parameters to return only the base connections for a specific destination type. To do this, pass in the connectionSpec.id of the desired destination by using the property query parameter, as shown further below.

Request

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. Used to cut down the amount of data returned in the response body. For example, `property=id==f2d1a98b-6b8c-420b-80a1-696c3f192eb2,b6730e09-7da6-40e2-b5cf-289545056dc3,49d17eff-9fa7-4e92-b84e-ab65fcb4730a`. Examples: Filter source connection to the Experience Platform Profile Store property=connectionSpec.id==8a9c3494-9708-43d7-ae3f-cda01e5030e1 Filter all source connections to the Experience Platform Profile Store created after August 7th, 2022 property=createdAt>=1659907304000&property=connectionSpec.id==8a9c3494-9708-43d7-ae3f-cda01e5030e1
limit	integer <= 100 Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`.
orderby	string Sort response by specified fields separated by `,` and/or prefix field with `-` for descending order.
count	boolean A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`).
continuationToken	string A token for fetching records for next page. This is a system-generated token.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

200

List of Source Connections Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

500

Internal Server Error

get/sourceConnections

Response samples

application/json

{"items": [{"id": "23f73356-d5aa-49f4-b810-c69f12fb3edd",
"createdAt": 1659993961499,
"updatedAt": 1659993961695,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "Sample source connection Profile Store",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
},
"typeInfo": {"type": "ProfileFragments",
"id": "ups"
},
"state": "enabled",
"version": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\"",
"etag": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\"",
"inheritedAttributes": {"baseConnection": {"id": "be3e2d03-6134-4566-9865-c40e0df8b718",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
}
}
},
{"id": "12333356-d5aa-49f4-b810-c69f12fb3edd",
"createdAt": 1659993961493,
"updatedAt": 1659993961699,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "Another sample source connection to the Profile Store",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
},
"typeInfo": {"type": "ProfileFragments",
"id": "ups"
},
"state": "enabled",
"version": "\"0e0d95ae-0000-0200-0000-62a55cdd0000\"",
"etag": "\"0e0d95ae-0000-0200-0000-62a55cdd0000\"",
"inheritedAttributes": {"baseConnection": {"id": "be3e2d03-6134-4566-9865-c40e0df8b718",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
}
}
},
{"id": "dfe93ffd-4f87-49f4-b900-f57cd0dbab1a",
"createdAt": 1659993961499,
"updatedAt": 1659993961695,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "Data Lake Source Connection",
"description": "Data Lake Source Connection",
"baseConnectionId": "3c7dc58e-a1ee-4e29-b3b2-a7757fb82044",
"state": "enabled",
"connectionSpec": {"id": "23598e46-f560-407b-88d5-ea6207e49db0",
"version": "1.0"
},
"params": {"datasets": [{"dataSetId": "616d53e0a6de2719486fb024",
"name": "Company Dataset"
},
{"dataSetId": "972a43e0n3fe2419923bb037",
"name": "Employee Dataset"
}
]
},
"version": "\"24014573-0000-0200-0000-6372c91f0000\"",
"etag": "\"24014573-0000-0200-0000-6372c91f0000\"",
"inheritedAttributes": {"baseConnection": {"id": "3c7dc58e-a1ee-4e29-b3b2-a7757fb82044",
"connectionSpec": {"id": "23598e46-f560-407b-88d5-ea6207e49db0",
"version": "1.0"
}
}
}
}
]
}

Create a source connection

A source connection for destinations establishes the connection to the Experience Platform Profile Store or Experience Platform Data Lake. The sourceConnection ID returned in a successful response must be used when creating a dataflow to your desired destination.

Request

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, visit the authentication tutorial.
Content-type required	string Default: application/json The type of content being sent in the body of the request. Should be 'application/json'.
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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Request Body schema: application/json
required

One of:

API request to create a source connection to the Experience Platform Profile Store. In the request payload, always use the hardcoded value connectionSpec.id=8a9c3494-9708-43d7-ae3f-cda01e5030e1.

name required	string (Name) The name of the source connection.
description	string (Description) An optional description for the source connection.
required	object (Connection Spec.) Request model for connection spec information.

Responses

201

Source connection created successfully

401

Invalid authentication token

403

Unauthorized access

422

Missing required field

500

Internal server error

post/sourceConnections

Request samples

Payload

application/json

{"name": "Connecting to Profile Store",
"description": "Optional",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
}

Response samples

application/json

{"id": "77eeb629-f08a-48e2-8c7b-e345e246ff45",
"etag": "\"ac00c7db-0000-0200-0000-62eabd5c0000\""
}

Retrieve the details of a source connection

You can retrieve detailed information about a specific source connection by making a GET request to the /sourceConnections endpoint and providing the ID of the connection you want to inspect.

Request

path Parameters

required

string

The ID of the source connection you are looking to retrieve.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

200

Source Connection Details Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Source Connection ID Missing

500

Internal Server Error

get/sourceConnections/{id}

Response samples

application/json

{"items": [{"id": "097e3d72-921b-47f5-9e99-a4487cdbd1bd",
"createdAt": 1660155681202,
"updatedAt": 1660155681587,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "Sample source connection to the Profile Store",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
},
"typeInfo": {"type": "ProfileFragments",
"id": "ups"
},
"state": "enabled",
"version": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\"",
"etag": "\"0e0d95ae-0000-0200-0000-62a21cdd0000\"",
"inheritedAttributes": {"baseConnection": {"id": "be3e2d03-6134-4566-9865-c40e0df8b718",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
}
}
}
]
}

Delete a source connection

You can delete the specified source connection by making a DELETE request to the /sourceConnections endpoint and providing the ID of the source connection that you wish to delete in the request path.

Request

path Parameters

required

string

The ID of the source connection you are looking to delete.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

202

Deletion Accepted - Source Connection Marked for Deletion

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Source Connection ID Not Found

500

Internal Server Error

delete/sourceConnections/{id}

Response samples

application/json

{"error_code": 401013,
"message": "Oauth token is not valid"
}

Target connections

Target connections create and manage a destination connection to any location where exported data will land. Target connections contain information regarding data destination, data format, and the target connection ID needed to create a destination dataflow. A target connection instance is specific to a tenant and organization.

Before you create a target connection, you must create a base connection.

Retrieve a list of destination target connections

You can retrieve a list of all destination target connections for your organization by making a GET request to the /targetConnections endpoint.

You can use query parameters to return only the target connections for a specific destination type. To do this, pass in the connectionSpec.id of the desired destination by using the property query parameter, as shown further below.

NOTE: This operation allows you to retrieve a maximum of 100 entities. The most recently created or updated entities are returned first. Use filters to return the target connections that are most relevant to you.

Request

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. Used to cut down the amount of data returned in the response body. For example, `property=id==f2d1a98b-6b8c-420b-80a1-696c3f192eb2,b6730e09-7da6-40e2-b5cf-289545056dc3,49d17eff-9fa7-4e92-b84e-ab65fcb4730a`. Examples: Filter connection for Amazon S3 destination property=connectionSpec.id==4fce964d-3f37-408f-9778-e597338a21ee Filter connection for SFTP destination property=connectionSpec.id==36965a81-b1c6-401b-99f8-22508f1e6a26
limit	integer <= 100 Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`.
orderby	string Sort response by specified fields separated by `,` and/or prefix field with `-` for descending order.
count	boolean A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`).
continuationToken	string A token for fetching records for next page. This is a system-generated token.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

200

Target Connection Details Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Target Connection ID Missing

500

Internal Server Error

get/targetConnections

Response samples

application/json

{"items": [{"id": "05672d6b-3cf5-47cd-9d8b-cff0ca9541c3",
"createdAt": 1660921644496,
"updatedAt": 1660921644729,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "Amazon S3 Target Connection++",
"baseConnectionId": "be3e2d03-6134-4566-9865-c40e0df8b718",
"state": "enabled",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
},
"params": {"bucketName": "your-bucket-name",
"path": "folder/subfolder"
},
"version": "\"28029f1b-0000-0200-0000-62ffa72c0000\"",
"etag": "\"28029f1b-0000-0200-0000-62ffa72c0000\"",
"inheritedAttributes": {"baseConnection": {"id": "be3e2d03-6134-4566-9865-c40e0df8b718",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
}
}
}
]
}

Create a target connection

Create a target connection to manage a destination connection to any location where exported data will land. In the request payload, specify information regarding the data destination and data format. The HTTP response returns the target connection ID, which you'll later need to create a destination dataflow.

Request

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, visit the authentication tutorial.
Content-type required	string Default: application/json The type of content being sent in the body of the request. Should be 'application/json'.
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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Request Body schema: application/json
required

One of:

API request to create a target connection to an Amazon S3 instance, specifying data export format and storage location details.

name required	string (Name) The name of the target connection.
description	string (Description) An optional description for the target connection.
baseConnectionId required	string (Base Connection ID) The ID of the base connection that specifies authentication details for the destination. Each target connection must have an associated base connection.
required	object (Target connection parameters) Request model to capture target connection details for Amazon S3.
required	object (Connection Spec.) Request model for connection spec information.

Responses

201

Target Connection Created Successfully

401

Invalid Authorization Token

403

Authorization Error - Access Denied

422

Unprocessable Entity - Version Parameter Missing

500

Internal Server Error

post/targetConnections

Request samples

Payload

application/json

{"name": "SFTP Target Connection",
"baseConnectionId": "be3e2d03-6134-4566-9865-c40e0df8b718",
"params": {"remotePath": "path-to-storage-location"
},
"connectionSpec": {"id": "64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0",
"version": "1.0"
}
}

Response samples

application/json

{"id": "77eeb629-f08a-48e2-8c7b-e345e246ff45",
"etag": "\"ac00c7db-0000-0200-0000-62eabd5c0000\""
}

Retrieve the details of a target connection

You can retrieve detailed information about a specific target connection by making a GET request to the /targetConnections endpoint and providing the ID of the target connection you want to inspect.

Request

path Parameters

required

string

The ID of the target connection you are looking to retrieve.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

200

Target Connection Details Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Target Connection ID Missing

500

Internal Server Error

get/targetConnections/{id}

Response samples

application/json

{"items": [{"id": "05672d6b-3cf5-47cd-9d8b-cff0ca9541c3",
"createdAt": 1660921644496,
"updatedAt": 1660921644729,
"createdBy": "example@AdobeID",
"updatedBy": "example@AdobeID",
"createdClient": "example_client",
"updatedClient": "example_updated client",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "destinationapi@AdobeOrg",
"name": "Amazon S3 Target Connection++",
"baseConnectionId": "be3e2d03-6134-4566-9865-c40e0df8b718",
"state": "enabled",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
},
"params": {"bucketName": "your-bucket-name",
"path": "folder/subfolder"
},
"version": "\"28029f1b-0000-0200-0000-62ffa72c0000\"",
"etag": "\"28029f1b-0000-0200-0000-62ffa72c0000\"",
"inheritedAttributes": {"baseConnection": {"id": "be3e2d03-6134-4566-9865-c40e0df8b718",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
}
}
}
]
}

Delete a target connection

You can delete the specified source connection by making a DELETE request to the /targetConnections endpoint and providing the ID of the target connection that you wish to delete in the request path.

Request

path Parameters

required

string

The ID of the target connection you are looking to delete.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

202

Deletion Accepted - Target Connection Marked for Deletion

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Target Connection ID Missing

500

Internal Server Error

delete/targetConnections/{id}

Response samples

application/json

{"error_code": 401013,
"message": "Oauth token is not valid"
}

Dataflows

Destination dataflows represent the data transfer between a source connection (Experience Platform) and a target connection (the destination you set up). This also includes information regarding the data export schedule, and the transformation specifications of the data being exported to your destination. A dataflow instance is specific to a tenant and organization.

Retrieve a list of destination dataflows

You can retrieve a list of all destination dataflows for your organization by making a GET request to the /flows endpoint. When performing listing (GET) requests in the Flow Service API, you can use query parameters to sort and filter responses.

Use isDestinationFlow as query parameter to return destination dataflows only, like this: https://platform.adobe.io/data/foundation/flowservice/flows?property=inheritedAttributes.properties.isDestinationFlow==true

Additionally, you can use query parameters to return only the dataflows for a specific destination. To do this, pass in the connectionSpec.id of the desired destination by using the property query parameter, as shown further below. See also the list of connectionSpec IDs for the most commonly used batch destinations:

Adobe Campaign: 0b23e41a-cb4a-4321-a78f-3b654f5d7d97
Amazon S3: 4fce964d-3f37-408f-9778-e597338a21ee
Azure Blob Storage: 6d6b59bf-fb58-4107-9064-4d246c0e5bb2
Azure Data Lake Gen 2(ADLS Gen2): be2c3209-53bc-47e7-ab25-145db8b873e1
Data Landing Zone(DLZ): 10440537-2a7b-4583-ac39-ed38d4b848e8
Google Cloud Storage: c5d93acb-ea8b-4b14-8f53-02138444ae99
Oracle Eloqua: c1e44b6b-e7c8-404b-9031-58f0ef760604
Oracle Responsys: a5e28ddf-e265-426e-83a1-9d03a3a6822b
Salesforce Marketing Cloud: f599a5b3-60a7-4951-950a-cc4115c7ea27
SFTP: 36965a81-b1c6-401b-99f8-22508f1e6a26

NOTE: This operation allows you to retrieve a maximum of 100 entities. The most recently created or updated entities are returned first. Use filters to return the dataflows that are most relevant to you.

Request

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. Used to cut down the amount of data returned in the response body. For example, `property=id==3416976c-a9ca-4bba-901a-1f08f66978ff,6a8d82b-1caf-45d1-908d-cadabc9d63a6,3c9b37f8-13a6-43d8-bad3-b863b941fedd`. Examples: Filter dataflows for destinations only property=inheritedAttributes.properties.isDestinationFlow==true Filter dataflows for Amazon S3 destination property=inheritedAttributes.targetConnections[].connectionSpec.id==4fce964d-3f37-408f-9778-e597338a21ee Filter dataflows for SFTP destination property=inheritedAttributes.targetConnections[].connectionSpec.id==36965a81-b1c6-401b-99f8-22508f1e6a26
limit	integer <= 100 Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`.
orderby	string Sort response by specified fields separated by `,` and/or prefix field with `-` for descending order.
count	boolean A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`).
continuationToken	string A token for fetching records for next page. This is a system-generated token.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

200

List of Dataflows Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

500

Internal Server Error

get/flows

Response samples

application/json

{"items": [{"id": "ca5c6e9a-8559-4a08-97a5-f198756da601",
"createdAt": 1658340453699,
"updatedAt": 1658430188496,
"createdBy": "0A4334FA556585B77F000101@AdobeID",
"updatedBy": "acp_foundation_connectors@AdobeID",
"createdClient": "exc_app",
"updatedClient": "acp_foundation_connectors",
"sandboxId": "6ef74723-3ee7-46a4-b747-233ee7a6a41a",
"sandboxName": "sample-platform-sandbox",
"imsOrgId": "5555467B5D8013E50A494220@AdobeOrg",
"name": "Documentation S3 Destination",
"description": "Documentation S3 Destination",
"flowSpec": {"id": "71471eba-b620-49e4-90fd-23f1fa0174d8",
"version": "1.0"
},
"state": "enabled",
"version": "\"04001b6d-0000-0200-0000-62d9a2ec0000\"",
"etag": "\"04001b6d-0000-0200-0000-62d9a2ec0000\"",
"sourceConnectionIds": ["f3a5e232-eba3-428b-aa69-921d122d5db5"
],
"targetConnectionIds": ["54d575d8-43c9-4d3d-aec5-b033e4189f4a"
],
"inheritedAttributes": {"properties": {"isDestinationFlow": true
},
"sourceConnections": [{"id": "f3a5e232-eba3-428b-aa69-921d122d5db5",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
},
"baseConnection": {"id": "a9ae9a98-950d-468f-ac28-bc42bcd55d78",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
},
"typeInfo": {"type": "ProfileFragments",
"id": "ups"
}
}
],
"targetConnections": [{"id": "54d575d8-43c9-4d3d-aec5-b033e4189f4a",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
},
"baseConnection": {"id": "459779de-6f0a-46dd-9b64-10121316a8d9",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
}
}
}
]
},
"transformations": [{"name": "GeneralTransform",
"params": {"profileSelectors": {"selectors": [{"type": "JSON_PATH",
"value": {"path": "person.name.firstName",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "person.name.firstName",
"destination": "person.name.firstName",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "person.name.firstName",
"destinationXdmPath": "person.name.firstName"
}
}
},
{"type": "JSON_PATH",
"value": {"path": "person.name.lastName",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "person.name.lastName",
"destination": "person.name.lastName",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "person.name.lastName",
"destinationXdmPath": "person.name.lastName"
}
}
},
{"type": "JSON_PATH",
"value": {"path": "personalEmail.address",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "personalEmail.address",
"destination": "personalEmail.address",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "personalEmail.address",
"destinationXdmPath": "personalEmail.address"
}
}
},
{"type": "JSON_PATH",
"value": {"path": "segmentMembership.status",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "segmentMembership.status",
"destination": "segmentMembership.status",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "segmentMembership.status",
"destinationXdmPath": "segmentMembership.status"
}
}
}
],
"mandatoryFields": ["person.name.firstName",
"person.name.lastName"
],
"primaryFields": [{"fieldType": "ATTRIBUTE",
"attributePath": "personalEmail.address"
}
]
},
"segmentSelectors": {"selectors": [{"type": "PLATFORM_SEGMENT",
"value": {"id": "4afb50cb-3fb0-4c06-bc90-d3b66cb7f5af",
"name": "Batch Monitoring Testing Segment",
"description": "",
"filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "FIRST_FULL_THEN_INCREMENTAL",
"schedule": {"frequency": "DAILY",
"triggerType": "SCHEDULED",
"startDate": "2022-07-20",
"endDate": "2022-07-29",
"startTime": "20:00"
},
"createTime": "1658344069",
"updateTime": "1658427026"
}
}
]
}
}
}
],
"runs": "/runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600",
"lastOperation": {"started": 1658427025696,
"updated": 1658427031832,
"percentCompleted": 100,
"status": {"value": "completed",
"properties": null,
"errors": [ ]
},
"ops": [{"op": "add",
"path": "/transformations/0/params/segmentSelectors/selectors/-",
"value": {"type": "PLATFORM_SEGMENT",
"value": {"id": "4afb50cb-3fb0-4c06-bc90-d3b66cb7f5af",
"name": "Batch Monitoring Testing Segment",
"description": "",
"filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "FIRST_FULL_THEN_INCREMENTAL",
"schedule": {"startDate": "2022-07-20",
"frequency": "DAILY",
"endDate": "2022-07-29",
"startTime": "20:00",
"triggerType": "SCHEDULED"
}
}
}
}
],
"operation": "update"
},
"lastRunDetails": {"id": "daa87aaa-6969-458d-bc41-609c52ebc2b1",
"state": "success",
"startedAtUTC": 1658430155398,
"completedAtUTC": 1658430160403
}
},
{"id": "ca5c6e9a-8559-4a08-97a5-f15b756da600",
"createdAt": 1658340453699,
"updatedAt": 1658430188496,
"createdBy": "0A4334FA556585B77F000101@AdobeID",
"updatedBy": "acp_foundation_connectors@AdobeID",
"createdClient": "exc_app",
"updatedClient": "acp_foundation_connectors",
"sandboxId": "6ef74723-3ee7-46a4-b747-233ee7a6a41a",
"sandboxName": "sample-platform-sandbox",
"imsOrgId": "5555467B5D8013E50A494220@AdobeOrg",
"name": "Documentation S3 Destination",
"description": "Documentation S3 Destination",
"flowSpec": {"id": "71471eba-b620-49e4-90fd-23f1fa0174d8",
"version": "1.0"
},
"state": "enabled",
"version": "\"04001b6d-0000-0200-0000-62d9a2ec0000\"",
"etag": "\"04001b6d-0000-0200-0000-62d9a2ec0000\"",
"sourceConnectionIds": ["f3a5e232-eba3-428b-aa69-921d122d5db5"
],
"targetConnectionIds": ["54d575d8-43c9-4d3d-aec5-b033e4189f4a"
],
"inheritedAttributes": {"properties": {"isDestinationFlow": true
},
"sourceConnections": [{"id": "f3a5e232-eba3-428b-aa69-921d122d5db5",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
},
"baseConnection": {"id": "a9ae9a98-950d-468f-ac28-bc42bcd55d78",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
},
"typeInfo": {"type": "ProfileFragments",
"id": "ups"
}
}
],
"targetConnections": [{"id": "54d575d8-43c9-4d3d-aec5-b033e4189f4a",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
},
"baseConnection": {"id": "459779de-6f0a-46dd-9b64-10121316a8d9",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
}
}
}
]
},
"transformations": [{"name": "GeneralTransform",
"params": {"profileSelectors": {"selectors": [{"type": "JSON_PATH",
"value": {"path": "person.name.firstName",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "person.name.firstName",
"destination": "person.name.firstName",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "person.name.firstName",
"destinationXdmPath": "person.name.firstName"
}
}
},
{"type": "JSON_PATH",
"value": {"path": "person.name.lastName",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "person.name.lastName",
"destination": "person.name.lastName",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "person.name.lastName",
"destinationXdmPath": "person.name.lastName"
}
}
},
{"type": "JSON_PATH",
"value": {"path": "personalEmail.address",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "personalEmail.address",
"destination": "personalEmail.address",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "personalEmail.address",
"destinationXdmPath": "personalEmail.address"
}
}
},
{"type": "JSON_PATH",
"value": {"path": "segmentMembership.status",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "segmentMembership.status",
"destination": "segmentMembership.status",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "segmentMembership.status",
"destinationXdmPath": "segmentMembership.status"
}
}
}
],
"mandatoryFields": ["person.name.firstName",
"person.name.lastName"
],
"primaryFields": [{"fieldType": "ATTRIBUTE",
"attributePath": "personalEmail.address"
}
]
},
"segmentSelectors": {"selectors": [{"type": "PLATFORM_SEGMENT",
"value": {"id": "42794d4a-a95e-432e-9cbf-7f61cc14ae2e",
"name": "Chaining Segment 1",
"description": "Chaining Segment 1",
"filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "FIRST_FULL_THEN_INCREMENTAL",
"schedule": {"frequency": "EVERY_3_HOURS",
"triggerType": "SCHEDULED",
"startDate": "2022-07-20",
"endDate": "2022-07-27",
"startTime": "20:00"
},
"createTime": "1658344069",
"updateTime": "1658427026"
}
}
]
}
}
}
],
"runs": "/runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600",
"lastOperation": {"started": 1658427025696,
"updated": 1658427031832,
"percentCompleted": 100,
"status": {"value": "completed",
"properties": null,
"errors": [ ]
},
"ops": [{"op": "add",
"path": "/transformations/0/params/segmentSelectors/selectors/-",
"value": {"type": "PLATFORM_SEGMENT",
"value": {"id": "42794d4a-a95e-432e-9cbf-7f61cc14ae2e",
"name": "Chaining Segment 1",
"description": "Chaining Segment 1",
"filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "FIRST_FULL_THEN_INCREMENTAL",
"schedule": {"startDate": "2022-07-20",
"frequency": "EVERY_3_HOURS",
"endDate": "2022-07-27",
"startTime": "20:00",
"triggerType": "SCHEDULED"
}
}
}
}
],
"operation": "update"
},
"lastRunDetails": {"id": "daa87aaa-6969-458d-bc41-609c52ebc2b1",
"state": "success",
"startedAtUTC": 1658430155398,
"completedAtUTC": 1658430160403
}
},
{"id": "d8ce03ea-d55c-4add-a56e-6e1c313e4250",
"createdAt": 1658340453699,
"updatedAt": 1658430188496,
"createdBy": "0A4334FA556587477F000101@AdobeID",
"updatedBy": "acp_foundation_connectors@AdobeID",
"createdClient": "exc_app",
"updatedClient": "acp_foundation_connectors",
"sandboxId": "6ef74723-3ee7-46a4-b747-233ee7a6a41a",
"sandboxName": "sample-platform-sandbox",
"imsOrgId": "5555467B5D8013E50A494220@AdobeOrg",
"name": "(Beta) S3 Segment Destination",
"description": "(Beta) S3 Segment Destination",
"flowSpec": {"id": "1a0514a6-33d4-4c7f-aff8-594799c47549",
"version": "1.0"
},
"state": "enabled",
"version": "\"0503aab5-0000-0200-0000-63756cd10000\"",
"etag": "\"0503aab5-0000-0200-0000-63756cd10000\"",
"sourceConnectionIds": ["aacb95f5-e451-4db6-bd72-de9845f9b1d0"
],
"targetConnectionIds": ["e609bd68-ef20-41f8-910d-7a8a4b177954"
],
"inheritedAttributes": {"properties": {"isDestinationFlow": true
},
"sourceConnections": [{"id": "aacb95f5-e451-4db6-bd72-de9845f9b1d0",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
},
"baseConnection": {"id": "be3e2d03-6134-4566-9865-c40e0df8b718",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
},
"typeInfo": {"type": "ProfileFragments",
"id": "ups"
}
}
],
"targetConnections": [{"id": "e609bd68-ef20-41f8-910d-7a8a4b177954",
"connectionSpec": {"id": "4fce964d-3f37-408f-9778-e597338a21ee",
"version": "1.0"
},
"baseConnection": {"id": "104c0cd4-31a8-4879-b913-96b609dad2c1",
"connectionSpec": {"id": "4fce964d-3f37-408f-9778-e597338a21ee",
"version": "1.0"
}
}
}
]
},
"transformations": [{"name": "GeneralTransform",
"params": {"mandatoryFields": ["ECID"
],
"primaryFields": [{"identityNamespace": "ECID",
"fieldType": "IDENTITY"
}
],
"profileMapping": {"mappingId": "5d21b87871df4f5ea93b436c5e8da224",
"mappingVersion": 0
},
"segmentSelectors": {"selectors": [{"type": "PLATFORM_SEGMENT",
"value": {"id": "25768be6-ebd5-45cc-8913-12fb3f348613",
"name": "Interested in Mountain Biking",
"description": "",
"filenameTemplate": "%DESTINATION%_%SEGMENT_ID%_%SEGMENT_NAME%_%DESTINATION_INSTANCE_ID%_%DESTINATION_INSTANCE_NAME%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "FIRST_FULL_THEN_INCREMENTAL",
"schedule": {"frequency": "EVERY_3_HOURS",
"triggerType": "SCHEDULED",
"startDate": "2022-11-15",
"endDate": "2022-11-23",
"startTime": "22:00"
},
"createTime": "1668548786",
"updateTime": "1668614587"
}
}
]
}
}
}
],
"runs": "/runs?property=flowId==d8ce03ea-d55c-4add-a56e-6e1c313e4250",
"lastOperation": {"started": 1668614587286,
"updated": 1668614594602,
"percentCompleted": 100,
"status": {"value": "completed",
"properties": null,
"errors": [ ]
},
"ops": [{"op": "replace",
"path": "/transformations/0/params/segmentSelectors/selectors/0",
"value": {"type": "PLATFORM_SEGMENT",
"value": {"id": "25768be6-ebd5-45cc-8913-12fb3f348613",
"name": "Interested in Mountain Biking",
"description": "",
"filenameTemplate": "%DESTINATION%_%SEGMENT_ID%_%SEGMENT_NAME%_%DESTINATION_INSTANCE_ID%_%DESTINATION_INSTANCE_NAME%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "FIRST_FULL_THEN_INCREMENTAL",
"schedule": {"startDate": "2022-11-15",
"frequency": "EVERY_3_HOURS",
"endDate": "2022-11-23",
"startTime": "22:00",
"triggerType": "SCHEDULED"
}
}
}
}
],
"operation": "update"
},
"lastRunDetails": {"id": "a18222fe-b5ef-48d5-acb5-835f25e6a7bb",
"state": "success",
"startedAtUTC": 1668639937828,
"completedAtUTC": 1668639937836
}
},
{"id": "7a6e996c-afcc-48ff-ab14-594321147cdd",
"createdAt": 1658340453699,
"updatedAt": 1658430188496,
"createdBy": "0A4334FA556585B77F000101@AdobeID",
"updatedBy": "acp_foundation_connectors@AdobeID",
"createdClient": "exc_app",
"updatedClient": "acp_foundation_connectors",
"sandboxId": "6ef74723-3ee7-46a4-b747-233ee7a6a41a",
"sandboxName": "sample-platform-sandbox",
"imsOrgId": "5555467B5D8013E50A494220@AdobeOrg",
"name": "(Beta) S3 Dataset Destination",
"description": "(Beta) S3 Dataset Destination",
"flowSpec": {"id": "269ba276-16fc-47db-92b0-c1049a3c131f",
"version": "1.0"
},
"state": "enabled",
"version": "\"050315a3-0000-0200-0000-63756c4d0000\"",
"etag": "\"050315a3-0000-0200-0000-63756c4d0000\"",
"sourceConnectionIds": ["8191fc9c-1e12-44c2-8d9a-bc40f5d81c9b"
],
"targetConnectionIds": ["f1d67830-7e4a-4e8a-8564-603542d5c596"
],
"inheritedAttributes": {"properties": {"isDestinationFlow": true
},
"sourceConnections": [{"id": "8191fc9c-1e12-44c2-8d9a-bc40f5d81c9b",
"connectionSpec": {"id": "23598e46-f560-407b-88d5-ea6207e49db0",
"version": "1.0"
}
}
],
"targetConnections": [{"id": "f1d67830-7e4a-4e8a-8564-603542d5c596",
"connectionSpec": {"id": "4fce964d-3f37-408f-9778-e597338a21ee",
"version": "1.0"
},
"baseConnection": {"id": "6893882d-ea98-4a12-b053-2a352852a8c9",
"connectionSpec": {"id": "4fce964d-3f37-408f-9778-e597338a21ee",
"version": "1.0"
}
}
}
]
},
"scheduleParams": {"interval": 3,
"timeUnit": "hour",
"startTime": 1668474000
},
"transformations": [ ],
"runs": "/runs?property=flowId==7a6e996c-afcc-48ff-ab14-594321147cdd",
"lastOperation": {"started": 1668539534731,
"updated": 1668539536003,
"percentCompleted": 100,
"status": {"value": "completed",
"properties": null,
"errors": [ ]
},
"ops": [{"op": "replace",
"path": "/sourceConnectionIds",
"value": ["8191fc9c-1e12-44c2-8d9a-bc40f5d81c9b"
]
},
{"op": "replace",
"path": "/scheduleParams",
"value": {"interval": 3,
"timeUnit": "hour",
"startTime": 1668474000
}
}
],
"operation": "update"
},
"lastRunDetails": {"id": "b4de770e-c350-4b29-b2a2-8e48213d21eb",
"state": "success",
"startedAtUTC": 1668639801888,
"completedAtUTC": 1668639806906
}
}
]
}

Create a destination dataflow

You can create a destination dataflow by making a POST request to the /flows endpoint.

Request

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, visit the authentication tutorial.
Content-type required	string Default: application/json The type of content being sent in the body of the request. Should be 'application/json'.
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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Request Body schema: application/json
required

One of:

Model for defining request body for create flow API.

name required	string (Flow Name) The name of the destination dataflow to be created.
description	string (Flow Description) The description provides information and details regarding the dataflow to be created.
required	object (Flow Spec) Model to capture the flow specification. Each destination has a specific flow spec ID in Experience Platform.
sourceConnectionIds required	Array of strings (Source Connection IDs) Add one source connection ID, which enables the connection to your Experience Platform data. Follow the step Connect to your Experience Platform data to learn how to obtain a source connection ID.
targetConnectionIds required	Array of strings (Target Connection IDs) Add one target connection ID, which enables the connection to your batch destination. Follow the step Connect to your batch destination to learn how to obtain a target connection ID.
required	Array of objects (Transformations) Transformation object to define the base structure for a destination dataflow. When creating a destination dataflow, leave the `profileSelectors`and `segmentSelectors` empty. You will add relevant values for them when using the `PATCH` request later.

Responses

201

Dataflow Created Successfully

401

Invalid Authorization Token

403

Authorization Error - Access Denied

500

Internal Server Error

post/flows

Request samples

Payload

application/json

{"name": "Activate segments to a batch destination",
"description": "This operation creates a dataflow which we will later use to activate segments to a batch destination (e.g. Amazon S3 or Adobe Campaign)",
"flowSpec": {"id": "{FLOW_SPEC_ID}",
"version": "1.0"
},
"sourceConnectionIds": ["{SOURCE_CONNECTION_ID}"
],
"targetConnectionIds": ["{TARGET_CONNECTION_ID}"
],
"transformations": [{"name": "GeneralTransform",
"params": {"segmentSelectors": {"selectors": [ ]
},
"profileSelectors": {"selectors": [ ]
}
}
}
]
}

Response samples

application/json

{"id": "ca5c6e9a-8559-4a08-97a5-f15b756da600",
"etag": "\"04000e7f-0000-0200-0000-62d9bca40000\""
}

Retrieve a destination dataflow's details

You can retrieve detailed information about a specific destination dataflow by making a GET request to the /flows endpoint and providing the ID of the dataflow you want to inspect.

Request

path Parameters

required

string

The ID of the destination dataflow you are looking to retrieve.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

200

Dataflow Details Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Dataflow ID Not Found

500

Internal Server Error

get/flows/{id}

Response samples

application/json

{"items": [{"id": "ca5c6e9a-8559-4a08-97a5-f15b756da600",
"createdAt": 1658340453699,
"updatedAt": 1658430188496,
"createdBy": "0A4334FA556585B77F000101@AdobeID",
"updatedBy": "acp_foundation_connectors@AdobeID",
"createdClient": "exc_app",
"updatedClient": "acp_foundation_connectors",
"sandboxId": "6ef74723-3ee7-46a4-b747-233ee7a6a41a",
"sandboxName": "sample-platform-sandbox",
"imsOrgId": "5555467B5D8013E50A494220@AdobeOrg",
"name": "Documentation S3 Destination",
"description": "Documentation S3 Destination",
"flowSpec": {"id": "71471eba-b620-49e4-90fd-23f1fa0174d8",
"version": "1.0"
},
"state": "enabled",
"version": "\"04001b6d-0000-0200-0000-62d9a2ec0000\"",
"etag": "\"04001b6d-0000-0200-0000-62d9a2ec0000\"",
"sourceConnectionIds": ["f3a5e232-eba3-428b-aa69-921d122d5db5"
],
"targetConnectionIds": ["54d575d8-43c9-4d3d-aec5-b033e4189f4a"
],
"inheritedAttributes": {"properties": {"isDestinationFlow": true
},
"sourceConnections": [{"id": "f3a5e232-eba3-428b-aa69-921d122d5db5",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
},
"baseConnection": {"id": "a9ae9a98-950d-468f-ac28-bc42bcd55d78",
"connectionSpec": {"id": "8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version": "1.0"
}
},
"typeInfo": {"type": "ProfileFragments",
"id": "ups"
}
}
],
"targetConnections": [{"id": "54d575d8-43c9-4d3d-aec5-b033e4189f4a",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
},
"baseConnection": {"id": "459779de-6f0a-46dd-9b64-10121316a8d9",
"connectionSpec": {"id": "4890fc95-5a1f-4983-94bb-e060c08e3f81",
"version": "1.0"
}
}
}
]
},
"transformations": [{"name": "GeneralTransform",
"params": {"profileSelectors": {"selectors": [{"type": "JSON_PATH",
"value": {"path": "person.name.firstName",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "person.name.firstName",
"destination": "person.name.firstName",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "person.name.firstName",
"destinationXdmPath": "person.name.firstName"
}
}
},
{"type": "JSON_PATH",
"value": {"path": "person.name.lastName",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "person.name.lastName",
"destination": "person.name.lastName",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "person.name.lastName",
"destinationXdmPath": "person.name.lastName"
}
}
},
{"type": "JSON_PATH",
"value": {"path": "personalEmail.address",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "personalEmail.address",
"destination": "personalEmail.address",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "personalEmail.address",
"destinationXdmPath": "personalEmail.address"
}
}
},
{"type": "JSON_PATH",
"value": {"path": "segmentMembership.status",
"operator": "EXISTS",
"mapping": {"sourceType": "text/x.schema-path",
"source": "segmentMembership.status",
"destination": "segmentMembership.status",
"identity": false,
"primaryIdentity": false,
"functionVersion": 0,
"sourceAttribute": "segmentMembership.status",
"destinationXdmPath": "segmentMembership.status"
}
}
}
],
"mandatoryFields": ["person.name.firstName",
"person.name.lastName"
],
"primaryFields": [{"fieldType": "ATTRIBUTE",
"attributePath": "personalEmail.address"
}
]
},
"segmentSelectors": {"selectors": [{"type": "PLATFORM_SEGMENT",
"value": {"id": "979558ae-a8ba-4e6e-b6ba-95c0a523b44a",
"name": "Combined First and Last Name Segment",
"description": "",
"filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "DAILY_FULL_EXPORT",
"schedule": {"frequency": "ONCE",
"triggerType": "SCHEDULED",
"startDate": "2022-07-22",
"startTime": "23:00"
},
"createTime": "1658344069",
"updateTime": "1658427026"
}
}
]
}
}
}
],
"runs": "/runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600",
"lastOperation": {"started": 1658427025696,
"updated": 1658427031832,
"percentCompleted": 100,
"status": {"value": "completed",
"properties": null,
"errors": [ ]
},
"ops": [{"op": "add",
"path": "/transformations/0/params/segmentSelectors/selectors/-",
"value": {"type": "PLATFORM_SEGMENT",
"value": {"id": "979558ae-a8ba-4e6e-b6ba-95c0a523b44a",
"name": "Combined First and Last Name Segment",
"description": "",
"filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "DAILY_FULL_EXPORT",
"schedule": {"startDate": "2022-07-22",
"frequency": "ONCE",
"startTime": "23:00",
"triggerType": "SCHEDULED"
}
}
}
}
],
"operation": "update"
},
"lastRunDetails": {"id": "daa87aaa-6969-458d-bc41-609c52ebc2b1",
"state": "success",
"startedAtUTC": 1658430155398,
"completedAtUTC": 1658430160403
}
}
]
}

Update a destination dataflow

You can update a destination dataflow by making a PATCH request to the /flows endpoint and providing the ID of the dataflow you want to update. In the body of the request, provide the updated configuration of the dataflow.

Request

path Parameters

required

string

The ID of the destination dataflow you are looking to update.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.
Content-type required	string Default: application/json The type of content being sent in the body of the request. Should be 'application/json'.
if-match required	string A header containing the eTag value of the entity to be updated (destination dataflow, base or target connection, etc.). Perform a GET request to return the latest eTag version of the entity. Note that you always need to wrap this header in double quotes when using it.

Request Body schema: application/json
required

Array

op required	string (PATCH operation) The operation that you are performing on the destination dataflow. You can add, replace, or remove items from destination dataflows. Enum: "add" "replace" "remove"
path required	string (Path) A json xpath where the value has to be added, updated, or removed.
required	Segment Selector (object) or Profile Selector (object) or (Beta) Segment Selector (object) or Enrichment Attribute Audience Selector (object) or Dataset Schedule Params (object) or (Beta) Profile Mapping (object) or (Array of (Beta) Primary Fields (Deduplication Keys) (Attribute Primary Field (object) or Identity Primary Field (object))) or Array of (Beta) Mandatory Fields (strings) Use the segment or profile selector to display the fields relevant to adding, updating, or removing segments or profile attributes in a destination dataflow. For Dataset dataflows, use the Schedule Params to control the dataset export schedule. For (Beta) segment dataflows, use the Segment Selectors to manage segments, Profile Mapping Set with Primary Fields and Mandatory Fields to manage profile attributes.

Responses

200

Dataflow Updated Successfully

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Dataflow ID Not Found

412

Precondition Failed - ETag Mismatch

500

Internal Server Error

patch/flows/{id}

Request samples

Payload

application/json

[{"op": "add",
"path": "/transformations/0/params/segmentSelectors/selectors/-",
"value": {"type": "PLATFORM_SEGMENT",
"value": {"id": "979558ae-a8ba-4e6e-b6ba-95c0a523b44a",
"name": "Combined First and Last Name Segment",
"description": "",
"filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "DAILY_FULL_EXPORT",
"schedule": {"startDate": "2022-07-22",
"frequency": "ONCE",
"startTime": "23:00",
"triggerType": "SCHEDULED"
}
}
}
}
]

Response samples

application/json

{"id": "ca5c6e9a-8559-4a08-97a5-f15b756da600",
"etag": "\"04000e7f-0000-0200-0000-62d9bca40000\""
}

Delete a destination dataflow

You can delete the specified destination dataflow by making a DELETE request to the /flows endpoint and providing the ID of the dataflow that you wish to delete in the request path.

Request

path Parameters

required

string

The ID of the destination dataflow you are looking to delete.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

202

Deletion Accepted - Dataflow Marked for Deletion

401

Invalid Authorization Token

403

Authorization Error - Access Denied

404

Not Found - Dataflow ID Not Found

500

Internal Server Error

delete/flows/{id}

Response samples

application/json

{"error_code": 401013,
"message": "Oauth token is not valid"
}

Dataflow runs

Dataflow runs represent an instance of a dataflow execution, which exports data to your destination. A dataflow run is specific to a dataflow and a segment for which the data export occurred. Furthermore, a run instance is specific to a tenant and organization.

Retrieve a list of destination dataflow runs

You can retrieve a list of all destination dataflow runs for your organization by making a GET request to the /runs endpoint. When performing listing (GET) requests in the Flow Service API, you can use query parameters to sort and filter responses.

For example, you can use query parameters to return only the dataflows runs for a particular segment ID or for a combination of segment ID and export status (Success, Processing, Waiting, Failed). To do this, use the property query parameter, as shown below.

NOTE: This operation allows you to retrieve a maximum of 100 entities. The most recently created or updated entities are returned first. Use filters to return the dataflow runs that are most relevant to you.

Request

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. Used to cut down the amount of data returned in the response body. Multiple property parameters can be passed to filter on more than one property. Refer examples below. Examples: Filter dataflow runs based on a particular segment ID. property=metrics.recordSummary.sourceSummaries[].id==<segmentId> Filter dataflow runs based on a particular segment ID and status. property=metrics.recordSummary.sourceSummaries[].id==<segmentId>& metrics.statusSummary.status==success
limit	integer Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`.
orderby	string Sort response by specified fields separated by `,` and/or prefix field with `-` for descending order.
count	boolean A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`).
continuationToken	string A token for fetching records for next page. This is a system-generated token.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
Accept	string Default: application/json; version=1 An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.

Responses

200

List of Dataflow Runs Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

500

Internal Server Error

get/runs

Response samples

application/json

{"items": [{"id": "e80e24c1-82de-48de-8352-b2d0fca1c392",
"createdAt": 1659018528378,
"updatedAt": 1659019046995,
"createdBy": "example_id@AdobeID",
"updatedBy": "example_id@AdobeID",
"createdClient": "exampleClient",
"updatedClient": "example_client",
"sandboxId": "d9df072c-2d5c-4247-9f07-2c2d5cd247b6",
"sandboxName": "prod",
"imsOrgId": "F0935E09512D2C270A490D4D@AdobeOrg",
"flowId": "df8d079d-11eb-466a-9731-6b5948a009e4",
"flowSpec": {"id": "71471eba-b620-49e4-90fd-23f1fa0174d8",
"version": "1.0"
},
"providerRefId": "fd3319ed56fdf9417d63d364a07b0105",
"etag": "\"b500a099-0000-0200-0000-62e29f270000\"",
"metrics": {"durationSummary": {"startedAtUTC": 1659018529865,
"completedAtUTC": 1659018929923
},
"sizeSummary": {"inputBytes": 855202780,
"outputBytes": 855202780
},
"recordSummary": {"inputRecordCount": 7823447,
"createdRecordCount": 7808223,
"outputRecordCount": 7808223,
"skippedRecordCount": 15224,
"sourceSummaries": [{"id": "1d6b7dc0-6d54-464e-abb3-54fb9701cb29",
"inputRecordCount": 7823447,
"skippedRecordCount": 15224,
"entitySummaries": [{"id": "segment:b1cbaff7-e7c6-417e-ab54-71d302595785",
"inputRecordCount": 7823447,
"skippedRecordCount": 15224
}
]
}
],
"targetSummaries": [{"id": "f876fe0d-4f6d-42e4-954c-bee1baa323eb",
"createdRecordCount": 7808223,
"outputRecordCount": 7808223,
"entitySummaries": [{"id": "segment:b1cbaff7-e7c6-417e-ab54-71d302595785",
"createdRecordCount": 7808223,
"outputRecordCount": 7808223
}
]
}
],
"skippedInfo": [{"code": "ACTIVATION_BATCH-0000-SKIP",
"message": "Records didn't match attribute filter.",
"count": 15224
}
]
},
"fileSummary": {"inputFileCount": 2,
"outputFileCount": 2
},
"statusSummary": {"status": "success",
"activityRefs": ["c4f238e3-7334-4933-8b56-64d7ea43ea54"
]
}
},
"activities": [{"id": "c4f238e3-7334-4933-8b56-64d7ea43ea54",
"name": "Activation Batch XdmProcessor Activity",
"updatedAtUTC": 0,
"durationSummary": {"startedAtUTC": 1659018529865,
"completedAtUTC": 1659018760787
},
"latencySummary": { },
"sizeSummary": {"inputBytes": 855202780,
"outputBytes": 855202780
},
"recordSummary": {"inputRecordCount": 7823447,
"createdRecordCount": 7808223,
"outputRecordCount": 7808223,
"skippedRecordCount": 15224,
"skippedInfo": [{"code": "ACTIVATION_BATCH-0000-SKIP",
"message": "Records didn't match attribute filter.",
"count": 15224
}
]
},
"fileSummary": {"inputFileCount": 2,
"outputFileCount": 2
},
"statusSummary": {"status": "success",
"extensions": {"incremental.batchId": "01G91S0ZGJ35TG4BQSAEA5VV5A,01G91R672VMKQWQS72BJ6PQJ3H",
"snapshot.batchId": "01G91QNJWFWD2588D4G4GZP9G1",
"snapshot.datasetId": "605dbe4e89b61819495e4dff",
"incremental.datasetId": "60ca216861dfad1948ecac24"
}
}
},
{"id": "51d82b36-6b8f-11eb-9439-0242ac130002",
"name": "Activation Batch Publisher Activity",
"updatedAtUTC": 0,
"durationSummary": {"startedAtUTC": 1659018767812,
"completedAtUTC": 1659018929923
},
"latencySummary": { },
"sizeSummary": {"outputBytes": 855202780
},
"recordSummary": {"inputRecordCount": 7808223,
"createdRecordCount": 7808223,
"outputRecordCount": 7808223,
"skippedRecordCount": 0
},
"fileSummary": {"outputFileCount": 2
},
"statusSummary": {"status": "success",
"extensions": { }
}
}
]
}
]
}

Configurations

Configurations provide additional information that is necessary when setting up a dataset export.

Retrieve a list of datasets for activation

You can use this endpoint to retrieve destinations-related configurations and metadata associated with a connection spec and are needed to successfully configure a dataset export. For example, when configuring dataset exports, this endpoint can return a list of activation-eligible datasets for your organization, along with metadata about the datasets.

Request

path Parameters

required

string

The ID of the connection spec. To return a list of dataset IDs eligible for export, use Experience Platform Data Lake source connection spec id, 23598e46-f560-407b-88d5-ea6207e49db0.

query Parameters

outputType required	string The type of configurations you want to retrieve. To return a list of dataset IDs eligible for export, use the value `activationDatasets`.
outputField required	string The output field where configuration values will be saved. To return a list of dataset IDs eligible for export, use the value `datasets`.
start	integer >= 0 Default: 0 Specify the offset for the list of datasets.
limit	integer [ 1 .. 100 ] Default: 20 Specify the maximum number of datasets to be included in the response.

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, visit 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, visit the authentication tutorial.
x-sandbox-name required	string All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

Responses

200

List of Eligible Datasets Retrieved

401

Invalid Authorization Token

403

Authorization Error - Access Denied

500

Internal Server Error

get/connectionSpecs/{id}/configs

Response samples

application/json

{"items": [{"id": "635865d23b3f261ba5a8589b",
"schemaRef": {"id": "https://ns.adobe.com/activationcontrolplaneint/schemas/36fcb097f2f3f000a0cb7ab355e3f9c2a2aa922fb28a6795",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
},
"name": "City Dataset",
"description": "A dataset of cities around the world",
"tags": {"unifiedIdentity": ["enabled:true"
]
},
"fileDescription": {"persisted": false,
"containerFormat": null,
"format": "parquet"
},
"aspect": "production",
"imsOrg": "5555467B5D8013E50A494220@AdobeOrg",
"sandboxId": "02dd69f0-da73-11e9-9ea1-af59ce7c24e8",
"version": "1.0.7",
"created": 1666737618845,
"updated": 1666737967289,
"createdClient": "exc_app",
"createdUser": "433E0A015D7AB86C0A49402B@AdobeID",
"updatedUser": "acp_foundation_dataTracker@AdobeID",
"viewId": "635865d23b3f261ba5a8589c",
"basePath": "abfss://gen1@datalakep1234356gn.dfs.core.windows.net/platform/635865d23b3f261ba5a8589b/datasetViewId=635865d23b3f261ba5a8589c",
"files": "@/dataSetFiles?dataSetId=635865d23b3f261ba5a8589b",
"enableErrorDiagnostics": false,
"lastBatchStatus": "success",
"lastBatchId": "01GG8N3TRVHC2Z7CQAY4YJ7Q2F",
"lastSuccessfulBatch": "01GG8N3TRVHC2Z7CQAY4YJ7Q2F"
}
]
}

Get credentials

Flow Service API - Destinations (1.0.0)

(NEW) Interactive API documentation

Glossary

Base connections

Retrieve a list of destination base connections

query Parameters

header Parameters

Create a target base connection

header Parameters

Request Body schema: application/jsonrequired

Retrieve the details of a base connection

path Parameters

header Parameters

Update a base connection

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Delete a base connection

path Parameters

header Parameters

Source connections

Retrieve a list of source connections for destinations

query Parameters

header Parameters

Create a source connection

header Parameters

Request Body schema: application/jsonrequired

Retrieve the details of a source connection

path Parameters

header Parameters

Delete a source connection

path Parameters

header Parameters

Target connections

Retrieve a list of destination target connections

query Parameters

header Parameters

Create a target connection

header Parameters

Request Body schema: application/jsonrequired

Retrieve the details of a target connection

path Parameters

header Parameters

Delete a target connection

path Parameters

header Parameters

Dataflows

Retrieve a list of destination dataflows

query Parameters

header Parameters

Create a destination dataflow

header Parameters

Request Body schema: application/jsonrequired

Retrieve a destination dataflow's details

path Parameters

header Parameters

Update a destination dataflow

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Delete a destination dataflow

path Parameters

header Parameters

Dataflow runs

Retrieve a list of destination dataflow runs

query Parameters

header Parameters

Configurations

Retrieve a list of datasets for activation

path Parameters

query Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required