For more information on using API

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

Get a full report of your campaigns that include: send date, opens, clicks, CTO, bounces, unsubscribers, complaints, unopened and sent emails. You can get campaigns filtered by date and limited to a number of campaigns (you will get the reports of camapigns that were last updated in the last 3 months by default)

Request Information

URI Parameters

Name

Description

Type

Additional information

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

Collection of 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
preview_content

Total number of sent emails

string

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,
    "preview_content": "sample string 4"
  },
  {
    "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,
    "preview_content": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfApiEmailCampaignReport xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ApiEmailCampaignReport>
    <CampaignID>1</CampaignID>
    <Name>sample string 2</Name>
    <LastSentDate>2016-12-24T14:12:12</LastSentDate>
    <ViewRate>1.1</ViewRate>
    <UniqueViews>1.1</UniqueViews>
    <UniqueLinks>1.1</UniqueLinks>
    <ClickRate>1.1</ClickRate>
    <Conversions>3</Conversions>
    <CTO>1.1</CTO>
    <total_conversion_value>1.1</total_conversion_value>
    <NotOpen>1.1</NotOpen>
    <Bounced>1.1</Bounced>
    <Removals>1.1</Removals>
    <SpamComplaints>1.1</SpamComplaints>
    <TotalSent>1.1</TotalSent>
    <PreviewContent>sample string 4</PreviewContent>
  </ApiEmailCampaignReport>
  <ApiEmailCampaignReport>
    <CampaignID>1</CampaignID>
    <Name>sample string 2</Name>
    <LastSentDate>2016-12-24T14:12:12</LastSentDate>
    <ViewRate>1.1</ViewRate>
    <UniqueViews>1.1</UniqueViews>
    <UniqueLinks>1.1</UniqueLinks>
    <ClickRate>1.1</ClickRate>
    <Conversions>3</Conversions>
    <CTO>1.1</CTO>
    <total_conversion_value>1.1</total_conversion_value>
    <NotOpen>1.1</NotOpen>
    <Bounced>1.1</Bounced>
    <Removals>1.1</Removals>
    <SpamComplaints>1.1</SpamComplaints>
    <TotalSent>1.1</TotalSent>
    <PreviewContent>sample string 4</PreviewContent>
  </ApiEmailCampaignReport>
</ArrayOfApiEmailCampaignReport>