For more information on using API
GET http://webapi.mymarketing.co.il/api/smscampaignreport/GetSummary?FromDate={FromDate}&ToDate={ToDate}&SendType={SendType}&SearchTerm={SearchTerm}
Get SMS campaigns reports . You can get campaigns filtered by various parameters including dates and limited to a number of campaigns (you will get camapigns that were last updated in the last 3 months by default)
Request Information
URI Parameters
Name
Description
Type
Additional information
from_date
The start date the campaign was last updated
date
to_date
The end date the campaign was last updated
date
send_type
Filter by campaign's type. Default will get all the campaigns. Types: All types of campaigns - 0 , Regular campaign - 1 , Test campaigns - 2 , Transactional (Operational) messages - 3
integer
search_term
Search by campaign name/partial name
string
Body Parameters
None.
Response Information
Resource Description
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:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <TotalClicks>1</TotalClicks> <TotalUniqueClicks>2</TotalUniqueClicks> <TotalSent>3</TotalSent> <TotalFailed>4</TotalFailed> <TotalUnsubscribed>5</TotalUnsubscribed> <TotalCredits>6</TotalCredits> </ApiSmsCampaignReportSummaryInfo>