For more information on using API

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

Get an overview report for a campaign

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

ApiEmailCampaignReport

Name

Description

Type

Additional information

campaign_id

Capmaign id

integer
campaign_name

Campaign Name

string
last_sent_date

Last date the campaign was sent

date
view_rate

View rate

decimal number
opens

View opens

decimal number
clicks

View clicks

decimal number
click_rate

Click rate

decimal number
conversions

Capmaign id

integer
cto

Click rate from the emails that were opened

decimal number
total_conversion_value

Money recieved from conversion pixle you put in the campaign

decimal number
not_open

Rate of emails that were not opened

decimal number
bounced

Bounce rate

decimal number
removals

Number of removals

decimal number
spam_complaints

Number of spam complaints

decimal number
total_sent

Total number of sent emails

decimal number

Response Formats

application/json, text/json

Sample:
{
  "campaign_id": 1,
  "campaign_name": "sample string 2",
  "last_sent_date": "2016-12-24T14:12:12",
  "view_rate": 1.1,
  "opens": 1.1,
  "clicks": 1.1,
  "click_rate": 1.1,
  "conversions": 3,
  "cto": 1.1,
  "total_conversion_value": 1.1,
  "not_open": 1.1,
  "bounced": 1.1,
  "removals": 1.1,
  "spam_complaints": 1.1,
  "total_sent": 1.1
}

application/xml, text/xml

Sample:
<ApiEmailCampaignReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.AutomationReport">
  <bounced>1.1</bounced>
  <campaign_id>1</campaign_id>
  <campaign_name>sample string 2</campaign_name>
  <click_rate>1.1</click_rate>
  <clicks>1.1</clicks>
  <conversions>3</conversions>
  <cto>1.1</cto>
  <last_sent_date>2016-12-24T14:12:12</last_sent_date>
  <not_open>1.1</not_open>
  <opens>1.1</opens>
  <removals>1.1</removals>
  <spam_complaints>1.1</spam_complaints>
  <total_conversion_value>1.1</total_conversion_value>
  <total_sent>1.1</total_sent>
  <view_rate>1.1</view_rate>
</ApiEmailCampaignReport>