For more information on using API

GET http://webapi.mymarketing.co.il/api/automationreports/{id}/automationwhatsappcampaignstatistic

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

Response Formats

application/json, text/json

Sample:
{
  "totalitems": 2,
  "count": 2,
  "campaignreportslist": [
    {
      "campaignid": "6d764165-6d7b-4f0d-9d81-a2bc3d6678df",
      "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
    },
    {
      "campaignid": "6d764165-6d7b-4f0d-9d81-a2bc3d6678df",
      "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
    }
  ]
}

application/xml, text/xml

Sample:
<ApiWhatsAppCampaignReportInfoList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.WhatsAppCampaignReport">
  <Count>2</Count>
  <TotalItems>2</TotalItems>
  <whatsAppCampaignReportsInfo>
    <ApiWhatsAppCampaignReportInfo>
      <campaignid>6d764165-6d7b-4f0d-9d81-a2bc3d6678df</campaignid>
      <campaignname>sample string 2</campaignname>
      <clickers>4</clickers>
      <failed>7</failed>
      <failedPercentage>8.1</failedPercentage>
      <openedPercentage>11.1</openedPercentage>
      <opens>10</opens>
      <sentdate>2016-12-24T14:12:12</sentdate>
      <senttype>Regular</senttype>
      <totalclicks>3</totalclicks>
      <totalsent>9</totalsent>
      <unsubscribe>5</unsubscribe>
      <unsubscribePercentage>6.1</unsubscribePercentage>
    </ApiWhatsAppCampaignReportInfo>
    <ApiWhatsAppCampaignReportInfo>
      <campaignid>6d764165-6d7b-4f0d-9d81-a2bc3d6678df</campaignid>
      <campaignname>sample string 2</campaignname>
      <clickers>4</clickers>
      <failed>7</failed>
      <failedPercentage>8.1</failedPercentage>
      <openedPercentage>11.1</openedPercentage>
      <opens>10</opens>
      <sentdate>2016-12-24T14:12:12</sentdate>
      <senttype>Regular</senttype>
      <totalclicks>3</totalclicks>
      <totalsent>9</totalsent>
      <unsubscribe>5</unsubscribe>
      <unsubscribePercentage>6.1</unsubscribePercentage>
    </ApiWhatsAppCampaignReportInfo>
  </whatsAppCampaignReportsInfo>
</ApiWhatsAppCampaignReportInfoList>