For more information on using API

GET https://webapi.mymarketing.co.il/api/automationreports/{id}/automationwhatsappcampaignstatistic?FromDate={FromDate}&ToDate={ToDate}

Get Whatsapp campaigns statistics for a specific automation.

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id int the URL)

integer

Required

Body Parameters

None.

Response Information

Resource Description

ApiWhatsAppCampaignReportInfoList

Name

Description

Type

Additional information

totalitems

integer
count

integer
campaignreportslist

Collection of ApiWhatsAppCampaignReportInfo

Response Formats

application/json, text/json

Sample: 
{
  "totalitems": 2,
  "count": 2,
  "campaignreportslist": [
    {
      "campaignid": "ed167b47-eb86-43fb-8fe0-3d59fb6f43ff",
      "campaignname": "sample string 2",
      "sentdate": "2016-12-24T14:12:12",
      "senttype": 1,
      "totalclicks": 3,
      "clickers": 4,
      "unsubscribe": 5,
      "unsubscribePercentage": 6.1,
      "failed": 7,
      "failedPercentage": 8.1,
      "totalsent": 9,
      "opens": 10,
      "openedPercentage": 11.1,
      "total_revenue": 12.1,
      "purchases": 13,
      "failed_rate": 14.1,
      "unsub_rate": 15.1,
      "clicked_rate": 16.1,
      "cto": 17.1
    },
    {
      "campaignid": "ed167b47-eb86-43fb-8fe0-3d59fb6f43ff",
      "campaignname": "sample string 2",
      "sentdate": "2016-12-24T14:12:12",
      "senttype": 1,
      "totalclicks": 3,
      "clickers": 4,
      "unsubscribe": 5,
      "unsubscribePercentage": 6.1,
      "failed": 7,
      "failedPercentage": 8.1,
      "totalsent": 9,
      "opens": 10,
      "openedPercentage": 11.1,
      "total_revenue": 12.1,
      "purchases": 13,
      "failed_rate": 14.1,
      "unsub_rate": 15.1,
      "clicked_rate": 16.1,
      "cto": 17.1
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiWhatsAppCampaignReportInfoList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalItems>2</TotalItems>
  <Count>2</Count>
  <whatsAppCampaignReportsInfo>
    <ApiWhatsAppCampaignReportInfo>
      <Id>ed167b47-eb86-43fb-8fe0-3d59fb6f43ff</Id>
      <Name>sample string 2</Name>
      <SendDate>2016-12-24T14:12:12</SendDate>
      <SendType>Regular</SendType>
      <TotalClicks>3</TotalClicks>
      <Clickers>4</Clickers>
      <Unsubscribes>5</Unsubscribes>
      <UnsubscribesPercentage>6.1</UnsubscribesPercentage>
      <Failed>7</Failed>
      <FailedPercentage>8.1</FailedPercentage>
      <TotalSent>9</TotalSent>
      <TotalOpens>10</TotalOpens>
      <TotalOpensPercentage>11.1</TotalOpensPercentage>
      <TotalRevenue>12.1</TotalRevenue>
      <Purchases>13</Purchases>
      <FailedRate>14.1</FailedRate>
      <UnsubscribeRate>15.1</UnsubscribeRate>
      <ClicksRate>16.1</ClicksRate>
      <Cto>17.1</Cto>
    </ApiWhatsAppCampaignReportInfo>
    <ApiWhatsAppCampaignReportInfo>
      <Id>ed167b47-eb86-43fb-8fe0-3d59fb6f43ff</Id>
      <Name>sample string 2</Name>
      <SendDate>2016-12-24T14:12:12</SendDate>
      <SendType>Regular</SendType>
      <TotalClicks>3</TotalClicks>
      <Clickers>4</Clickers>
      <Unsubscribes>5</Unsubscribes>
      <UnsubscribesPercentage>6.1</UnsubscribesPercentage>
      <Failed>7</Failed>
      <FailedPercentage>8.1</FailedPercentage>
      <TotalSent>9</TotalSent>
      <TotalOpens>10</TotalOpens>
      <TotalOpensPercentage>11.1</TotalOpensPercentage>
      <TotalRevenue>12.1</TotalRevenue>
      <Purchases>13</Purchases>
      <FailedRate>14.1</FailedRate>
      <UnsubscribeRate>15.1</UnsubscribeRate>
      <ClicksRate>16.1</ClicksRate>
      <Cto>17.1</Cto>
    </ApiWhatsAppCampaignReportInfo>
  </whatsAppCampaignReportsInfo>
</ApiWhatsAppCampaignReportInfoList>