For more information on using API

GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/domains?Page={Page}&Limit={Limit}

Get a specific campaign's overview reports per domain.

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI (go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id int the URL)

integer

Required

page

Get a specific page (number of pages is limited)

integer

Range: inclusive between 1 and 2147483647

limit

Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records)

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

ApiCampaignDomainsList

Name

Description

Type

Additional information

total

Total domains

integer
campaign_domains

Campaign domains

Collection of ApiCampaignDomains

Response Formats

application/json, text/json

Sample: 
{
  "total": 1,
  "campaign_domains": [
    {
      "domain": "sample string 1",
      "opened_rate": 2.1,
      "opens": 3,
      "unopened_rate": 4.1,
      "unopened": 5,
      "clicks_rate": 6.1,
      "clickers": 7,
      "bounces": 8,
      "unsubscribes": 9,
      "spam_complaints": 10,
      "sent": 11
    },
    {
      "domain": "sample string 1",
      "opened_rate": 2.1,
      "opens": 3,
      "unopened_rate": 4.1,
      "unopened": 5,
      "clicks_rate": 6.1,
      "clickers": 7,
      "bounces": 8,
      "unsubscribes": 9,
      "spam_complaints": 10,
      "sent": 11
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiCampaignDomainsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.CampaignReport">
  <campaign_domains>
    <ApiCampaignDomains>
      <bounces>8</bounces>
      <clickers>7</clickers>
      <clicks_rate>6.1</clicks_rate>
      <domain>sample string 1</domain>
      <opened_rate>2.1</opened_rate>
      <opens>3</opens>
      <sent>11</sent>
      <spam_complaints>10</spam_complaints>
      <unopened>5</unopened>
      <unopened_rate>4.1</unopened_rate>
      <unsubscribes>9</unsubscribes>
    </ApiCampaignDomains>
    <ApiCampaignDomains>
      <bounces>8</bounces>
      <clickers>7</clickers>
      <clicks_rate>6.1</clicks_rate>
      <domain>sample string 1</domain>
      <opened_rate>2.1</opened_rate>
      <opens>3</opens>
      <sent>11</sent>
      <spam_complaints>10</spam_complaints>
      <unopened>5</unopened>
      <unopened_rate>4.1</unopened_rate>
      <unsubscribes>9</unsubscribes>
    </ApiCampaignDomains>
  </campaign_domains>
  <total>1</total>
</ApiCampaignDomainsList>