After signing in, you can create credentials that can be used to call the Platform APIs.
Download OpenAPI specification:Download
Adobe Experience Platform Segmentation Service provides a user interface and RESTful API that allows you to create audiences through segment definitions or other sources from your Real-Time Customer Profile data. These audiences are centrally configured and maintained on Platform, and are readily accessible by any Adobe solution. Use the Segmentation Service API to programmatically integrate the service's various functionalities into your experience application, providing RESTful endpoints for managing audiences, segment definitions, segment jobs, exports, schedules, and more.
Related documentation:
Visualize API calls with Postman (a free, third-party software):
API paths:
Required headers:
Authorization
, x-gw-ims-org-id
, and x-api-key
. For more information on how to obtain these values, see the authentication tutorial.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 overviewfor more information. Content-Type
with a value of application/json
.API error handling:
Audiences are a set of people, accounts, households, or other entities that share common characteristics and behaviors. This set can be generated either by using Platform or from external sources. More information about using this set of endpoints can be found in the audiences endpoint guide.
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. See the sandboxes overview for more information. |
Success
Missing access permissions
{- "children": [
- {
- "id": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "schema": {
- "name": "_xdm.context.profile"
}, - "profileInstanceId": "ups",
- "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
- "sandbox": {
- "sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "name": "People who ordered in the last 30 days",
- "description": "Last 30 days",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country=\"US\""
}, - "mergePolicyId": "ef006bbe-750e-4e81-85f0-0c6902192dcc",
- "evaluationInfo": {
- "batch": {
- "enabled": false
}, - "continuous": {
- "enabled": true
}, - "synchronous": {
- "enabled": false
}
}, - "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "isSystem": false,
- "creationTime": 1650374572000,
- "updateEpoch": 1650374573,
- "updateTime": 1650374573000,
- "createEpoch": 1650374572,
- "_etag": "\"33120d7c-0000-0200-0000-625eb7ad0000\"",
- "dependents": [ ],
- "definedOn": [
- {
- "meta:resourceType": "unions",
- "meta:containerId": "tenant",
}
], - "dependencies": [ ],
- "type": "SegmentDefinition",
- "originName": "REAL_TIME_CUSTOMER_PROFILE",
- "overridePerformanceWarnings": false,
- "createdBy": "audiences@AdobeId",
- "lifecycleState": "published",
- "labels": [
- "core/C1"
], - "namespace": "AEPSegments"
}
], - "_page": {
- "totalCount": 111,
- "pageSize": 2,
- "next": 1
}, - "_links": {
- "next": {
- "href": "@/audiences?start=1&limit=2&totalCount=111"
}
}
}
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 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. See the sandboxes overview for more information. |
The request body for creating an audience.
Success
Error
A sample body for creating an audience.
{- "name": "People who ordered in the last 30 days",
- "profileInstanceId": "ups",
- "description": "This audience is generated to see people who ordered in the last 30 days.",
- "type": "SegmentDefinition",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "schema": {
- "name": "_xdm.context.profile"
}, - "labels": [
- "core/C1"
]
}
A sample Platform-generated audience.
{- "id": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "schema": {
- "name": "_xdm.context.profile"
}, - "profileInstanceId": "ups",
- "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
- "sandbox": {
- "sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "isSystem": false,
- "name": "People who ordered in the last 30 days",
- "description": "This audience is generated to see people who ordered in the last 30 days.",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "mergePolicyId": "ef006bbe-750e-4e81-85f0-0c6902192dcc",
- "evaluationInfo": {
- "batch": {
- "enabled": false
}, - "continuous": {
- "enabled": true
}, - "synchronous": {
- "enabled": false
}
}, - "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 1650374572000,
- "updateEpoch": 1650374573,
- "updateTime": 1650374573000,
- "createEpoch": 1650374572,
- "_etag": "\"33120d7c-0000-0200-0000-625eb7ad0000\"",
- "dependents": [ ],
- "definedOn": [
- {
- "meta:resourceType": "unions",
- "meta:containerId": "tenant",
}
], - "dependencies": [ ],
- "type": "SegmentDefinition",
- "overridePerformanceWarnings": false,
- "createdBy": "audiences@AdobeId",
- "lifecycle": "active",
- "labels": [
- "core/C1"
], - "namespace": "AEPSegments"
}
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. See the sandboxes overview for more information. |
Success
Not found
A sample Platform-generated audience.
{- "id": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "schema": {
- "name": "_xdm.context.profile"
}, - "profileInstanceId": "ups",
- "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
- "sandbox": {
- "sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "isSystem": false,
- "name": "People who ordered in the last 30 days",
- "description": "This audience is generated to see people who ordered in the last 30 days.",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "mergePolicyId": "ef006bbe-750e-4e81-85f0-0c6902192dcc",
- "evaluationInfo": {
- "batch": {
- "enabled": false
}, - "continuous": {
- "enabled": true
}, - "synchronous": {
- "enabled": false
}
}, - "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 1650374572000,
- "updateEpoch": 1650374573,
- "updateTime": 1650374573000,
- "createEpoch": 1650374572,
- "_etag": "\"33120d7c-0000-0200-0000-625eb7ad0000\"",
- "dependents": [ ],
- "definedOn": [
- {
- "meta:resourceType": "unions",
- "meta:containerId": "tenant",
}
], - "dependencies": [ ],
- "type": "SegmentDefinition",
- "overridePerformanceWarnings": false,
- "createdBy": "audiences@AdobeId",
- "lifecycle": "active",
- "labels": [
- "core/C1"
], - "namespace": "AEPSegments"
}
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. See the sandboxes overview for more information. |
Success
Error
Missing access permissions
Not found
{ }
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 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. See the sandboxes overview for more information. |
A sample request body to update the PQL expression of the audience.
Success
Error
Not found
The following PATCH request will update the audience's workAddress.country to US.
[- {
- "op": "add",
- "path": "/expression",
- "value": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country= \"US\""
}
}
]
A sample Platform-generated audience.
{- "id": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "schema": {
- "name": "_xdm.context.profile"
}, - "profileInstanceId": "ups",
- "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
- "sandbox": {
- "sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "isSystem": false,
- "name": "People who ordered in the last 30 days",
- "description": "This audience is generated to see people who ordered in the last 30 days.",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "mergePolicyId": "ef006bbe-750e-4e81-85f0-0c6902192dcc",
- "evaluationInfo": {
- "batch": {
- "enabled": false
}, - "continuous": {
- "enabled": true
}, - "synchronous": {
- "enabled": false
}
}, - "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 1650374572000,
- "updateEpoch": 1650374573,
- "updateTime": 1650374573000,
- "createEpoch": 1650374572,
- "_etag": "\"33120d7c-0000-0200-0000-625eb7ad0000\"",
- "dependents": [ ],
- "definedOn": [
- {
- "meta:resourceType": "unions",
- "meta:containerId": "tenant",
}
], - "dependencies": [ ],
- "type": "SegmentDefinition",
- "overridePerformanceWarnings": false,
- "createdBy": "audiences@AdobeId",
- "lifecycle": "active",
- "labels": [
- "core/C1"
], - "namespace": "AEPSegments"
}
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 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. See the sandboxes overview for more information. |
The request body to update the audience.
Success
Error
Not found
Access control validation error
A sample request body for updating an audience's name.
{- "audienceId": "test-external-audience-id",
- "name": "New externalSegment",
- "namespace": "aam",
- "description": "This audience is generated to see people who ordered in the last 30 days.",
- "type": "ExternalSegment",
- "lifecycle": "published",
- "datasetId": "6254cf3c97f8e31b639fb14d",
- "labels": [
- "core/c1"
]
}
A sample Platform-generated audience.
{- "id": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
- "schema": {
- "name": "_xdm.context.profile"
}, - "profileInstanceId": "ups",
- "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
- "sandbox": {
- "sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "isSystem": false,
- "name": "People who ordered in the last 30 days",
- "description": "This audience is generated to see people who ordered in the last 30 days.",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "mergePolicyId": "ef006bbe-750e-4e81-85f0-0c6902192dcc",
- "evaluationInfo": {
- "batch": {
- "enabled": false
}, - "continuous": {
- "enabled": true
}, - "synchronous": {
- "enabled": false
}
}, - "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 1650374572000,
- "updateEpoch": 1650374573,
- "updateTime": 1650374573000,
- "createEpoch": 1650374572,
- "_etag": "\"33120d7c-0000-0200-0000-625eb7ad0000\"",
- "dependents": [ ],
- "definedOn": [
- {
- "meta:resourceType": "unions",
- "meta:containerId": "tenant",
}
], - "dependencies": [ ],
- "type": "SegmentDefinition",
- "overridePerformanceWarnings": false,
- "createdBy": "audiences@AdobeId",
- "lifecycle": "active",
- "labels": [
- "core/C1"
], - "namespace": "AEPSegments"
}
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 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. See the sandboxes overview for more information. |
A sample request body to retrieve multiple audiences.
Array of objects |
Success
Error
Not found
{- "ids": [
- {
- "id": "72c393ea-caed-441a-9eb6-5f66bb1bd6cd"
}, - {
- "id": "QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075"
}
]
}
{- "results": {
- "72c393ea-caed-441a-9eb6-5f66bb1bd6cd": {
- "id": "72c393ea-caed-441a-9eb6-5f66bb1bd6cd",
- "audienceId": "72c393ea-caed-441a-9eb6-5f66bb1bd6cd",
- "schema": {
- "name": "_xdm.context.profile"
}, - "imsOrgId": "{ORG_ID}",
- "sandbox": {
- "sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "name": "Sample Audience",
- "expression": {
- "type": "pql",
- "format": "pql/text",
- "value": "_id = \\\"abc\\\""
}, - "mergePolicyId": "87c94d51-239c-4391-932c-29c2412100e5",
- "evaluationInfo": {
- "batch": {
- "enabled": false
}, - "continuous": {
- "enabled": true
}, - "synchronous": {
- "enabled": false
}
}, - "ansibleUiEnabled": false,
- "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 1623889553000,
- "createEpoch": 1623889553,
- "updateTime": 1674646369000,
- "updateEpoch": 1674646369,
- "_etag": "\\\"61030ec7-0000-0200-0000-63d113610000\\\"",
- "dependents": [ ],
- "definedOn": [
- {
- "meta:resourceType": "unions",
- "meta:containerId": "tenant",
}
], - "dependencies": [ ],
- "type": "SegmentDefinition",
- "state": "enabled",
- "overridePerformanceWarnings": false,
- "lastModifiedBy": "{USER_ID}",
- "lifecycleState": "published",
- "namespace": "AEPSegments",
- "isSystem": false,
- "saveSegmentMembership": true,
- "originName": "REAL_TIME_CUSTOMER_PROFILE"
}, - "QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075": {
- "id": "QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
- "name": "External Audience",
- "namespace": "AO",
- "imsOrgId": "{ORG_ID}",
- "sandbox": {
- "sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "type": "ExternalSegment",
- "lifecycleState": "published",
- "sourceId": "source-id",
- "createdBy": "{USER_ID}",
- "datasetId": "62bf31a105e9891b63525c92",
- "_etag": "\\\"3100da6d-0000-0200-0000-62bf31a10000\\\"",
- "creationTime": 1656697249000,
- "createEpoch": 1656697249,
- "updateTime": 1656697249000,
- "updateEpoch": 1656697249,
- "audienceId": "external-audience-id",
- "isSystem": false,
- "saveSegmentMembership": true,
- "linkedAudienceRef": {
- "aoWorkflowId": "62bf31858e87e34c8364befa"
}, - "originName": "AUDIENCE_ORCHESTRATION"
}
}
}
Estimates provide statistical information on a segment definition, such as the projected audience size and confidence interval. More information about using this set of endpoints can be found in the previews and estimates endpoint guide.
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. See the sandboxes overview for more information. |
Success
Missing access permissions
Not found
Service unavailable
{- "estimatedSize": 35935,
- "numRowsToRead": 35935,
- "estimatedNamespaceDistribution": [
- {
- "namespaceId": "4",
- "profilesMatchedSoFar": 11986
}
], - "state": "RESULT_READY",
- "profilesReadSoFar": 35935,
- "standardError": 0,
- "error": {
- "description": "",
- "traceback": ""
}, - "profilesMatchedSoFar": 12123,
- "totalRows": 35935,
- "confidenceInterval": "95%",
}
Export jobs are asynchronous processes that are used to persist audience members to datasets. More information about using this set of endpoints can be found in the export jobs endpoint guide.
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. See the sandboxes overview for more information. |
Success
Missing access permissions
Service unavailable
{- "records": [
- {
- "id": 100,
- "jobType": "BATCH",
- "destination": {
- "datasetId": "5b7c86968f7b6501e21ba9df",
- "segmentPerBatch": false,
- "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52",
- "batches": {
- "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
- "segmentNs": "ups",
- "status": [
- "realized"
], - "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
}
}, - "fields": "identities.id,personalEmail.address",
- "schema": {
- "name": "_xdm.context.profile"
}, - "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
- "status": "SUCCEEDED",
- "filter": {
- "segments": [
- {
- "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
- "segmentNs": "ups",
- "status": [
- "realized"
]
}
], - "segmentQualificationTime": {
- "startTime": "2018-01-01T00:00:00Z",
- "endTime": "2018-02-01T00:00:00Z"
}, - "fromIngestTimestamp": "2018-01-01T00:00:00Z",
- "emptyProfiles": true
}, - "additionalFields": {
- "eventList": {
- "fields": "string",
- "filter": {
- "fromIngestTimestamp": "2018-01-01T00:00:00Z"
}
}
}, - "mergePolicy": {
- "id": "timestampOrdered-none-mp",
- "version": 1
}, - "profileInstanceId": "ups",
- "errors": [
- {
- "code": "0100000003",
- "msg": "Error in Export Job",
- "callStack": "com.adobe.aep.unifiedprofile.common.logging.Logger"
}
], - "metrics": {
- "totalTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}, - "profileExportTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}, - "aCPDatasetWriteTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}
}, - "computeGatewayJobId": {
- "exportJob": "f3058161-7349-4ca9-807d-212cee2c2e94",
- "pushJob": "feaeca05-d137-4605-aa4e-21d19d801fc6"
}, - "creationTime": 1538615973895,
- "updateTime": 1538616233239,
- "requestId": "d995479c-8a08-4240-903b-af469c67be1f"
}
], - "page": {
- "sortField": "createdTime",
- "sort": "desc",
- "pageOffset": 154097470130296,
- "pageSize": 10
}, - "link": {
- "next": "string"
}
}
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 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. See the sandboxes overview for more information. |
x-profile-instance-id | string The ID of the profile instance. Example: |
segmentID
. By default, status
will have the value ["realized", "existing"]
which represents all profiles that fall into the segment definition at the current time. Possible values include: "realized"
, "existing"
, and "exited"
.greater_than
operand.true
. If "emptyProfiles" is set to false
, only profiles with Profile records in the store are exported. By default, if "emptyProfiles" attribute is not included, only profiles containing Profile records are exported.Success
Missing access permissions
Service unavailable
{- "fields": "identities.id,personalEmail.address",
- "mergePolicy": {
- "id": "timestampOrdered-none-mp",
- "version": 1
}, - "filter": {
- "segments": [
- {
- "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
- "segmentNs": "ups",
- "status": [
- "realized"
]
}
], - "segmentQualificationTime": {
- "startTime": "2018-01-01T00:00:00Z",
- "endTime": "2018-02-01T00:00:00Z"
}, - "fromIngestTimestamp": "2018-01-01T00:00:00Z",
- "emptyProfiles": true
}, - "additionalFields": {
- "eventList": {
- "fields": "string",
- "filter": {
- "fromIngestTimestamp": "2018-01-01T00:00:00Z"
}
}
}, - "destination": {
- "datasetId": "5b7c86968f7b6501e21ba9df"
}, - "schema": {
- "name": "_xdm.context.profile"
}
}
{- "id": 100,
- "jobType": "BATCH",
- "destination": {
- "datasetId": "5b7c86968f7b6501e21ba9df",
- "segmentPerBatch": false,
- "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52",
- "batches": {
- "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
- "segmentNs": "ups",
- "status": [
- "realized"
], - "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
}
}, - "fields": "identities.id,personalEmail.address",
- "schema": {
- "name": "_xdm.context.profile"
}, - "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
- "status": "SUCCEEDED",
- "filter": {
- "segments": [
- {
- "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
- "segmentNs": "ups",
- "status": [
- "realized"
]
}
], - "segmentQualificationTime": {
- "startTime": "2018-01-01T00:00:00Z",
- "endTime": "2018-02-01T00:00:00Z"
}, - "fromIngestTimestamp": "2018-01-01T00:00:00Z",
- "emptyProfiles": true
}, - "additionalFields": {
- "eventList": {
- "fields": "string",
- "filter": {
- "fromIngestTimestamp": "2018-01-01T00:00:00Z"
}
}
}, - "mergePolicy": {
- "id": "timestampOrdered-none-mp",
- "version": 1
}, - "profileInstanceId": "ups",
- "errors": [
- {
- "code": "0100000003",
- "msg": "Error in Export Job",
- "callStack": "com.adobe.aep.unifiedprofile.common.logging.Logger"
}
], - "metrics": {
- "totalTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}, - "profileExportTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}, - "aCPDatasetWriteTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}
}, - "computeGatewayJobId": {
- "exportJob": "f3058161-7349-4ca9-807d-212cee2c2e94",
- "pushJob": "feaeca05-d137-4605-aa4e-21d19d801fc6"
}, - "creationTime": 1538615973895,
- "updateTime": 1538616233239,
- "requestId": "d995479c-8a08-4240-903b-af469c67be1f"
}
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. See the sandboxes overview for more information. |
Success
Missing access permissions
Not found
Service unavailable
{- "id": 100,
- "jobType": "BATCH",
- "destination": {
- "datasetId": "5b7c86968f7b6501e21ba9df",
- "segmentPerBatch": false,
- "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52",
- "batches": {
- "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
- "segmentNs": "ups",
- "status": [
- "realized"
], - "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
}
}, - "fields": "identities.id,personalEmail.address",
- "schema": {
- "name": "_xdm.context.profile"
}, - "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
- "status": "SUCCEEDED",
- "filter": {
- "segments": [
- {
- "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
- "segmentNs": "ups",
- "status": [
- "realized"
]
}
], - "segmentQualificationTime": {
- "startTime": "2018-01-01T00:00:00Z",
- "endTime": "2018-02-01T00:00:00Z"
}, - "fromIngestTimestamp": "2018-01-01T00:00:00Z",
- "emptyProfiles": true
}, - "additionalFields": {
- "eventList": {
- "fields": "string",
- "filter": {
- "fromIngestTimestamp": "2018-01-01T00:00:00Z"
}
}
}, - "mergePolicy": {
- "id": "timestampOrdered-none-mp",
- "version": 1
}, - "profileInstanceId": "ups",
- "errors": [
- {
- "code": "0100000003",
- "msg": "Error in Export Job",
- "callStack": "com.adobe.aep.unifiedprofile.common.logging.Logger"
}
], - "metrics": {
- "totalTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}, - "profileExportTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}, - "aCPDatasetWriteTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}
}, - "computeGatewayJobId": {
- "exportJob": "f3058161-7349-4ca9-807d-212cee2c2e94",
- "pushJob": "feaeca05-d137-4605-aa4e-21d19d801fc6"
}, - "creationTime": 1538615973895,
- "updateTime": 1538616233239,
- "requestId": "d995479c-8a08-4240-903b-af469c67be1f"
}
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. See the sandboxes overview for more information. |
Success
Missing access permissions
Not found
Service unavailable
{- "status": true,
- "message": "Export job has been marked for cancelling"
}
Previews provide paginated lists of qualifying profiles for a segment definition. More information about using this set of endpoints can be found in the previews and estimates endpoint guide
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 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. See the sandboxes overview for more information. |
Success
Missing access permissions
Service unavailable
{- "predicateExpression": "xEvent.metrics.commerce.abandons.value > 0",
- "predicateType": "pql/text",
- "predicateModel": "_xdm.context.profile",
- "graphType": "pdg"
}
{- "previewQueryId": "4a45e853-ac91-4bb7-a426-150937b6af5c",
- "state": "RUNNING",
- "previewQueryStatus": "RUNNING",
- "previewId": "MDoyOjRhNDVlODUzLWFjOTEtNGJiNy1hNDI2LTE1MDkzN2I2YWY1Yzo0Mg",
- "previewExecutionId": 42
}
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. See the sandboxes overview for more information. |
Success
Missing access permissions
Not found
Service unavailable
{- "page": { },
- "link": "string",
- "state": "string",
- "results": [
- {
- "objectId": "string",
- "_href": "string",
- "relatedObjects": [
- {
- "objectId": "string",
- "_href": "string"
}
]
}
]
}
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. See the sandboxes overview for more information. |
Success
Missing access permissions
Not found
Service unavailable
{- "status": true,
- "message": "string"
}
Create a recurring schedule to automatically run export jobs. A schedule can run at most once daily. More information about using this set of endpoints can be found in the schedules endpoint guide.
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. See the sandboxes overview for more information. |
x-request-id | string An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |
Success
Missing access permissions
Internal service error
Service unavailable
{- "_page": {
- "totalCount": 100,
- "pageSize": 100,
- "next": "1"
}, - "children": [
- {
- "id": "5e61e66e-e8b4-4a7b-8d41-70c74b0b981a",
- "name": "profile-default",
- "type": "batch_segmentation",
- "schedule": "0 0 1 * * ?",
- "state": "inactive",
- "properties": {
- "segments": [
- "*"
]
}, - "createEpoch": 1234567890,
- "updateEpoch": 1234567890
}
]
}
This endpoint is used to create a schedule, including specifying the time when the schedule should be triggered. Note that the scheduler is updated periodically (approximately every 30 minutes), so changes to a schedule may not go into effect immediately.
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 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. See the sandboxes overview for more information. |
x-request-id | string An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |
batch_segmentation
and export
.type
equals batch_segmentation
) Using [\"*\"]
ensures all segment definitions are included. - schedule: (Required) A string containing the job schedule. Jobs can only be scheduled to run once a day, meaning you cannot schedule a job to run more than once during a 24 hour period. The example shown (0 30 13 * * ?
) means the job is triggered every day at 13:30:00 UTC. For more information, please review the cron expression format documentation. - state: (Optional) String containing the schedule state. Available values: active
and inactive
. Default value is inactive
."name required | string The name of the schedule being created. |
type required | string The job type. |
required | object schedule properties |
schedule required | string A cron expression stating when the schedule should be triggered. Jobs can only be scheduled to run once a day, meaning you cannot schedule a job to run more than once during a 24 hour period. For more information, please review the cron expression format documentation. |
state | string The state of the schedule. If the schedule is inactive, it must be activated before it will be triggered. |
Success
Error
Missing access permissions
Internal service error
Service unavailable
{- "name": "profile-default",
- "type": "batch_segmentation",
- "properties": {
- "segments": [
- "*"
]
}, - "schedule": "0 0 1 * * ?",
- "state": "inactive"
}
{- "id": "5e61e66e-e8b4-4a7b-8d41-70c74b0b981a",
- "name": "profile-default",
- "type": "batch_segmentation",
- "schedule": "0 0 1 * * ?",
- "state": "inactive",
- "properties": {
- "segments": [
- "*"
]
}, - "createEpoch": 1234567890,
- "updateEpoch": 1234567890
}
The scheduler is updated periodically (approximately every 30 minutes), so changes to a schedule may not go into effect immediately.
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 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. See the sandboxes overview for more information. |
x-request-id | string An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |
Success
Missing access permissions
Not found
Service unavailable
{- "id": "5e61e66e-e8b4-4a7b-8d41-70c74b0b981a",
- "name": "profile-default",
- "type": "batch_segmentation",
- "schedule": "0 0 1 * * ?",
- "state": "inactive",
- "properties": {
- "segments": [
- "*"
]
}, - "createEpoch": 1234567890,
- "updateEpoch": 1234567890
}
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 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. See the sandboxes overview for more information. |
x-request-id | string An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |
Success
Missing access permissions
Not found
Service unavailable
This endpoint is ued to update a schedule, including changing the trigger time or enabling/disabling the schedule. Note that the scheduler is updated periodically (approximately every 30 minutes), so changes to a schedule may not go into effect immediately.
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 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. See the sandboxes overview for more information. |
x-request-id | string An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |
Use JSON Patch formatting to update the schedule. Note: You must use an "add" operation to add or update the given "path" with the given "value".
Success
Error
Missing access permissions
Rate limit
Internal service error
Service unavailable
[- {
- "op": "add",
- "path": "/state",
- "value": "active"
}
]
Segment definitions include a Profile Query Language (PQL) statement that defines which profiles will be part of an audience. More information about using this set of endpoints can be found in the segment definitions endpoint guide.
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. See the sandboxes overview for more information. |
x-request-id | string A unique ID that can be used to track a request. Example: jRot0Q3pgFi2lmLecebqHGTfnApAwVnQ |
Success
Missing access permissions
Service unavailable
{- "id": "54669488-03ab-4e0d-a694-37fe49e32be8",
- "imsOrgId": "{ORG_ID}",
- "name": "People who ordered in the last 30 days",
- "mergePolicyId": "5ed35fd8-6eeb-4ad2-bed9-43e695b8ac0b",
- "profileInstanceId": "ups",
- "description": "Last 30 days",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "schema": {
- "name": "_xdm.context.profile"
}, - "evaluationInfo": {
- "batch": {
- "enabled": true
}, - "continuous": {
- "enabled": false
}, - "synchronous": {
- "enabled": false
}
}, - "payloadSchema": "string",
- "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 0,
- "updateTime": 0,
- "updateEpoch": 0
}
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 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. See the sandboxes overview for more information. |
x-request-id | string A unique ID that can be used to track a request. Example: jRot0Q3pgFi2lmLecebqHGTfnApAwVnQ |
batch
is set to true
, it will be a segment definition evaluated using batch segmentation. If continuous
is set to true
, it will be a segment definition evaluated using streaming segmentation. If synchronous
is set to true
, it will be a segment definition evaluated using edge segmentation. By default, a segment definition evaluated using batch segmentation will be created.Success
Error
Missing access permissions
Already exists
Service unavailable
{- "name": "Sample segment definition",
- "description": "Sample description",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "evaluationInfo": {
- "batch": {
- "enabled": true
}, - "continuous": {
- "enabled": false
}, - "synchronous": {
- "enabled": false
}
}, - "schema": {
- "name": "_xdm.context.profile"
}, - "payloadSchema": "string"
}
{- "id": "54669488-03ab-4e0d-a694-37fe49e32be8",
- "imsOrgId": "{ORG_ID}",
- "mergePolicyId": "5ed35fd8-6eeb-4ad2-bed9-43e695b8ac0b",
- "profileInstanceId": "ups",
- "name": "Sample segment definition",
- "description": "Sample description",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "evaluationInfo": {
- "batch": {
- "enabled": true
}, - "continuous": {
- "enabled": false
}, - "synchronous": {
- "enabled": false
}
}, - "schema": {
- "name": "_xdm.context.profile"
}, - "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 0,
- "updateEpoch": 1579292094,
- "updateTime": 1579292094000,
- "payloadSchema": "string"
}
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. See the sandboxes overview for more information. |
x-request-id | string A unique ID that can be used to track a request. Example: jRot0Q3pgFi2lmLecebqHGTfnApAwVnQ |
Success
Missing access permissions
Not found
Service unavailable
{- "id": "54669488-03ab-4e0d-a694-37fe49e32be8",
- "imsOrgId": "{ORG_ID}",
- "name": "People who ordered in the last 30 days",
- "mergePolicyId": "5ed35fd8-6eeb-4ad2-bed9-43e695b8ac0b",
- "profileInstanceId": "ups",
- "description": "Last 30 days",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "schema": {
- "name": "_xdm.context.profile"
}, - "evaluationInfo": {
- "batch": {
- "enabled": true
}, - "continuous": {
- "enabled": false
}, - "synchronous": {
- "enabled": false
}
}, - "payloadSchema": "string",
- "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 0,
- "updateTime": 0,
- "updateEpoch": 0
}
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. See the sandboxes overview for more information. |
x-request-id | string A unique ID that can be used to track a request. Example: jRot0Q3pgFi2lmLecebqHGTfnApAwVnQ |
Success
Missing access permissions
Service unavailable
{- "status": true,
- "message": "string"
}
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 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. See the sandboxes overview for more information. |
x-request-id | string A unique ID that can be used to track a request. Example: jRot0Q3pgFi2lmLecebqHGTfnApAwVnQ |
Success
Error
Missing access permissions
Service unavailable
{- "id": "54669488-03ab-4e0d-a694-37fe49e32be8",
- "imsOrgId": "{ORG_ID}",
- "name": "People who ordered in the last 30 days",
- "mergePolicyId": "5ed35fd8-6eeb-4ad2-bed9-43e695b8ac0b",
- "profileInstanceId": "ups",
- "description": "Last 30 days",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "schema": {
- "name": "_xdm.context.profile"
}, - "evaluationInfo": {
- "batch": {
- "enabled": true
}, - "continuous": {
- "enabled": false
}, - "synchronous": {
- "enabled": false
}
}, - "payloadSchema": "string",
- "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 0,
- "updateTime": 0,
- "updateEpoch": 0
}
{- "id": "54669488-03ab-4e0d-a694-37fe49e32be8",
- "imsOrgId": "{ORG_ID}",
- "name": "People who ordered in the last 30 days",
- "mergePolicyId": "5ed35fd8-6eeb-4ad2-bed9-43e695b8ac0b",
- "profileInstanceId": "ups",
- "description": "Last 30 days",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "schema": {
- "name": "_xdm.context.profile"
}, - "evaluationInfo": {
- "batch": {
- "enabled": true
}, - "continuous": {
- "enabled": false
}, - "synchronous": {
- "enabled": false
}
}, - "payloadSchema": "string",
- "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 0,
- "updateTime": 0,
- "updateEpoch": 0
}
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 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. See the sandboxes overview for more information. |
An array of the segment definition IDs that you are trying to retrieve.
Array of objects |
Success
{- "ids": [
- {
- "id": "54669488-03ab-4e0d-a694-37fe49e32be8"
}, - {
- "id": "c527dc3f-07fe-4b96-be4e-23f38e734ff8"
}
]
}
{- "results": {
- "54669488-03ab-4e0d-a694-37fe49e32be8": {
- "id": "54669488-03ab-4e0d-a694-37fe49e32be8",
- "schema": {
- "name": "_xdm.context.profile"
}, - "profileInstanceId": "ups",
- "imsOrgId": "{ORG_ID}",
- "sandbox": {
- "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "name": "Sample segment definition 1",
- "description": "Sample segment definition description",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "evaluationInfo": {
- "batch": {
- "enabled": true
}, - "continuous": {
- "enabled": false
}, - "synchronous": {
- "enabled": false
}
}, - "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 0,
- "updateEpoch": 1579292094,
- "updateTime": 1579292094000
}, - "c527dc3f-07fe-4b96-be4e-23f38e734ff8": {
- "id": "c527dc3f-07fe-4b96-be4e-23f38e734ff8",
- "schema": {
- "name": "_xdm.context.profile"
}, - "profileInstanceId": "ups",
- "imsOrgId": "{ORG_ID}",
- "sandbox": {
- "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "name": "Sample segment definition 2",
- "description": "Another sample segment definition description",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \\\"US\\\""
}, - "evaluationInfo": {
- "batch": {
- "enabled": true
}, - "continuous": {
- "enabled": false
}, - "synchronous": {
- "enabled": false
}
}, - "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 0,
- "updateEpoch": 1579292094,
- "updateTime": 1579292094000
}
}
}
This endpoint converts a segment definition from pql/text to pql/json or from pql/json to pql/text.
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 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. See the sandboxes overview for more information. |
x-request-id | string A unique ID that can be used to track a request. Example: jRot0Q3pgFi2lmLecebqHGTfnApAwVnQ |
Success
Error
Conflict
Too many requests
Service unavailable
{- "id": "54669488-03ab-4e0d-a694-37fe49e32be8",
- "imsOrgId": "{ORG_ID}",
- "name": "People who ordered in the last 30 days",
- "mergePolicyId": "5ed35fd8-6eeb-4ad2-bed9-43e695b8ac0b",
- "profileInstanceId": "ups",
- "description": "Last 30 days",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "schema": {
- "name": "_xdm.context.profile"
}, - "evaluationInfo": {
- "batch": {
- "enabled": true
}, - "continuous": {
- "enabled": false
}, - "synchronous": {
- "enabled": false
}
}, - "payloadSchema": "string",
- "dataGovernancePolicy": {
- "excludeOptOut": true
}, - "creationTime": 0,
- "updateTime": 0,
- "updateEpoch": 0
}
Segment jobs process previously established segment definitions to generate an audience. More information about using this set of endpoints can be found in the segment jobs endpoint guide.
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. See the sandboxes overview for more information. |
x-request-id | string A unique ID that can be used to track a request. Example: q0gf6caRuRtX2s5khaN1Zgd1OoEXcPJA |
Success
Missing access permissions
Internal server error
Service unavailable
{- "_page": {
- "totalCount": 14,
- "pageSize": 14
}, - "children": {
- "id": "468eeefd-95a2-45a1-8bfc-b806dafce7ee",
- "imsOrgId": "E95186D65A28ABF00A495D82@AdobeOrg",
- "sandbox": {
- "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "profileInstanceId": "ups",
- "source": "scheduler",
- "status": "PROCESSING",
- "batchId": "65e18145-a5e8-4993-94f3-c70fadaa1fef",
- "computeJobId": 11037,
- "computeGatewayJobId": "9ea97b25-a0f5-410e-ae87-b2d85e58f399",
- "segments": [
- {
- "segmentId": "*"
}
], - "metrics": {
- "totalTime": {
- "startTimeInMs": 1573203617195,
- "endTimeInMs": 1573204395655,
- "totalTimeInMs": 778460
}, - "profileSegmentationTime": {
- "startTimeInMs": 1573204266727,
- "endTimeInMs": 1573204395655,
- "totalTimeInMs": 128928
}, - "totalProfiles": 13146432,
- "segmentedProfileCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": 1033
}, - "segmentedProfileByNamespaceCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": {
- "tenantiduserobjid": 1033,
- "campaign_profile_mscom_mkt_prod2": 1033
}
}, - "segmentedProfileByStatusCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": {
- "exited": 144646,
- "existing": 10,
- "realized": 2056
}
}, - "totalProfilesByMergePolicy": {
- "25c548a0-ca7f-4dcd-81d5-997642f178b9": 13146432
}
}, - "requestId": "4e538382-dbd8-449e-988a-4ac639ebe72b-1573203600264",
- "schema": {
- "name": "_xdm.context.profile"
}, - "properties": {
- "scheduleId": "4e538382-dbd8-449e-988a-4ac639ebe72b",
- "runId": "e6c1308d-0d4b-4246-b2eb-43697b50a149"
}, - "_links": {
- "cancel": {
- "href": "/segment/jobs/b31aed3d-b3b1-4613-98c6-7d3846e8d48f",
- "method": "DELETE"
}, - "checkStatus": {
- "href": "/segment/jobs/b31aed3d-b3b1-4613-98c6-7d3846e8d48f",
- "method": "GET"
}
}, - "updateTime": 1573204395000,
- "creationTime": 1573203600535,
- "updateEpoch": 1573204395
}, - "_links": {
- "next": { }
}
}
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 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. See the sandboxes overview for more information. |
x-profile-instance-id | string The ID of the Profile Instance. Example: Example: ups |
x-request-id | string A unique ID that can be used to track a request. Example: Example: q0gf6caRuRtX2s5khaN1Zgd1OoEXcPJA |
List of segment jobs. Each should be in JSON format.
Success
Error
Missing access permissions
Rate limit
Internal service error
Service unavailable
[- {
- "segmentId": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05"
}
]
{- "id": "468eeefd-95a2-45a1-8bfc-b806dafce7ee",
- "imsOrgId": "{IMG_ORG}",
- "sandbox": {
- "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
- "sandboxName": "prod",
- "type": "production",
- "default": "true"
}, - "profileInstanceId": "{PROFILE_INSTANCE}",
- "status": "PROCESSING",
- "batchId": "65e18145-a5e8-4993-94f3-c70fadaa1fef",
- "computeJobId": 1,
- "computeGatewayJobId": "c3505859-d256-45d0-a6f3-c25f8f8508f5",
- "creationTime": 1233456789000,
- "updateTime": 1233456789000,
- "segments": [
- {
- "segmentId": "7863c010-e092-41c8-ae5e-9e533186752e",
- "segment": {
- "id": "7863c010-e092-41c8-ae5e-9e533186752e",
- "version": 1,
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "mergePolicyId": "25c548a0-ca7f-4dcd-81d5-997642f178b9",
- "mergePolicy": {
- "id": "ups-default",
- "version": 1
}
}
}
], - "errors": [
- {
- "code": 80000018,
- "msg": "com.microsoft.azure.documentdb.DocumentClientException: Message: {\"Errors\":[\"Request rate is large\"]}",
- "callStack": "string"
}
], - "metrics": {
- "totalTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}, - "profileSegmentationTime": {
- "startTimeInMs": 123456789000,
- "endTimeInMs": 123456799000,
- "totalTimeInMs": 10000
}, - "totalProfiles": 1233456789000,
- "totalProfilesByMergePolicy": {
- "property1": 0,
- "property2": 0
}, - "segmentedProfileCounter": {
- "property1": 0,
- "property2": 0
}, - "segmentedProfileByNamespaceCounter": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "segmentedProfileByStatusCounter": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}
}, - "requestId": "cc3d3381-8682-41d4-93bd-566e378624d3",
- "modelName": "_xdm.context.profile",
- "_links": {
- "property1": "string",
- "property2": "string"
}
}
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. See the sandboxes overview for more information. |
x-request-id | string An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |
Success
Missing access permissions
Not found
Service unavailable
{- "id": "468eeefd-95a2-45a1-8bfc-b806dafce7ee",
- "imsOrgId": "E95186D65A28ABF00A495D82@AdobeOrg",
- "sandbox": {
- "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "profileInstanceId": "ups",
- "source": "scheduler",
- "status": "PROCESSING",
- "batchId": "65e18145-a5e8-4993-94f3-c70fadaa1fef",
- "computeJobId": 11037,
- "computeGatewayJobId": "9ea97b25-a0f5-410e-ae87-b2d85e58f399",
- "segments": [
- {
- "segmentId": "30230300-ccf1-48ad-8012-c5563a007069",
- "segment": {
- "id": "30230300-ccf1-48ad-8012-c5563a007069",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "mergePolicyId": "25c548a0-ca7f-4dcd-81d5-997642f178b9",
- "mergePolicy": {
- "id": "25c548a0-ca7f-4dcd-81d5-997642f178b9",
- "version": 1
}
}
}
], - "metrics": {
- "totalTime": {
- "startTimeInMs": 1573203617195,
- "endTimeInMs": 1573204395655,
- "totalTimeInMs": 778460
}, - "profileSegmentationTime": {
- "startTimeInMs": 1573204266727,
- "endTimeInMs": 1573204395655,
- "totalTimeInMs": 128928
}, - "totalProfiles": 13146432,
- "segmentedProfileCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": 1033
}, - "segmentedProfileByNamespaceCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": {
- "tenantiduserobjid": 1033,
- "campaign_profile_mscom_mkt_prod2": 1033
}
}, - "segmentedProfileByStatusCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": {
- "exited": 144646,
- "existing": 10,
- "realized": 2056
}
}, - "totalProfilesByMergePolicy": {
- "25c548a0-ca7f-4dcd-81d5-997642f178b9": 13146432
}
}, - "requestId": "4e538382-dbd8-449e-988a-4ac639ebe72b-1573203600264",
- "schema": {
- "name": "_xdm.context.profile"
}, - "properties": {
- "scheduleId": "4e538382-dbd8-449e-988a-4ac639ebe72b",
- "runId": "e6c1308d-0d4b-4246-b2eb-43697b50a149"
}, - "_links": {
- "cancel": {
- "href": "/segment/jobs/b31aed3d-b3b1-4613-98c6-7d3846e8d48f",
- "method": "DELETE"
}, - "checkStatus": {
- "href": "/segment/jobs/b31aed3d-b3b1-4613-98c6-7d3846e8d48f",
- "method": "GET"
}
}, - "updateTime": 1573204395000,
- "creationTime": 1573203600535,
- "updateEpoch": 1573204395
}
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. See the sandboxes overview for more information. |
x-request-id | string An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request. |
Success
Missing access permissions
Not found
Service unavailable
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 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. See the sandboxes overview for more information. |
An array of the segment jobs IDs that you are trying to retrieve.
Array of objects |
Success
{- "ids": [
- {
- "id": "cc3419d3-0389-47f1-b174-fead6b3c830d"
}, - {
- "id": "c527dc3f-07fe-4b96-be4e-23f38e734ff8"
}
]
}
{- "results": {
- "cc3419d3-0389-47f1-b174-fead6b3c830d": {
- "id": "cc3419d3-0389-47f1-b174-fead6b3c830d",
- "imsOrgId": "E95186D65A28ABF00A495D82@AdobeOrg",
- "sandbox": {
- "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "profileInstanceId": "ups",
- "status": "PROCESSING",
- "batchId": "651fc109-3963-48d2-aa98-9e3cc2003bac",
- "computeJobId": 39312,
- "computeGatewayJobId": "a0099ab6-11ab-4c2b-a0ea-6162e16806bd",
- "segments": [
- {
- "segmentId": "cc3419d3-0389-47f1-b174-fead6b3c830d",
- "segment": {
- "id": "cc3419d3-0389-47f1-b174-fead6b3c830d,",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "mergePolicyId": "25c548a0-ca7f-4dcd-81d5-997642f178b9",
- "mergePolicy": {
- "id": "25c548a0-ca7f-4dcd-81d5-997642f178b9,",
- "version": 1
}
}
}
], - "metrics": {
- "totalTime": {
- "startTimeInMs": 1573203617195,
- "endTimeInMs": 1573204395655,
- "totalTimeInMs": 778460
}, - "profileSegmentationTime": {
- "startTimeInMs": 1573204266727,
- "endTimeInMs": 1573204395655,
- "totalTimeInMs": 128928
}, - "totalProfiles": 13146432,
- "segmentedProfileCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": 1033
}, - "segmentedProfileByNamespaceCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": {
- "tenantiduserobjid": 1033,
- "campaign_profile_mscom_mkt_prod2": 1033
}
}, - "segmentedProfileByStatusCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": {
- "exited": 144646,
- "existing": 10,
- "realized": 2056
}
}, - "totalProfilesByMergePolicy": {
- "25c548a0-ca7f-4dcd-81d5-997642f178b9": 13146432
}
}, - "updateTime": 1573204395000,
- "creationTime": 1573203600535
}, - "c527dc3f-07fe-4b96-be4e-23f38e734ff8": {
- "id": "c527dc3f-07fe-4b96-be4e-23f38e734ff8",
- "imsOrgId": "E95186D65A28ABF00A495D82@AdobeOrg",
- "sandbox": {
- "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
- "sandboxName": "prod",
- "type": "production",
- "default": true
}, - "status": "SUCCEEDED",
- "segments": [
- {
- "segmentId": "c527dc3f-07fe-4b96-be4e-23f38e734ff8",
- "segment": {
- "id": "c527dc3f-07fe-4b96-be4e-23f38e734ff8",
- "expression": {
- "type": "PQL",
- "format": "pql/text",
- "value": "workAddress.country = \"US\""
}, - "mergePolicyId": "25c548a0-ca7f-4dcd-81d5-997642f178b9",
- "mergePolicy": {
- "id": "25c548a0-ca7f-4dcd-81d5-997642f178b9",
- "version": 1
}
}
}
], - "metrics": {
- "totalTime": {
- "startTimeInMs": 1573203617195,
- "endTimeInMs": 1573204395655,
- "totalTimeInMs": 778460
}, - "profileSegmentationTime": {
- "startTimeInMs": 1573204266727,
- "endTimeInMs": 1573204395655,
- "totalTimeInMs": 128928
}, - "totalProfiles": 13146432,
- "segmentedProfileCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": 1033
}, - "segmentedProfileByNamespaceCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": {
- "tenantiduserobjid": 1033,
- "campaign_profile_mscom_mkt_prod2": 1033
}
}, - "segmentedProfileByStatusCounter": {
- "94509dba-7387-452f-addc-5d8d979f6ae8": {
- "exited": 144646,
- "existing": 10,
- "realized": 2056
}
}, - "totalProfilesByMergePolicy": {
- "25c548a0-ca7f-4dcd-81d5-997642f178b9": 13146432
}
}, - "updateTime": 1573204395000,
- "creationTime": 1573203600535
}
}
}
Segment search allows users to search across multiple namespaces or get specific structural information about specified objects. More information about using this set of endpoints can be found in the segment search endpoint guide.
This endpoint is used to retrieve a list of search count results, which is queried across all namespaces.
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. See the sandboxes overview for more information. |
x-ups-search-version | string The version of the Search API used. The only supported version is Example: 1.0 |
Success
Missing access permissions
Service unavailable
{- "namespaces": [
- {
- "namespace": "AAMTraits",
- "displayName": "AAMTraits",
- "count": 45
}, - {
- "namespace": "AAMSegments",
- "displayName": "AAMSegments",
- "count": 10
}, - {
- "namespace": "SegmentsAISegments",
- "displayName": "SegmentsAISegments",
- "count": 3
}
], - "totalCount": "3",
- "status": {
- "message": "Success"
}
}
This endpoint retrieves a list of all full text indexed objects contained within a namespace.
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. See the sandboxes overview for more information. |
x-ups-search-version | string The version of the Search API used. The only supported version is Example: 1.0 |
Success
Missing access permissions
Service unavailable
{- "entities": [
- {
- "id": "folder2",
- "base64EncodedSourceId": "REZrcUMyX3Vmb2xkZXIyLUFBTVNlZ21lbnRzQS01ZTBlMjU2MzQyYzI0ZjE4YWQyZDc1MDg1",
- "sourceId": { },
- "isFolder": true,
- "parentFolderId": "root",
- "name": "Segment definition that targets males age 45 to 50 living on the west coast",
- "description": "Under development, targeting east coast millionaires that buy red cars."
}
], - "page": {
- "totalCount": 20323,
- "totalPages": 100,
- "pageOffset": 0,
- "pageSize": 10
}, - "status": {
- "message": "Search system is not setup correctly."
}
}
Show the search object's organization
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. See the sandboxes overview for more information. |
x-ups-search-version | string The version of the Search API used. Example: 1.0 |
Success
Missing access permissions
Service unavailable
{- "taxonomy": [
- {
- "id": "carTraits",
- "base64EncodedSourceId": "RFVGamdpRk1BZy01ZTY4MzBmYzM5N2I0NTE4YWFhMWEwOGY1",
- "name": "AAMTraits for Cars",
- "parentFolderId": "root"
}, - {
- "id": "fastCarsFolder",
- "base64EncodedSourceId": "RFVGZ01BLTVlNjgzMGZjMzk3YjQ1MThhYWExYTA4Zg2",
- "name": "Fast Cars",
- "parentFolderId": "carTraits"
}, - {
- "id": "porsche",
- "base64EncodedSourceId": "REFGZ01CLTVlNjczMGZjMzk3YjQ1MThhZGIxYTA4Zg==",
- "name": "Porshe",
- "parentFolderId": "redCarsFolderId"
}
], - "status": {
- "message": "Cannot find entityId redcarsFolderId."
}
}