For more information on using API

GET http://webapi.mymarketing.co.il/api/smscampaignreport/GetSummary?FromDate={FromDate}&ToDate={ToDate}&SendType={SendType}&SearchTerm={SearchTerm}

Getting the Summary report info of an sms campaign

Request Information

URI Parameters

Name

Description

Type

Additional information

from_date

The first date the contacts you want were created

date
to_date

The last date the contacts you want were created.(Default values is 3 last months)

date
send_type

integer
search_term

string

Body Parameters

None.

Response Information

Resource Description

ApiSmsCampaignReportSummaryInfo

Name

Description

Type

Additional information

total_clicks

Total Clicks

integer
total_unique_clicks

Total Clicks

integer
total_sent

Total Sent

integer
total_failed

Total Failed

integer
total_unsubscribed

Total Unsubscribes

integer
total_credits

Total Credits

integer

Response Formats

application/json, text/json

Sample:
{
  "total_clicks": 1,
  "total_unique_clicks": 2,
  "total_sent": 3,
  "total_failed": 4,
  "total_unsubscribed": 5,
  "total_credits": 6
}

application/xml, text/xml

Sample:
<ApiSmsCampaignReportSummaryInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport">
  <total_clicks>1</total_clicks>
  <total_credits>6</total_credits>
  <total_failed>4</total_failed>
  <total_sent>3</total_sent>
  <total_unique_clicks>2</total_unique_clicks>
  <total_unsubscribed>5</total_unsubscribed>
</ApiSmsCampaignReportSummaryInfo>