For more information on using API

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

Get clickers by link id. If you didn't send the sms to a group but chose the "add numbers manually" function - you'll get the amount of clickers but not the mobile numbers. You can also filter by dates. (the search for the campaign will be made, by default, in the last 3 months. If the campaign wasnt sent in the given range - you will get an error)

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

linkId

Link id. The id of a specific link. can be found in the UI (find the campaign in "Mobile" -> "SMS" -> "SMS report" -> go to clickers reports > you wiil see "link="

integer

Required

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

ApiReportSmsCampaignClickDetailsList

Name

Description

Type

Additional information

urls_clicked

Items list

Collection of ApiReportSmsCampaignClickDetails
total_items

Number of items

integer

Response Formats

application/json, text/json

Sample: 
{
  "urls_clicked": [
    {
      "contact_id": 1,
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "email": "sample string 3",
      "sms": "sample string 4",
      "click_date": "2016-12-24T14:12:12"
    },
    {
      "contact_id": 1,
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "email": "sample string 3",
      "sms": "sample string 4",
      "click_date": "2016-12-24T14:12:12"
    }
  ],
  "total_items": 1
}

application/xml, text/xml

Sample: 
<ApiReportSmsCampaignClickDetailsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport">
  <total_items>1</total_items>
  <urls_clicked>
    <ApiReportSmsCampaignClickDetails>
      <click_date>2016-12-24T14:12:12</click_date>
      <contact_id>1</contact_id>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
      <sms>sample string 4</sms>
    </ApiReportSmsCampaignClickDetails>
    <ApiReportSmsCampaignClickDetails>
      <click_date>2016-12-24T14:12:12</click_date>
      <contact_id>1</contact_id>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
      <sms>sample string 4</sms>
    </ApiReportSmsCampaignClickDetails>
  </urls_clicked>
</ApiReportSmsCampaignClickDetailsList>