View SMS-click report

GET /reports/click/sms
Copied
Arrow
                https://api.ocamba.com/v1/hood/reports/click/sms

Obtain various SMS-click reports

query Parameters
Arrow
Name
Description
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
Response status codes
Arrow
200 - OK
Arrow
Name
Description
click_datedateTime
The day of the event.


Example: 2021-12-27
container_idinteger
Dimension
Unique container identifier generated on Ocamba platform.


Example: 126598752
container_namestring
Dimension
Container name created on Ocamba platform.


Example: test.demo.com
container_typestring
Dimension
Type of application, it can be web, android, ios, safari or unknown.


Example: ios
delivery_datedateTime
The day of the scheduler execution.


Example: 2021-12-27
destination_urlstring
The destination url of click.


Example: test.com
integration_idstring
Dimension
A unique identifier of the Integration, generated by the Ocamba platform.


Example: SMS
integration_namestring
Dimension
The Name of the integration.


Example: Ocamba
provider_idstring
Dimension
A unique identifier of the Provider, generated by the Ocamba platform.


Example: SMS
provider_namestring
Dimension
The name of the Provider.


Example: Ocamba
recipientstring
Dimension
A mobile phone number of the recipient.


Example: +123456789
senderstring
Dimension
A mobile phone number of the sender.


Example: +123456789
spaminteger
Dimension
Internal spam click identifier.


Example: 0
spam_reasonstring
Dimension
Reason why the click is spam.


Example: double_click
tag_idinteger
Tag id generated on Ocamba platform.


Example: 126598752
tag_namestring
Tag name created on Ocamba platform.


Example: test.demo.com
tag_typestring
Dimension
Type of application, it can be web, android, ios, safari or unknown.


Example: ios
task_idinteger
Push scheduler id generated on Ocamba platform.


Example: 1284472
task_namestring
Push scheduler name created on Ocamba platform.


Example: Monday 15pm
user_idinteger
Push user id generated on Ocamba platform.


Example: 1284472

tip
1 Sortable fields are: click_date, user_id, task_id, task_name, tag_id, tag_name, container_id, container_name, delivery_date, tag_type, container_type, integration_id, integration_name, provider_id, provider_name, destination_url, sender, recipient, spam, spam_reason.
2 Filterable fields are: click_date, user_id, task_id, task_name, tag_id, tag_name, container_id, container_name, delivery_date, tag_type, container_type, integration_id, integration_name, provider_id, provider_name, destination_url, sender, recipient, spam, spam_reason.
3 To get data by the time in your local time zone, you should set tz query parameter to the specific time zone. See the list of valid time zones here -> https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List.
4 For easier search, Reports API gives you the possibility of using one of the following labels: today, yesterday, last-7-days, last-30-days, last-24-hours, this-month, last-month, current-hour, last-hour, last-48-hours, last-2-days, month-to-date, month-to-yesterday, quarter-to-date.
note
1 When filtering click_date, use one of the following formats:
- Single format: YYYY-mm-dd;

Displaying stats for this specific day
- Range format: rf:YYYY-mm-dd,YYYY-mm-dd;
Requires usage of the range operators:
- r - range - The value must be in a specified open range, where both endpoints are excluded.
- rf - range full - The value must be in a specified closed range, where both endpoints are included.
- rl - range left - The value must be in a specified half-open range, where only left or start point is included.
- rr - range right - The value must be in a specified half-open range, where only right or end point is included.

Displaying stats in this specific range.
- Hour range format: rl: YYYY-mm-dd hh:00:00,YYYY-mm-dd hh:00:00
If you exclude this parameter, the default setup displays "today" stats.

Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
[
   {
      "click_date": "2024-07-15T00:00:00Z",
      "user_id": "17210268627433927191",
      "task_id": "0",
      "tag_id": "15190",
      "tag_name": "Tag_example",
      "tag_type": "unknown",
      "delivery_date": "2024-07-15T07:03:11Z",
      "provider_id": "1008",
      "provider_name": "provider_sms",
      "integration_id": "1492",
      "integration_name": "Integration_example",
      "destination_url": "https://ocamba.com"
    }
 ]

{
  "click_date": "2021-12-27",
  "user_id": 1284472,
  "task_id": 1284472,
  "task_name": "Monday 15pm",
  "tag_id": 126598752,
  "tag_name": "test.demo.com",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "destination_url": "test.com",
  "delivery_date": "2021-12-27",
  "tag_type": "ios",
  "container_type": "ios",
  "provider_id": "SMS",
  "provider_name": "Ocamba",
  "integration_id": "SMS",
  "integration_name": "Ocamba",
  "sender": "+123456789",
  "recipient": "+123456789",
  "spam": 0,
  "spam_reason": "double_click"
}