For more information on using API

GET https://webapi.mymarketing.co.il/api/automationreports/{id}/SMSCampaignSummaryReport

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_calc

integer
total_succeeded

integer
total_failed

integer
total_credits

integer
total_unsubscribe

integer
total_clicks

integer
total_unique_clicks

integer

Response Formats

application/json, text/json

Sample: 
{
  "total_sent": 1,
  "total_sent_calc": 2,
  "total_succeeded": 3,
  "total_failed": 4,
  "total_credits": 5,
  "total_unsubscribe": 6,
  "total_clicks": 7,
  "total_unique_clicks": 8
}

application/xml, text/xml

Sample: 
<ApiAutomationSMSCampaignsSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.AutomationReport">
  <total_clicks>7</total_clicks>
  <total_credits>5</total_credits>
  <total_failed>4</total_failed>
  <total_sent>1</total_sent>
  <total_sent_calc>2</total_sent_calc>
  <total_succeeded>3</total_succeeded>
  <total_unique_clicks>8</total_unique_clicks>
  <total_unsubscribe>6</total_unsubscribe>
</ApiAutomationSMSCampaignsSummary>