For more information on using API

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

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

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
rows_affected

irrelevant - should be deleted

integer
previous_row_count

irrelevant - should be deleted

integer
from_date

The start date the campaign was last updated

date
to_date

The end date the campaign was last updated

date
page

Get a specific page (number of pages is limited)

integer

Range: inclusive between 1 and 2147483647

limit

Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records)

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

ApiSmsCampaignReportInfoList

Name

Description

Type

Additional information

count

List count

integer
sms_campaign_reports

see ApiSmsCampaignReportInfo

Collection of ApiSmsCampaignReportInfo

Response Formats

application/json, text/json

Sample: 
{
  "count": 1,
  "sms_campaign_reports": [
    {
      "id": 1,
      "name": "sample string 2",
      "send_date": "2016-12-24T14:12:12",
      "send_type": "Regular",
      "total_unique_clicks": 3,
      "clickers": 4,
      "unsubscribes": 5,
      "errors": 6,
      "sent": 7,
      "total_credits": 8
    },
    {
      "id": 1,
      "name": "sample string 2",
      "send_date": "2016-12-24T14:12:12",
      "send_type": "Regular",
      "total_unique_clicks": 3,
      "clickers": 4,
      "unsubscribes": 5,
      "errors": 6,
      "sent": 7,
      "total_credits": 8
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiSmsCampaignReportInfoList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Count>1</Count>
  <smsCampaignReportsInfo>
    <ApiSmsCampaignReportInfo>
      <Id>1</Id>
      <SMSName>sample string 2</SMSName>
      <SendDate>2016-12-24T14:12:12</SendDate>
      <SendType>Regular</SendType>
      <TotalUniqueClicks>3</TotalUniqueClicks>
      <Clickers>4</Clickers>
      <Unsubscribes>5</Unsubscribes>
      <Errors>6</Errors>
      <Sent>7</Sent>
      <TotalCredits>8</TotalCredits>
    </ApiSmsCampaignReportInfo>
    <ApiSmsCampaignReportInfo>
      <Id>1</Id>
      <SMSName>sample string 2</SMSName>
      <SendDate>2016-12-24T14:12:12</SendDate>
      <SendType>Regular</SendType>
      <TotalUniqueClicks>3</TotalUniqueClicks>
      <Clickers>4</Clickers>
      <Unsubscribes>5</Unsubscribes>
      <Errors>6</Errors>
      <Sent>7</Sent>
      <TotalCredits>8</TotalCredits>
    </ApiSmsCampaignReportInfo>
  </smsCampaignReportsInfo>
</ApiSmsCampaignReportInfoList>