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 campaignsreports . You can get sms campaigns reports filtered (you will get the last 20 campaigns in the last 6 months by default)

Request Information

URI Parameters

Name

Description

Type

Additional information

send_type

integer
search_term

string
rows_affected

integer
previous_row_count

integer
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
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.

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:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport">
  <count>1</count>
  <sms_campaign_reports>
    <ApiSmsCampaignReportInfo>
      <clickers>4</clickers>
      <errors>6</errors>
      <id>1</id>
      <name>sample string 2</name>
      <send_date>2016-12-24T14:12:12</send_date>
      <send_type>Regular</send_type>
      <sent>7</sent>
      <total_credits>8</total_credits>
      <total_unique_clicks>3</total_unique_clicks>
      <unsubscribes>5</unsubscribes>
    </ApiSmsCampaignReportInfo>
    <ApiSmsCampaignReportInfo>
      <clickers>4</clickers>
      <errors>6</errors>
      <id>1</id>
      <name>sample string 2</name>
      <send_date>2016-12-24T14:12:12</send_date>
      <send_type>Regular</send_type>
      <sent>7</sent>
      <total_credits>8</total_credits>
      <total_unique_clicks>3</total_unique_clicks>
      <unsubscribes>5</unsubscribes>
    </ApiSmsCampaignReportInfo>
  </sms_campaign_reports>
</ApiSmsCampaignReportInfoList>