{ "opencollection": "1.0.0", "info": { "name": "Benchmark Email RESTful API v3.0 ABTest Creation Engagement API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "AuthToken", "value": "{{AuthToken}}", "placement": "header" } }, "items": [ { "info": { "name": "Engagement", "type": "folder" }, "items": [ { "info": { "name": "Get a Campaign List of Engagement", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Engagement/CampaignList", "params": [ { "name": "PageNumber", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "OrderBy", "value": "", "type": "query" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" } ] }, "docs": "

Get a Campaign List of Engagement

\nQuery string parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
PageNumberOptionalstringPage Number
PageSizeOptionalstringNumber of rows on the page
Or" }, { "info": { "name": "Get a URLList of Engagement", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Engagement/URLList", "params": [ { "name": "Filter", "value": "", "type": "query" }, { "name": "EmailIDs", "value": "", "type": "query" }, { "name": "PageNumber", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "OrderBy", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" } ] }, "docs": "

Get a URLList of Engagement

\nQuery string parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n " }, { "info": { "name": "Get a ClickURLContactCount of Engagement", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Engagement/ClickURLContactCount", "params": [ { "name": "CampaignURLList", "value": "", "type": "query" }, { "name": "ClickAll", "value": "", "type": "query" } ] }, "docs": "

Get a ClickURLContactCount of Engagement

\nQuery string parameters :\n
ParameterRequiredTypeDescription
EmailIDsRequiredstringList of Email Ids
PageNumberOptionalstringPage Number
PageSize
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
CampaignURLListRequiredstringCampaign URL List
ClickAllOptionalstring 
\n\nGet Click Contact Count\nQuery string parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
EmailIDListRequiredstringList of Email ID
FilterTypeRequiredstring1 (for Any)
\n\nResponse body " }, { "info": { "name": "Create List of Engagement", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Engagement/CreateList", "body": { "type": "json", "data": "{}" } }, "docs": "

Create List of Engagement

\nQuery string parameters : None
\nRequest Body Parameters\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n " }, { "info": { "name": "Get Non Contact Count", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Engagement/NonContactCount", "params": [ { "name": "EmailIDList", "value": "", "type": "query" }, { "name": "FilterType", "value": "", "type": "query" } ] }, "docs": "

Get Non Contact Count

\nQuery string parameters :\n
ParameterRequiredTypeNew List Name
ListNameRequiredstringNew List Name
TypeRequiredstringType of list
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
EmailIDListRequiredstringList of Email ID
FilterTypeRequiredstring1 (for Any)
\n\nResponse body pa" }, { "info": { "name": "Get Open Contact Count", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Engagement/OpenContactCount", "params": [ { "name": "EmailIDList", "value": "", "type": "query" }, { "name": "FilterType", "value": "", "type": "query" } ] }, "docs": "

Get Open Contact Count

\nQuery string parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
EmailIDListRequiredstringList of Email ID
FilterTypeRequiredstring1 (for Any)
\n\nResponse body p" } ] } ], "bundled": true }