For more information on using API

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

Returns SMS campaigns' summary reports in 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

ApiAutomationSMSCampaignsSummary

Name

Description

Type

Additional information

total_sent

integer
total_sent_unique

integer
total_sent_calc

integer
total_delivered

integer
total_delivered_unique

integer
total_succeeded

integer
total_failed

integer
total_credits

integer
total_unsubscribe

integer
total_clicks

integer
total_unique_clicks

integer
total_revenue

decimal number
purchases

integer
credits

integer
failed_rate

decimal number
unsub_rate

decimal number
clicked_rate

decimal number

Response Formats

application/json, text/json

Sample: 
{
  "total_sent": 1,
  "total_sent_unique": 2,
  "total_sent_calc": 3,
  "total_delivered": 4,
  "total_delivered_unique": 5,
  "total_succeeded": 6,
  "total_failed": 7,
  "total_credits": 8,
  "total_unsubscribe": 9,
  "total_clicks": 10,
  "total_unique_clicks": 11,
  "total_revenue": 12.1,
  "purchases": 13,
  "credits": 14,
  "failed_rate": 15.1,
  "unsub_rate": 16.1,
  "clicked_rate": 17.1
}

application/xml, text/xml

Sample: 
<ApiAutomationSMSCampaignsSummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalSent>1</TotalSent>
  <UniqueTotalSent>2</UniqueTotalSent>
  <TotalSentCalc>3</TotalSentCalc>
  <TotalDelivered>4</TotalDelivered>
  <UniqueTotalDelivered>5</UniqueTotalDelivered>
  <TotalSucceeded>6</TotalSucceeded>
  <TotalFailed>7</TotalFailed>
  <TotalCredits>8</TotalCredits>
  <TotalUnsubscribe>9</TotalUnsubscribe>
  <TotalClicks>10</TotalClicks>
  <TotalUniqueClicks>11</TotalUniqueClicks>
  <TotalRevenue>12.1</TotalRevenue>
  <Purchases>13</Purchases>
  <Credits>14</Credits>
  <FailedRate>15.1</FailedRate>
  <UnsubscribeRate>16.1</UnsubscribeRate>
  <ClicksRate>17.1</ClicksRate>
</ApiAutomationSMSCampaignsSummary>