Get total usage for all service channels

GET

/api/v1/service/channels/usage/total

Request

Authorization

API Key

Add parameter in header

x-service-id

Example:

x-service-id: ********************

API Key

Add parameter in header

x-service-secret

Example:

x-service-secret: ********************

Query Params

Responses

🟢200

application/json

Success

Bodyapplication/json

🟠400BadRequestError

🟠401UnauthorizedError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/service/channels/usage/total?start=undefined&end=undefined' \
--header 'x-service-id: <api-key>' \
--header 'x-service-secret: <api-key>'

Response Example

200 - Example 1

{
    "data": {
        "property1": "string",
        "property2": "string",
        "start": "string",
        "end": "string",
        "totalUsage": 0,
        "totalRequests": 0,
        "byType": {
            "residential": {
                "totalUsage": 0,
                "totalRequests": 0
            },
            "ipv6": {
                "totalUsage": 0,
                "totalRequests": 0
            },
            "datacenter": {
                "totalUsage": 0,
                "totalRequests": 0
            },
            "mobile": {
                "totalUsage": 0,
                "totalRequests": 0
            }
        }
    },
    "err": false,
    "msg": "SUCCESS",
    "code": 200
}

Modified at 2026-04-09 10:44:15

Get channel usage statistics

Create channel