{
  "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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n<tr><td>{{RType}}</td><td>required</td><td>string</td><td>Type of report:\r\n<code>1</code> or <code>8</code> Clicks\r\n<code>2</code> Forwards\r\n<code>3</code> Bounces\r\n<code>4</code> Complaints\r\n<code>5</code> Unsubscribes\r\n<code>6</code> Opens\r\n<code"
        },
        {
          "info": {
            "name": "Report Download",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://clientapi.benchmarkemail.com/Emails/:ID/:RType/Report/Download",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              },
              {
                "name": "RType",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Report Download</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n<tr><td>{{RType}}</td><td>required</td><td>string</td><td>Report Type</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Body Parameters (To be passed as a JSON string)</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\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": "<h4>GET Unsubscribe report By Email ID</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><t"
        },
        {
          "info": {
            "name": "Save as List",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://clientapi.benchmarkemail.com/Emails/SaveAsList"
          },
          "docs": "<h4>Save as List</h4>\r\n\r\n<h4>Body Parameters (To be passed as a JSON string)</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>EmailID</td><td>optional</td><td>string</td><td>Email ID</td></tr>\r\n<tr><td>EventID</td><td>optional</td><td>string</td><td>Event ID</td></tr>\r\n<tr><td>ABID</td><td>optional</td><td>string</td><td>AB ID</td></tr>\r\n<tr><td>RType</td><td>optional</td><td>string</td><td>Report Type</td></tr>\r\n<tr><t"
        },
        {
          "info": {
            "name": "GET Save as List ",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Emails/GetSaveAsList"
          },
          "docs": "<h4>GET Save as List</h4>\r\n\r\n<h4>Query String parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>EmailID</td><td>optional</td><td>string</td><td>ID of the EMail</td></tr>\r\n<tr><td>EventID</td><td>optional</td><td>string</td><td>ID of the Event</td></tr>\r\n<tr><td>ABID</td><td>optional</td><td>string</td><td>ID of the AB Test</td></tr>\r\n<tr><td>RType</td><td>optional</td><td>string</td><td>Report Type</td></tr>\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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Data</td><td><a href=\"http://www.benchmarkemail.com/models.htm#EmailReportSummaryData\">R"
        },
        {
          "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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>Count</td>"
        },
        {
          "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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>Count</td>"
        },
        {
          "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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>Count</td>"
        },
        {
          "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": "<h4>GET Bounces report By Email ID</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 error</td></tr>\r\n<tr><td>Count</td><td"
        },
        {
          "info": {
            "name": "GET Abuse report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Emails/Report/Abuse"
          },
          "docs": "<h4>GET Abuse report</h4>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 error</td></tr>\r\n<tr><td>Count</td><td>int</td><td>Total number</td></tr>\r\n<tr><td>TotalCount</td><td>string</td><td>Abuse Total</td></tr>\r\n<tr><td>Total</td><td>string</td><td>Abuse total</td></tr>\r\n<tr><td>YourComplaintRate</td><td>string</td><td>Abuse Percentage</td></tr>\r\n<tr><t"
        },
        {
          "info": {
            "name": "GET Social Performance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/SocialPerformance",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the EMail</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Query String parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Language</td><td>optional</td><td>string</td><td>Language</td></tr>\r\n<tr"
        },
        {
          "info": {
            "name": "GET Opens Location Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Opens/Location",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>Count</td>"
        },
        {
          "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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n<tr><td>{{CountryCode}}</td><td>required</td><td>string</td><td>Country Code</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>"
        },
        {
          "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": "<h4>GET Opens Hourly Report By Email ID</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><"
        },
        {
          "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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>Count</td>"
        },
        {
          "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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>Count</td>"
        },
        {
          "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": "<h4>GET Click Performance Details By Email ID</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Query String parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>PageNumber</td><td>optional</td><td>int</td><td>Page "
        },
        {
          "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": "<h4>GET Campaign History By Email ID</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>"
        },
        {
          "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": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Query String parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>filter</td><td>optional</td><td>int</td><td>ID of the link</td></tr>\r\n</"
        },
        {
          "info": {
            "name": "GET RSS History By Email ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Emails/:ID/RSSHistory",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>GET RSS History By Email ID</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>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": "<h4>GET URL List By Email ID</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Data</td><td>required</td><td><a href=\"http://www.benchmarkemail.com/models.htm#Client"
        },
        {
          "info": {
            "name": "Getting opens by country and region",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Report/Opens/:Country/:Region",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              },
              {
                "name": "Country",
                "value": "",
                "type": "path"
              },
              {
                "name": "Region",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ID}}</td><td>required</td><td>string</td><td>ID of the Email</td></tr>\r\n<tr><td>{{Country}}</td><td>required</td><td>string</td><td>Country</td></tr>\r\n<tr><td>{{Region}}</td><td>required</td><td>string</td><td>Region</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Query String parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th>"
        },
        {
          "info": {
            "name": "Get Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Emails/Report"
          },
          "docs": "<h4>Get Report</h4>\r\n\r\n<h4>Query String parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>PageNumber</td><td>optional</td><td>int</td><td>Page number</td></tr>\r\n<tr><td>PageSize</td><td>optional</td><td>int</td><td>Number of records to show per page</td></tr>\r\n<tr><td>ABFilter</td><td>optional</td><td>string</td><td>AB Filter</td></tr>\r\n<tr><td>FilterType</td><td>optional</td><td>string</td><td>Filter Type</td"
        },
        {
          "info": {
            "name": "Get Reports for Autoresponders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Automation/Report"
          },
          "docs": "Get Reports for Autoresponders\n<h4>Query String Parameter : </h4>\n<table>\n<thead>\n<tr>\n<th>Key</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>PageNumber</td>\n<td>optional</td>\n<td>Page Number</td>\n</tr>\n<tr>\n<td>PageSize</td>\n<td>optional</td>\n<td>Number of records to show per page</td>\n</tr>\n<tr>\n<td>Filter</td>\n<td>optional</td>\n<td>Filter for automation name</td>\n</tr>\n<tr>\n<td>OrderBy</td>\n<td>optional</td>\n<td>Column 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<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th>\r\n<th>Required</th>\r\n<th>Description</th>\r\n</tr>\r\n</thead>\r\n<tbody>\r\n<tr>\r\n<td>{{AutomationID}}</td>\r\n<td>Required</td>\r\n<td>Automation ID</a>\r\n</tr>\r\n</tbody>\r\n</table>\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Count</td><td>Int</td><td>Total count of emails for archive</td></tr>\r\n<tr><td>Status</td><td"
        },
        {
          "info": {
            "name": "Get the Results for the  AB Test",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/ABSplit/:ID/Results",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Update AB split\r\n<h4>URL parameters:</h4>\r\n<table>\r\n<tr>\r\n  <th>Parameter</th>\r\n  <th>Type</th>\r\n  <th>Description</th>\r\n</tr>\r\n<tr>\r\n  <td>ID</td>\r\n  <td>string</td>\r\n  <td>ABSplit ID</td>\r\n</tr>\r\n</table>\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>String</td><td>1 if success, -1 if error</td></tr>\r\n<tr><td>Results</td><td><a href=\"http://www.benchmarkemail.com/models.htm#ABResult\">ABR"
        },
        {
          "info": {
            "name": "GET  AB Test Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/ABSplit/Report"
          },
          "docs": "GET ABSplit Report\r\n<h4>URL body parameter (optional)</h4>\r\n  <table>\r\n    <tr>\r\n      <th>Parameter</th>\r\n      <th>Type</th>\r\n      <th>Description</th>\r\n    </tr>\r\n    <tr>\r\n      <td>PageNumber</td>\r\n      <td>string</td>\r\n      <td>Page Number</td>\r\n    </tr>\r\n    <tr>\r\n      <td>PageSize</td>\r\n      <td>string</td>\r\n      <td>Number of rows on the page</td>\r\n    </tr>\r\n    <tr>\r\n      <td>OrderBy</td>\r\n      <td>string</td>\r\n      <td>Order By Column Email,count,date</td>\r\n    </tr>\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<h4>URL parameters:</h4>\r\n<table>\r\n<tr>\r\n  <th>Parameter</th>\r\n  <th>Type</th>\r\n  <th>Description</th>\r\n</tr>\r\n<tr>\r\n  <td>ID</td>\r\n  <td>string</td>\r\n  <td>Final Unique ID</td>\r\n</tr>\r\n<tr>\r\n  <td>ABID</td>\r\n  <td>string</td>\r\n  <td>ABSplit ID</td>\r\n</tr>\r\n</table>\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>String</td><td>1 if success, -1 if error</td>"
        },
        {
          "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<h4>URL parameters:</h4>\r\n<table>\r\n<tr>\r\n  <th>Parameter</th>\r\n  <th>Type</th>\r\n  <th>Description</th>\r\n</tr>\r\n<tr>\r\n  <td>ID</td>\r\n  <td>string</td>\r\n  <td>ABSplit ID</td>\r\n</tr>\r\n</table>\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>String</td><td>1 if success, -1 if error</td></tr>\r\n<tr><td>Data</td><td><a href=\"http://www.benchmarkemail.com/models.htm"
        },
        {
          "info": {
            "name": "Get Report List of Survey",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Survey/ReportList",
            "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": "<h4>Get Report List of Survey</h4>\n<b>Query string parameters : </b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n    </thead>\n    <tbody>\n    <tr>\n      <td>PageNumber</td>\n      <td>Optional</td>\n      <td>int</td>\n      <td>Page Number</td>\n    </tr>\n    <tr>\n      <td>PageSize</td>\n      <td>Optional</td>\n      <td>int</td>\n      <td>Number of rows on the page</td>\n    </tr>\n    <tr>\n      <td>OrderBy</td"
        },
        {
          "info": {
            "name": "Get Report detail of Survey",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Survey/:SurveyID/ReportDetail",
            "params": [
              {
                "name": "SurveyID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Get Report detail of Survey</h4>\n<b>Query string parameters : </b> None <br>\n<b>Request Body Parameters : </b>\n<table >\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>SurveyID</td>\n      <td>Required</td>\n      <td>string</td>\n      <td>Survey ID</td>\n    </tr>\n  </tbody>\n</table>\n\n<b>Response Body Parameters : </b>\n<table >\n  <thead>\n    <tr>\n      <th>Parameter</th>\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": "<h4>Get Report Answer Text in Survey</h4>\n<b>Query string parameters : </b>\n<table>\n  <thead>\n    <tr>\n      <th>Key</th><th>Required</th><th>Type</th><th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr><td>QuestionID</td><td>required</td><td>int</td><td>ID of the question</td></tr>\n  </tbody>\n</table>\n<b>Request Body Parameters : </b>\n<table >\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>"
        },
        {
          "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": "<h4>Get Report Answer Comment in Survey</h4>\n<b>Query string parameters : </b>\n<table>\n<thead>\n<tr>\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\n</thead>\n<tbody>\n<tr><td>QuestionID</td><td>required</td><td>int</td><td>ID of the question</td></tr>\n</tbody>\n</table>\n<b>Request Body parameters : </b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>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": "<h4>Get ReportAnswerOther in Survey</h4>\n<b>Query string parameters : </b>\n<table>\n  <thead>\n    <tr>\n      <th>Key</th><th>Required</th><th>Type</th><th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr><td>QuestionID</td><td>required</td><td>int</td><td>ID of the question</td></tr>\n  </tbody>\n</table>\n<b>Request Body parameters : </b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\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": "<h4>Get Report of Survey Individual Result</h4>\n<b>Query string parameters : </b>\n<table>\n  <thead>\n    <tr>\n      <th>Key</th><th>Required</th><th>Type</th><th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr><td>PageNumber</td><td>optional</td><td>int</td><td>Page number</td></tr>\n    <tr><td>PageSize</td><td>optional</td><td>int</td><td>Number of records to show per page</td></tr>\n    <tr><td>Filter</td><td>optional</td><td>string</td><td>Filter</td></tr>\n    <tr><td>OrderBy</td><td>op"
        },
        {
          "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": "<h4>Get Individual Question Result Detail in Survey</h4>\n<b>Query string parameters : </b> None <br>\n<b>Request Body Parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>SurveyID</td>\n      <td>Required</td>\n      <td>string</td>\n      <td>Survey ID</td>\n    </tr>\n    <tr>\n      <td>EmailID</td>\n      <td>Required</td>\n      <td>string</td>\n      <td>Email 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": "<h4>Get a Full report Of Survey</h4>\n<b>Query String Parameters:</b> None <br>\n<b>Request Body Parameters : </b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>SurveyID</td>\n      <td>Required</td>\n      <td>string</td>\n      <td>Survey ID</td>\n    </tr>\n  </tbody>\n</table>\n<b>Response Body Parameters : </b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Ty"
        },
        {
          "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": "<h4>Get Poll response report</h4>\n<b>Query string parameters :</b> None <br>\n<b>Request Body parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>PollID</td>\n      <td>Required</td>\n      <td>String</td>\n      <td>Poll ID</td>\n    </tr>\n  </tbody>\n</table>\n\n<b>Response body parameters :</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Type</th>\n"
        }
      ]
    }
  ],
  "bundled": true
}