{ "opencollection": "1.0.0", "info": { "name": "Benchmark Email RESTful API v3.0 ABTest Creation Reports API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "AuthToken", "value": "{{AuthToken}}", "placement": "header" } }, "items": [ { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Get Report Download", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/:RType/Report/Download", "params": [ { "name": "ID", "value": "", "type": "path" }, { "name": "RType", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
{{RType}}requiredstringType of report:\r\n1 or 8 Clicks\r\n2 Forwards\r\n3 Bounces\r\n4 Complaints\r\n5 Unsubscribes\r\n6 Opens\r\nReport Download\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
{{RType}}requiredstringReport Type
\r\n\r\n

Body Parameters (To be passed as a JSON string)

\r\n\r\n\r\n\r\n\r\n<" }, { "info": { "name": "GET Unsubscribe report By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Unsubscribes", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

GET Unsubscribe report By Email ID

\r\n

URL Parameters

\r\n
KeyRequiredTypeDescription
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nSave as List\r\n\r\n

Body Parameters (To be passed as a JSON string)

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nGET Save as List\r\n\r\n

Query String parameters

\r\n
KeyRequiredTypeDescription
EmailIDoptionalstringEmail ID
EventIDoptionalstringEvent ID
ABIDoptionalstringAB ID
RTypeoptionalstringReport Type
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n" }, { "info": { "name": "GET Report Details By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n
KeyRequiredTypeDescription
EmailIDoptionalstringID of the EMail
EventIDoptionalstringID of the Event
ABIDoptionalstringID of the AB Test
RTypeoptionalstringReport Type
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
DataR" }, { "info": { "name": "GET Forwards report By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Forwards", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n" }, { "info": { "name": "GET Unopens report By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Unopens", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Count
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n" }, { "info": { "name": "GET Clicks report By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Clicks", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Count
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n" }, { "info": { "name": "GET Bounces report By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Bounces", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

GET Bounces report By Email ID

\r\n

URL Parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Count
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Co" }, { "info": { "name": "GET AbuseCampaign report By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/AbuseCampaign", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nGET Abuse report\r\n\r\n

Response body parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 error
Count
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nGet a list of contacts\r\n

URL Parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 error
CountintTotal number
TotalCountstringAbuse Total
TotalstringAbuse total
YourComplaintRatestringAbuse Percentage
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the EMail
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
FacebookSh" }, { "info": { "name": "GET Opens Report", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Opens", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Query String parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nGet a list of contacts\r\n

URL Parameters

\r\n
KeyRequiredTypeDescription
LanguageoptionalstringLanguage
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n" }, { "info": { "name": "GET Opens Location Report By Email ID and CountryCode", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Opens/Location/:CountryCode", "params": [ { "name": "ID", "value": "", "type": "path" }, { "name": "CountryCode", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Count
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
{{CountryCode}}requiredstringCountry Code
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
" }, { "info": { "name": "GET Opens Hourly Report By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Opens/Hourly", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

GET Opens Hourly Report By Email ID

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n<" }, { "info": { "name": "GET Click Performance By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/ClickPerformance", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n" }, { "info": { "name": "GET Click HeatMap By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Click/HeatMap", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Count
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n" }, { "info": { "name": "GET Click Performance Details By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/ClickPerformance/Details", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

GET Click Performance Details By Email ID

\r\n

URL Parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Count
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Query String parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
PageNumberoptionalintPage " }, { "info": { "name": "GET Campaign History By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/CampaignHistory", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

GET Campaign History By Email ID

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
" }, { "info": { "name": "GET Link Detail By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/LinkDetail", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Query String parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nGET RSS History By Email ID\r\n

URL Parameters

\r\n
KeyRequiredTypeDescription
filteroptionalintID of the link
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Count" }, { "info": { "name": "GET URL List By Email ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/URLList", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

GET URL List By Email ID

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
DatarequiredGet a list of contacts\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
{{Country}}requiredstringCountry
{{Region}}requiredstringRegion
\r\n\r\n

Query String parameters

\r\n\r\n\r\n\r\n" }, { "info": { "name": "Get Report", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/Report" }, "docs": "

Get Report

\r\n\r\n

Query String parameters

\r\n
Key
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
PageNumberoptionalintPage number
PageSizeoptionalintNumber of records to show per page
ABFilteroptionalstringAB Filter
FilterTypeoptionalstringFilter TypeQuery String Parameter : \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\n\n\n
KeyRequiredDescription
PageNumberoptionalPage Number
PageSizeoptionalNumber of records to show per page
FilteroptionalFilter for automation name
OrderByoptionalColumn by which to sort like name,schedule,email,sta" }, { "info": { "name": "Get Summary Report of an Automation", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Automation/:AutomationID/Report", "params": [ { "name": "AutomationID", "value": "", "type": "path" } ] }, "docs": "Get summary report of an Automation\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredDescription
{{AutomationID}}RequiredAutomation ID\r\n
\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nURL parameters:\r\n
KeyTypeDescription
CountIntTotal count of emails for archive
Status
\r\n\r\n \r\n \r\n \r\n\r\n\r\n \r\n \r\n \r\n\r\n
ParameterTypeDescription
IDstringABSplit ID
\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
StatusString1 if success, -1 if error
ResultsABR" }, { "info": { "name": "GET AB Test Report", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/ABSplit/Report" }, "docs": "GET ABSplit Report\r\n

URL body parameter (optional)

\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n <" }, { "info": { "name": "GET Report Details By AB Test ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/ABSplit/:ID/:ABID/Report", "params": [ { "name": "ID", "value": "", "type": "path" }, { "name": "ABID", "value": "", "type": "path" } ] }, "docs": "GET Report Details By ABSplit ID\r\n

URL parameters:

\r\n
ParameterTypeDescription
PageNumberstringPage Number
PageSizestringNumber of rows on the page
OrderBystringOrder By Column Email,count,date
\r\n\r\n \r\n \r\n \r\n\r\n\r\n \r\n \r\n \r\n\r\n\r\n \r\n \r\n \r\n\r\n
ParameterTypeDescription
IDstringFinal Unique ID
ABIDstringABSplit ID
\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n" }, { "info": { "name": "GET Compare report By AB Test ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/ABSplit/:ID/Compare", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "GET Report Details By ABSplit ID\r\n

URL parameters:

\r\n
KeyTypeDescription
StatusString1 if success, -1 if error
\r\n\r\n \r\n \r\n \r\n\r\n\r\n \r\n \r\n \r\n\r\n
ParameterTypeDescription
IDstringABSplit ID
\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
StatusString1 if success, -1 if error
DataGet Report List of Survey\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
PageNumberOptionalintPage Number
PageSizeOptionalintNumber of rows on the page
OrderByGet Report detail of Survey\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
ParameterRequiredTypeDescription
SurveyIDRequiredstringSurvey ID
\n\nResponse Body Parameters : \n\n \n \n \n <" }, { "info": { "name": "Get Report Answer Text in Survey", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Survey/:SurveyID/ReportAnswer/Text", "params": [ { "name": "SurveyID", "value": "", "type": "path" }, { "name": "QuestionID", "value": "", "type": "query" } ] }, "docs": "

Get Report Answer Text in Survey

\nQuery string parameters : \n
Parameter
\n \n \n \n \n \n \n \n \n
KeyRequiredTypeDescription
QuestionIDrequiredintID of the question
\nRequest Body Parameters : \n\n \n \n \n \n \n \n \n \n " }, { "info": { "name": "Get Report Answer Comment in Survey", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Survey/:SurveyID/ReportAnswer/Comment", "params": [ { "name": "SurveyID", "value": "", "type": "path" }, { "name": "QuestionID", "value": "", "type": "query" } ] }, "docs": "

Get Report Answer Comment in Survey

\nQuery string parameters : \n
ParameterRequiredTypeDescription
\n\n\n\n\n\n\n\n
KeyRequiredTypeDescription
QuestionIDrequiredintID of the question
\nRequest Body parameters : \n\n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
Surve" }, { "info": { "name": "Get ReportAnswerOther in Survey", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Survey/:SurveyID/ReportAnswer/Other", "params": [ { "name": "SurveyID", "value": "", "type": "path" }, { "name": "QuestionID", "value": "", "type": "query" } ] }, "docs": "

