Search
Overview
The Search endpoint (also referred to as the "Object" endpoint) allows you to search for, and retrieve information about a specified item, or object, within the platform. The different methods provide several different ways of searching for the desired item.
Endpoint (North America): https://api.eccmp.com/services2/api/Object
Endpoint (Europe): https://api.ccmp.eu/services2/api/Object
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/Object
For more details on how to set up a Search API request, please see the Search API Technical Guide.
GET Method
The Search endpoint supports the following GET operations. These operations are intended to retrieve information about an item.
Retrieve a List of All Item Types
This endpoint allows you to retrieve a list of all the valid item types.
Click hereClick here to see a sample response message in JSON format.
[
"Folder",
"CustHome",
"Entities",
"WebFiles",
"RecycleBin",
"MyFiles",
"SubCustomers",
"HostedItem",
"Customer",
"CustApi",
"CampMetaParamOption",
"WebEvent",
"SentimentRegex",
"PlatformEventSubscription",
"SalesforceAccount",
"FacebookAccount",
"FacebookApplication",
"FacebookPage",
"FacebookData",
"FacebookAdAudienceExport",
"FacebookAdAccountSetup",
"TwitterAccount",
"TwitterApplication",
"GoogleApplication",
"AnalyticsVendorConnectorGroup",
"OmnitureAnalyticsConnector",
"Push_Campaign",
"Push_Registration",
"LineAccountSetup",
"User",
"UserGroup",
"SecurityPolicy",
"FtpProfile",
"SmsSender",
"SmsKeywordGroup",
"SocialKeywordGroup",
"SmsKeyword",
"SocialKeyword",
"SenderProfile",
"SubscriptionList",
"Entity",
"DbDiagram",
"Property",
"PropertyMap",
"ViewTable",
"ViewCustom",
"ViewExport",
"ViewResponse",
"Import",
"FtpTemplate",
"ImportForm",
"ImportFormSfdc",
"ImportFormApi",
"HierarchyRule",
"PostalProcessNcoa",
"PostalProcessPresort",
"PrintPiece",
"Filter",
"Export",
"RecordLookup",
"Content",
"LiveImage",
"DataFileLayout",
"PageflexProject",
"ContentBlock",
"ParagraphUnsub",
"ParagraphSocial",
"ParagraphFblike",
"ParagraphGoogleplus",
"DynamicBlock",
"DynamicBlockData",
"LoopingBlock",
"ContSource",
"Link",
"LinkLibrary",
"LinkGroup",
"Attachement",
"CampCell",
"Campaign",
"CampaignEmail",
"CampaignSms",
"CampaignWeb",
"CampaignWebXml",
"CampaignHttp",
"CampaignDataFile",
"CampaignSocialFacebook",
"CampaignSocialTwitter",
"CampaignSocialFacebookAnon",
"CampaignSocialTwitterAnon",
"CampaignSocialFacebookAd",
"CampaignSocialLine",
"CampaignStub",
"CampaignControl",
"Program",
"ProgramCell",
"WebFeed",
"AuthenticationSet",
"ExclusionList",
"BncCat",
"UnsubCat",
"CustReplyProfile",
"CustForwardProfile",
"ProofList",
"DeliverabilityList",
"AlertList",
"SeedList",
"ProofListEmail",
"DeliverabilityListEmail",
"AlertListEmail",
"ProofListSms",
"AlertListSms",
"FromAddress",
"ProgramDomain",
"ReportCustom",
"ReportCampaign",
"ReportContent",
"ReportForm",
"ReportDatabase",
"ReportCompare",
"JasperReport",
"JasperDesigner",
"JasperDashboard",
"JasperDashboardDesigner",
"JasperReportDesigner",
"ResponseAttrSetup",
"ResponseAttrResults",
"ReportGoal",
"ReportSettings",
"WorkflowTemplate",
"WorkflowStep",
"Template",
"TemplateParagraph",
"TemplateDynamicBlock",
"CustomChannelType",
"Shortcut",
"Search",
"ApiCampaign",
"ApiRetrieve"
]
Retrieve an Item by Object ID
This endpoint allows you to retrieve an item by providing its Object ID.
Click hereClick here to see a sample response message in JSON format.
{
"obj_id": 45990,
"display_name": "Silver Rewards Content",
"type_id": "ContentBlock",
"ref_id": 52732,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
}
Retrieve an Item by Object Reference ID
This endpoint allows you to retrieve an item by providing its type and Object Reference ID.
Click hereClick here to see a sample response message in JSON format.
[
{
"obj_id": 46435,
"display_name": "Summer campaign audience",
"type_id": "Filter",
"ref_id": 37681,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
}
]
Retrieve Items by Name
This endpoint allows you to retrieve items by providing all or part of the display name.
Click hereClick here to see a sample response message in JSON format.
In this example, the user submitted a request message looking for all items containing the text string "summer" in the item name.
[
{
"obj_id": 46435,
"display_name": "Summer campaign audience",
"type_id": "Filter",
"ref_id": 37681,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
},
{
"obj_id": 45993,
"display_name": "Summer trigger campaign",
"type_id": "CampaignEmail",
"ref_id": 23448,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
},
{
"obj_id": 33167,
"display_name": "Button_Summer",
"type_id": "CampaignSocialLine",
"ref_id": 15052,
"parent_obj_id": 33017,
"eligibility_status_id": "READY"
},
{
"obj_id": 33168,
"display_name": "Button_Summer",
"type_id": "ReportCampaign",
"ref_id": 13862,
"parent_obj_id": 33017,
"eligibility_status_id": "DRAFT"
}
]
Retrieve Items by Item Type
This endpoint allows you to retrieve information about all items of a specified item type. Please see the GET method described above to retrieve a list of all the valid item types.
Click hereClick here to see a sample response message in JSON format.
In this example, the user submitted a request message looking for all items of the type "ContentBlock."
[
{
"obj_id": 46541,
"display_name": "Bronze Reward Content",
"type_id": "ContentBlock",
"ref_id": 53340,
"parent_obj_id": 55442,
"eligibility_status_id": "READY"
},
{
"obj_id": 46538,
"display_name": "Silver Reward Content",
"type_id": "ContentBlock",
"ref_id": 53337,
"parent_obj_id": 24826,
"eligibility_status_id": "READY"
},
{
"obj_id": 46515,
"display_name": "Gold Reward Content",
"type_id": "ContentBlock",
"ref_id": 53325,
"parent_obj_id": 27075,
"eligibility_status_id": "READY"
},
{
"obj_id": 45990,
"display_name": "Michigan content block",
"type_id": "ContentBlock",
"ref_id": 52732,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
},
{
"obj_id": 45963,
"display_name": "Indiana block",
"type_id": "ContentBlock",
"ref_id": 52704,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
},
{
"obj_id": 43953,
"display_name": "Illinois block",
"type_id": "ContentBlock",
"ref_id": 50378,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
}
]
Retrieve Items in a Folder
This endpoint allows you to retrieve information about all items in a Folder, of a specific item type. You must provide the Folder ID and a valid item type. You can also optionally further filter the results by providing all or part of the item name. Please see the GET method described above to retrieve a list of all the valid item types.
Click hereClick here to see a sample response message in JSON format.
In this example, the user submitted a request message looking for all items of the type "ContentBlock" within the Folder "37249."
[
{
"obj_id": 45990,
"display_name": "Michigan content block",
"type_id": "ContentBlock",
"ref_id": 52732,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
},
{
"obj_id": 45963,
"display_name": "Indiana block",
"type_id": "ContentBlock",
"ref_id": 52704,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
},
{
"obj_id": 43953,
"display_name": "Illinois block",
"type_id": "ContentBlock",
"ref_id": 50378,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
}
]
Back to API Category - Campaign Management