EDP Services
Overview
The EDP Services endpoint allows you to retrieve information about Segments created in the Engagement Data Platform.
-
Endpoint (North America): https://api.eccmp.com/services2/api/EdpService/Segments
-
Endpoint (Europe): https://api.ccmp.eu/services2/api/EdpService/Segments
-
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/EdpService/Segments
For more details on how to set up an EDP Services API request, please see the EDP Services API Technical Guide.
GET Method
The EDP Services endpoint supports the following GET operations. These operations are intended to retrieve information about EDP Segments.
Retrieve All Segments
This endpoint allows you to retrieve a list of all EDP Segments in your account.
Click hereClick here to see a sample response message in JSON format.
[
{
"name": "first_name_john",
"description": "",
"id": 1,
"label": "First Name John",
"filter": "",
"is_static": true,
"members_included": [],
"sql_query": "SELECT DISTINCT(MEMBERS.MEMBER_ID) FROM na394.member AS MEMBERS WHERE COALESCE(deactivated, false) = false AND MEMBERS.FIRST_NAME = 'John'",
"evaluation_path": {},
"execution_type": "hive",
"conditions": [],
"members_excluded": [],
"created_at": "2020-04-27T13:31:54Z",
"updated_at": "2020-07-11T04:39:53Z",
"published_at": "2020-04-27T13:40:25Z"
},
{
"name": "test_segment",
"description": "",
"id": 2,
"label": "Test Segment",
"filter": "",
"is_static": true,
"members_included": [],
"sql_query": "SELECT DISTINCT(MEMBERS.MEMBER_ID) FROM na394.member AS MEMBERS WHERE COALESCE(deactivated, false) = false AND MEMBERS.EMAIL = test@cheetahdigital.com'",
"evaluation_path": {},
"execution_type": "hive",
"conditions": [],
"members_excluded": [],
"created_at": "2020-05-06T05:59:44Z",
"updated_at": "2021-01-16T05:46:23Z",
"published_at": "2020-05-06T06:00:38Z"
},
{
"name": "ta_segment",
"description": "",
"id": 3,
"label": "TA Segment",
"filter": "",
"is_static": true,
"members_included": [],
"sql_query": "SELECT DISTINCT(MEMBERS.MEMBER_ID) FROM na394.member AS MEMBERS WHERE COALESCE(deactivated, false) = false AND MEMBERS.EMAIL = 'thomas.anderson@cheetahdigital.com'",
"evaluation_path": {},
"execution_type": "hive",
"conditions": [],
"members_excluded": [],
"created_at": "2020-07-03T04:51:04Z",
"updated_at": "2020-10-17T00:24:35Z",
"published_at": "2020-07-03T04:51:39Z"
}
]
Retrieve a Segment
This endpoint allows you to retrieve information about a single Segment by providing its Segment ID.
Click hereClick here to see a sample response message in JSON format.
{
"name": "ta_segment",
"description": "",
"id": 3,
"label": "TA Segment",
"is_static": true,
"members_included": [],
"conditions": [],
"members_excluded": [],
"published_at": "2020-07-03T04:51:39Z"
}
Back to API Category - Campaign Management