Get ReportAnswerOther in Survey

\nQuery string parameters : \n\n \n \n \n \n \n \n \n \n
KeyRequiredTypeDescription
QuestionIDrequiredintID of the question
\nRequest Body parameters : \n\n \n \n \n \n \n \n \n \n \n " }, { "info": { "name": "Get Report of Survey Individual Result", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Survey/:SurveyID/ReportIndividual", "params": [ { "name": "SurveyID", "value": "", "type": "path" }, { "name": "PageNumber", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "OrderBy", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" } ] }, "docs": "

Get Report of Survey Individual Result

\nQuery string parameters : \n
ParameterRequiredTypeDescription
\n \n \n \n \n \n \n \n \n \n
KeyRequiredTypeDescription
PageNumberoptionalintPage number
PageSizeoptionalintNumber of records to show per page
FilteroptionalstringFilter
OrderByop" }, { "info": { "name": "Get Individual Question Result Detail in Survey", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Survey/:SurveyID/ReportIndividual/:EmailID", "params": [ { "name": "SurveyID", "value": "", "type": "path" }, { "name": "EmailID", "value": "", "type": "path" } ] }, "docs": "

Get Individual Question Result Detail in Survey

\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
ParameterRequiredTypeDescription
SurveyIDRequiredstringSurvey ID
EmailIDRequiredstringEmail Addre" }, { "info": { "name": "Get full report of Survey", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Survey/:SurveyID/ReportFull", "params": [ { "name": "SurveyID", "value": "", "type": "path" } ] }, "docs": "

Get a Full report Of Survey

\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
ParameterRequiredTypeDescription
SurveyIDRequiredstringSurvey ID
\nResponse Body Parameters : \n\n \n \n \n
ParameterTy" }, { "info": { "name": "Get Poll response report", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Poll/:PollID/Response", "params": [ { "name": "PollID", "value": "", "type": "path" } ] }, "docs": "

Get Poll response report

\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
ParameterRequiredTypeDescription
PollIDRequiredStringPoll ID
\n\nResponse body parameters :\n\n \n \n \n \n" } ] } ], "bundled": true }
ParameterType