Read SMS campaign reports: summaries, sent, delivered, failed, clicks and unsubscribes. The reports of a single campaign look for it among those sent in a date range (by default, the last 3 months). If the campaign wasn't sent in that range, you get no data (or, for the clicks on one link, an error).
All endpoints use the base URL https://webapi.mymarketing.co.il and an API key in the Authorization header. New to the API? Start with Get started with the ActiveTrail API.
Endpoints
| Method | Endpoint | What it does |
|---|---|---|
GET | /api/ | Get the reports of your SMS campaigns, one page at a time |
GET | /api/ | Get the summary reports of your SMS campaigns in one call, without pages |
GET | /api/ | Get a specific SMS campaign summary report |
GET | /api/ | Get all the contacts that the sms was sent to |
GET | /api/ | Get all the contacts that the sms was delivered to |
GET | /api/ | Get all the contacts that clicked on a link sms (can be filtered by specific link) |
GET | /api/ | Get clickers by link id |
GET | /api/ | Get SMS clicks (on links) reports |
GET | /api/ | Get all the contacts that the sms wasn't sent to (delivery failure) |
GET | /api/ | Get all the contacts that unsubscribed from a specific campaign sms |
Endpoint details
Get the reports of your SMS campaigns, one page at a time
GET https://webapi.mymarketing.co.il/api/smscampaignreport
Get the reports of your SMS campaigns, one page at a time. You can filter by dates, campaign type and name (by default, campaigns from the last 3 months).
| Parameter | In | Type | Description |
|---|---|---|---|
send_type | query | integer | 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 |
search_term | query | string | Search by campaign name/partial name |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
Get the summary reports of your SMS campaigns in one call, without pages
GET https://webapi.mymarketing.co.il/api/smscampaignreport/GetSummary
Get the summary reports of your SMS campaigns in one call, without pages. You can filter by dates, campaign type and name (by default, campaigns from the last 3 months).
| Parameter | In | Type | Description |
|---|---|---|---|
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
send_type | query | integer | 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 |
search_term | query | string | Search by campaign name/partial name |
Full reference, request and response samples
Get a specific SMS campaign summary report
GET https://webapi.mymarketing.co.il/api/smscampaignreport/{id}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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) Required. |
Full reference, request and response samples
Get all the contacts that the sms was sent to
GET https://webapi.mymarketing.co.il/api/smscampaignreport/{id}/Sent
Get all the contacts that the sms was sent to. If you didn't send the sms to a group but chose the "add numbers manually" function - you'll get the amount of contacts the sms was sent to but not the 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 wasn't sent in the given range - you will get no information)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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) Required. |
send_type | query | integer | 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 |
search_term | query | string | Search by campaign name/partial name |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. |
to_date | query | date | End of the date range. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
Get all the contacts that the sms was delivered to
GET https://webapi.mymarketing.co.il/api/smscampaignreport/{id}/Delivered
Get all the contacts that the sms was delivered to. If you didn't send the sms to a group but chose the "add numbers manually" function - you'll get the amount of contacts the sms was sent to but not the 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 wasn't sent in the given range - you will get no information)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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) Required. |
send_type | query | integer | 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 |
search_term | query | string | Search by campaign name/partial name |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
Get all the contacts that clicked on a link sms (can be filtered by specific link)
GET https://webapi.mymarketing.co.il/api/smscampaignreport/{id}/Clickers
Get all the contacts that clicked on a link sms (can be filtered by specific link). 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 wasn't sent in the given range - you will get no information)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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) Required. |
link_id | query | integer | 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 will see "link=" |
send_type | query | integer | 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 |
search_term | query | string | Search by campaign name/partial name |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
Get clickers by link id
GET https://webapi.mymarketing.co.il/api/smscampaignreport/{id}/clickdetails/{linkId}
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 wasn't sent in the given range - you will get an error)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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) Required. |
linkId | path | integer | 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 will see "link=" Required. |
send_type | query | integer | 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 |
search_term | query | string | Search by campaign name/partial name |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
Get SMS clicks (on links) reports
GET https://webapi.mymarketing.co.il/api/smscampaignreport/{id}/Clicks
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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) Required. |
send_type | query | integer | 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 |
search_term | query | string | Search by campaign name/partial name |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. |
to_date | query | date | End of the date range. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
Get all the contacts that the sms wasn't sent to (delivery failure)
GET https://webapi.mymarketing.co.il/api/smscampaignreport/{id}/Failed
Get all the contacts that the sms wasn't sent to (delivery failure). If you didn't send the sms to a group but chose the "add numbers manually" function - you'll get the number of contacts but not their 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 wasn't sent in the given range - you will get no information)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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) Required. |
send_type | query | integer | 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 |
search_term | query | string | Search by campaign name/partial name |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
Get all the contacts that unsubscribed from a specific campaign sms
GET https://webapi.mymarketing.co.il/api/smscampaignreport/{id}/Unsubscribed
Get all the contacts that unsubscribed from a specific campaign sms. If you didn't send the sms to a group but chose the "add numbers manually" function - you'll get the number of contacts but not their 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 wasn't sent in the given range - you will get no information)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | 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) Required. |
send_type | query | integer | 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 |
search_term | query | string | Search by campaign name/partial name |
from_date | query | date | Start of the date range: the campaign must have been sent in this range. Format: yyyy-mm-dd. |
to_date | query | date | End of the date range. Format: yyyy-mm-dd. |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
This reference is based on the ActiveTrail API documentation, where you can also test each endpoint with your own API key.