For more information on using API

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

Get campaign openers. You can choose to get all the openers from a specific group. You can limit the search to specific time (by default, the search will be for campaigns that were updated in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an empty list)

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

group_id

Group id. Can be found using the endpoint "Get account's groups" or in the UI (go to Contacts->Groups->click on the group's name -> you'll find the id int the URL)

integer
from_date

The start date the campaign was last updated

date
to_date

The end date the campaign was last updated

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. (Removing the "limit" will, by default, display only 20 records)

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

ApiCampaignOpensList

Name

Description

Type

Additional information

opens

Opens : contacts who opened your email

integer
total_open

The number of times the campaign has been opened (if a contact opened the email 3 times, it's counted as 3 opens).

integer
open_rate

Open Rate = Opens / Delivered (Delivered = Sent - Bounces).

decimal number
campaign_opens

List of campaign opens

Collection of ApiCampaignOpens

Response Formats

application/json, text/json

Sample: 
{
  "opens": 1,
  "total_open": 2,
  "open_rate": 3.1,
  "campaign_opens": [
    {
      "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: 
<ApiCampaignOpensList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.CampaignReport">
  <campaign_opens>
    <ApiCampaignOpens>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
    </ApiCampaignOpens>
    <ApiCampaignOpens>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
    </ApiCampaignOpens>
  </campaign_opens>
  <open_rate>3.1</open_rate>
  <opens>1</opens>
  <total_open>2</total_open>
</ApiCampaignOpensList>