For more information on using API

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

Get a specific user activity by Campaign id

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Campaign id

integer

Required

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

ApiEmailActivityReportsList

Name

Description

Type

Additional information

total_items

Total number of opened emails

integer
emails

List of all the contact who opened the email and when

Collection of ApiEmailActivityReports

Response Formats

application/json, text/json

Sample:
{
  "total_items": 1,
  "emails": [
    {
      "campaign_id": 1,
      "email_address": "sample string 2",
      "first_name": "sample string 3",
      "last_name": "sample string 4",
      "open_date": "2016-12-24T14:12:12",
      "total_opens": 6
    },
    {
      "campaign_id": 1,
      "email_address": "sample string 2",
      "first_name": "sample string 3",
      "last_name": "sample string 4",
      "open_date": "2016-12-24T14:12:12",
      "total_opens": 6
    }
  ]
}

application/xml, text/xml

Sample:
<ApiEmailActivityReportsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.CampaignReport">
  <emails>
    <ApiEmailActivityReports>
      <campaign_id>1</campaign_id>
      <email_address>sample string 2</email_address>
      <first_name>sample string 3</first_name>
      <last_name>sample string 4</last_name>
      <open_date>2016-12-24T14:12:12</open_date>
      <total_opens>6</total_opens>
    </ApiEmailActivityReports>
    <ApiEmailActivityReports>
      <campaign_id>1</campaign_id>
      <email_address>sample string 2</email_address>
      <first_name>sample string 3</first_name>
      <last_name>sample string 4</last_name>
      <open_date>2016-12-24T14:12:12</open_date>
      <total_opens>6</total_opens>
    </ApiEmailActivityReports>
  </emails>
  <total_items>1</total_items>
</ApiEmailActivityReportsList>