api:internet:account:rtt
Table of Contents
API : Internet Account RTT
Introduction
This request will return the Round Trip Time statistics for an Internet account.
The system measures the time it takes for a ping request to get a reply from the customer premise router. The test is performed once a minute and statistics is kept for 7 days.
Request
| URL | https://api.telecomx.dk/internet/account/ACCOUNT_ID/rtt | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN. |
|
| Param | ACCOUNT_ID | Id of the Internet Access account. |
| Query | date | Date for which to return RTT statistics, Date format is yyyy-mm-dd. Defaults to today if not specified. |
Query example
https://api.telecomx.dk/sip/1234567890ABCDEF12345678/rtt https://api.telecomx.dk/sip/1234567890ABCDEF12345678/rtt?date=2014-07-23
Response
| Json array | ||
|---|---|---|
| index | n/a | An array is returned that has 1440 items, one for each minute of the day. |
| value | Integer | The RTT in milliseconds for that minute. If no reply or the minute is in the future (later today) then the value is 0. A reasonable value is between 3 and 40 milliseconds, higher if abroad, but if it is above 200 milliseconds or there are holes in the values - then it is a sign of trouble. |
Example
[ 30, 35, 39, 29, 31, ...1430 records... 33, 32, 39, 26, 29 ]
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | not_found | Internet account not found |
| 422 | date | No RTT data found for the requested date |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/internet/account/rtt.txt · Last modified: 2018/09/28 10:35 by Per Møller