For more information on using API

GET http://webapi.mymarketing.co.il/api/campaignreports/{id}/unopened?Groupid={Groupid}&FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}

Get a Campaign Unopened

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Campaign id

integer

Required

group_id

Filter by Group id

integer
from_date

The first date the contacts you want were created

date
to_date

The last date the contacts you want were created.(Default values is 3 last months)

date
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.

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

ApiCampaignUnopenedList

Name

Description

Type

Additional information

unopened

Unopened = Emails that were delivered to the contact's inbox, but not opened.

integer
unopened_rate

Unopened Rate = Unopened / Sent.

decimal number
campaign_unopened

List of campaign unopened

Collection of ApiCampaignUnopened

Response Formats

application/json, text/json

Sample: 
{
  "unopened": 1,
  "unopened_rate": 2.1,
  "campaign_unopened": [
    {
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "email": "sample string 3"
    },
    {
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "email": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiCampaignUnopenedList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.CampaignReport">
  <campaign_unopened>
    <ApiCampaignUnopened>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
    </ApiCampaignUnopened>
    <ApiCampaignUnopened>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
    </ApiCampaignUnopened>
  </campaign_unopened>
  <unopened>1</unopened>
  <unopened_rate>2.1</unopened_rate>
</ApiCampaignUnopenedList>