Statistics HTTP API

This API provides the ability to retrieve data, in JSON format, about SMS campaigns conducted by users of the Miatel platform.

Access to the Statistics HTTP API

The private key ip_auth_key is generated on the Miatel side. To obtain the key, please contact support at support@miatel.com, providing your account on the Miatel platform and the IP addresses for whitelisting, or reach out to your personal manager.

Endpoint

https://sms-hub2.miatel.ru/main-getData.php?

Request parameters

ip_auth_key

Unique authentication key issued to the user

time_beg

The start time of the period for which SMS campaign data is requested. Time is specified in GMT+0 format. (Format: Y-M-DTh:m:s, Example: 2023-07-25T00:00:00)

time_end

The end time of the period for which SMS campaign data is requested. Time is specified in GMT+0 format. (Format: Y-M-DTh:m:s, Example: 2023-07-25T23:59:59)

get_names

Parameter determining whether to output a separate JSON with geo names. This parameter can only take the value of 1.

Request example

https://sms-hub2.miatel.ru/main-getData.php?ip_auth_key=aaabbbcccddd&time_beg=2023-02-21T23:00:00&time_end=2023-02-21T23:05:59&get_names=1

API limitations

  • Maximum number of returned records: 100,000

  • Maximum request period: 31 days

  • Start and end time of the period are specified in GMT+0 format.

  • The request period should be optimized to minimize data volume.

  • Only one request at a time is allowed.