For more information on using API

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

Get a specific SMS campaign summary report

Request Information

URI Parameters

Name

Description

Type

Additional information

id

SMS campaign id. Can be found using the endpoint "Get account's sms campaigns.." or in the UI (go to Mobile -> SMS -> SMS list -> inspect/F12)

integer

Required

Body Parameters

None.

Response Information

Resource Description

ApiSmsCampaignOverviewInfo

Name

Description

Type

Additional information

sent

View sents amount

integer
delivered

View delivered amount

integer
errors

View errors amount

integer
unsubscribed

View unsubscribed amount

integer
error_rate

View error rate

decimal number
sum_clicks

View sum clicks

integer
clickers

View clicks amount

integer
click_rate

Click rate

decimal number

Response Formats

application/json, text/json

Sample: 
{
  "sent": 1,
  "delivered": 2,
  "errors": 3,
  "unsubscribed": 4,
  "error_rate": 5.1,
  "sum_clicks": 6,
  "clickers": 7,
  "click_rate": 8.1
}

application/xml, text/xml

Sample: 
<ApiSmsCampaignOverviewInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport">
  <click_rate>8.1</click_rate>
  <clickers>7</clickers>
  <delivered>2</delivered>
  <error_rate>5.1</error_rate>
  <errors>3</errors>
  <sent>1</sent>
  <sum_clicks>6</sum_clicks>
  <unsubscribed>4</unsubscribed>
</ApiSmsCampaignOverviewInfo>