API reference
Reports
1 operations. Base URL: https://api.ringura.com/api/v1. Authenticate with a bearer token that carries the scope named on each operation.
GET /api/v1/reports/{groupBy}
Historical figures from the metric dictionary by channel, queue, agent or campaign. Ask for text/csv to get CSV.
Parameters
| Name | In | Type | Required | Constraints |
|---|---|---|---|---|
groupBy | path | string | Yes | one of "channel", "queue", "agent", "campaign" |
from | query | string (date-time) | Yes | |
to | query | string (date-time) | Yes |
Response
200 JSON with these fields. Also available as text/csv.
| Field | Type | Required | Constraints |
|---|---|---|---|
dictionaryVersion | integer | Yes | |
window | object | Yes | |
window.from | string (date-time) | Yes | |
window.to | string (date-time) | Yes | |
groupBy | string | Yes | one of "channel", "queue", "agent", "campaign" |
metrics | array of string | Yes | |
rows | array of object | Yes | |
rows[].key | string | Yes | |
rows[].label | string | Yes | |
rows[].metrics | object | Yes | free-form object |
total | object | Yes | free-form object |
Errors
400, 401, 403, 404, 409, 429. What each status means
Example request
curl -X GET 'https://api.ringura.com/api/v1/reports/channel?from=2027-01-04T09%3A00%3A00Z&to=2027-01-04T09%3A00%3A00Z' \
-H "Authorization: Bearer $CC_TOKEN"