Subscriber Telemetry API

Subscriber Counts

GET

/v1/subscribers/count

(subscriber)

Subscriber Current Total Count

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AccountsSubscriber AdministratorSubscriber Support

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
count	body	integer	Total current subscribers in domain.

Response Example

{
    "count": 9999
}

Data Usage

The following API definitions describe how to perform data usage queries. These queries are restricted. Please refer to Subscriber Telemetry documetation for more information relating their use.

Query Restrictions:

Resolution / Aggregation.	Max time range.	Available Data.
Hourly	3072 hours.	5 years.
Daily	128 days.	5 years.
Weekly	112 weeks.	5 years.
Monthly	60 months.	5 years.
Yearly	5 years.	5 years.

All data usage records are available in all timezones.

POST

/v1/subscriber/{subscriber_id}/data/{aggregation}

(telemetry)

Subscriber Account data usage.

Service
telemetry

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
aggregation	url	string	hourly, daily, weekly, monthly or yearly.	X
subscriber_id	url	string	Unique Subscriber ID.	X
end	body	string	End Report Date Time in ISO 8601.	X
pretty_date	body	boolean	The default time format in response is ISO 8601. Setting this to true will format it as a user-friendly format that can be used for graphs, for example.
start	body	string	Start Report Date Time in ISO 8601.	X

Request Example

{
    "start": "2024-05-01T00:00:00+02:00",
    "end": "2024-08-13T12:16:43+02:00",
    "pretty_date": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
combined_kb	body	string	Download + Upload.
download_kb	body	string	Downloaded in Kilobytes.
time	body	string	User friendly formatted time.
upload_kb	body	string	Uploaded in Kilobytes.

Response Example

[
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-05 (May)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-06 (June)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-07 (July)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-08 (August)"
    }
]

POST

/v1/subscriber/virtual/{virtual_id}/data/{aggregation}

(telemetry)

Virtual Server data usage.

Service
telemetry

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
aggregation	url	string	hourly, daily, weekly, monthly or yearly.	X
virtual_id	url	string	Unique Virtual ID.	X
end	body	string	End Report Date Time in ISO 8601.	X
pretty_date	body	boolean	The default time format in response is ISO 8601. Setting this to true will format it as a user-friendly format that can be used for graphs, for example.
start	body	string	Start Report Date Time in ISO 8601.	X

Request Example

{
    "start": "2024-05-01T00:00:00+02:00",
    "end": "2024-08-13T12:16:43+02:00",
    "pretty_date": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
combined_kb	body	string	Download + Upload.
download_kb	body	string	Downloaded in Kilobytes.
time	body	string	User friendly formatted time.
upload_kb	body	string	Uploaded in Kilobytes.

Response Example

[
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-05 (May)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-06 (June)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-07 (July)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-08 (August)"
    }
]

POST

/v1/subscriber/client/{client_id}/data/{aggregation}

(telemetry)

Virtual Server Client data usage.

Service
telemetry

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
aggregation	url	string	hourly, daily, weekly, monthly or yearly.	X
client_id	url	string	Unique Virtual Client ID.	X
end	body	string	End Report Date Time in ISO 8601.	X
pretty_date	body	boolean	The default time format in response is ISO 8601. Setting this to true will format it as a user-friendly format that can be used for graphs, for example.
start	body	string	Start Report Date Time in ISO 8601.	X

Request Example

{
    "start": "2024-05-01T00:00:00+02:00",
    "end": "2024-08-13T12:16:43+02:00",
    "pretty_date": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
combined_kb	body	string	Download + Upload.
download_kb	body	string	Downloaded in Kilobytes.
time	body	string	User friendly formatted time.
upload_kb	body	string	Uploaded in Kilobytes.

Response Example

[
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-05 (May)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-06 (June)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-07 (July)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-08 (August)"
    }
]

POST

/v1/subscriber/client_tag/{tag}/data/{aggregation}

(telemetry)

Virtual Server Client Tagged data usage.

Service
telemetry

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
aggregation	url	string	hourly, daily, weekly, monthly or yearly.	X
tag	url	string	Single matching tag.	X
end	body	string	End Report Date Time in ISO 8601.	X
pretty_date	body	boolean	The default time format in response is ISO 8601. Setting this to true will format it as a user-friendly format that can be used for graphs, for example.
start	body	string	Start Report Date Time in ISO 8601.	X

Request Example

{
    "start": "2024-05-01T00:00:00+02:00",
    "end": "2024-08-13T12:16:43+02:00",
    "pretty_date": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
combined_kb	body	string	Download + Upload.
download_kb	body	string	Downloaded in Kilobytes.
time	body	string	User friendly formatted time.
upload_kb	body	string	Uploaded in Kilobytes.

Response Example

[
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-05 (May)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-06 (June)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-07 (July)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-08 (August)"
    }
]

POST

/v1/subscriber/service/{service_id}/data/{aggregation}

(telemetry)

Service Profile data usage.

Service
telemetry

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
aggregation	url	string	hourly, daily, weekly, monthly or yearly.	X
service_id	url	string	Unique Service ID.	X
end	body	string	End Report Date Time in ISO 8601.	X
pretty_date	body	boolean	The default time format in response is ISO 8601. Setting this to true will format it as a user-friendly format that can be used for graphs, for example.
start	body	string	Start Report Date Time in ISO 8601.	X

Request Example

{
    "start": "2024-05-01T00:00:00+02:00",
    "end": "2024-08-13T12:16:43+02:00",
    "pretty_date": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
combined_kb	body	string	Download + Upload.
download_kb	body	string	Downloaded in Kilobytes.
time	body	string	User friendly formatted time.
upload_kb	body	string	Uploaded in Kilobytes.

Response Example

[
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-05 (May)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-06 (June)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-07 (July)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-08 (August)"
    }
]

POST

/v1/subscriber/profile/{profile_id}/data/{aggregation}

(telemetry)

Subscriber Profile data usage.

Service
telemetry

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
aggregation	url	string	hourly, daily, weekly, monthly or yearly.	X
profile_id	url	string	Profile Id.	X
end	body	string	End Report Date Time in ISO 8601.	X
pretty_date	body	boolean	The default time format in response is ISO 8601. Setting this to true will format it as a user-friendly format that can be used for graphs, for example.
start	body	string	Start Report Date Time in ISO 8601.	X

Request Example

{
    "start": "2024-05-01T00:00:00+02:00",
    "end": "2024-08-13T12:16:43+02:00",
    "pretty_date": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
combined_kb	body	string	Download + Upload.
download_kb	body	string	Downloaded in Kilobytes.
time	body	string	User friendly formatted time.
upload_kb	body	string	Uploaded in Kilobytes.

Response Example

[
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-05 (May)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-06 (June)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-07 (July)"
    },
    {
        "download_kb": "0",
        "upload_kb": "0",
        "combined_kb": "0",
        "time": "2024-08 (August)"
    }
]

Top Subscribers by Data Usage

POST

/v1/subscriber/topusers

(telemetry)

List Top Subscribers by Usage

Service
telemetry

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AccountsSubscriber AdministratorSubscriber Support

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
end	body	string	Report End datetime
start	body	string	Report Start datetime
timezone	body	string	Timezone.

Request Example

{
    "timezone":"Africa/Johannesburg",
    "start":"2025-01-01 00:00",
    "end":"2025-02-01 00:00"
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
name	body	string	Subscriber name.
profile	body	string	Name of Subscriber Profile.
service	body	string	Name of Service Profile.
subscriber_id	body	string	Unique Subscriber ID.
usage_kb	body	integer	The total number of kilobytes of usage for the subscriber.
usage_pretty	body	string	The human-readable volume of usage for the subscriber.
username	body	string	Subscriber username.
virtual	body	string	Name of Virtual Server.

Response Example

[
    {
        "subscriber_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "usage_kb": "2168513382",
        "usage_pretty": "2.17TB",
        "username": "XXXXXXXXXXXXXXXXX",
        "name": "XXXXX",
        "virtual": "XXX",
        "service": "XXX",
        "profile": "XXX"
    },
    {
        "subscriber_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "usage_kb": "2148323355",
        "usage_pretty": "2.15TB",
        "username": "XXXXXXXXXXXXXXXXX",
        "name": "XXXXX",
        "virtual": "XXX",
        "service": "XXX",
        "profile": "XXX"
    },
    {
        "subscriber_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "usage_kb": "1577329845",
        "usage_pretty": "1.58TB",
        "username": "XXXXXXXXXXXXXXXXX",
        "name": "XXXXX",
        "virtual": "XXX",
        "service": "XXX",
        "profile": "XXX"
    }
]

Credit Usage

GET

/v1/subscriber/{subscriber_id}/credit/status

(telemetry)

Subscriber Current Credits Usage

Service
telemetry

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	Subscriber Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
credit_name	body	integer	Credit Name.
free	body	integer	Free in Kilobytes.
rollover	body	integer	Rollover in Kilobytes.
total_credit	body	integer	Credit in Kilobytes.
total_used	body	integer	Used in Kilobytes.

Response Example

[
    {
        "credit_name": "Monthly Anytime",
        "total_credit": 10000000,
        "total_used": 10000000,
        "rollover": 0,
        "free": 0
    }
]

Event Logs

The following API definitions describe howto query subscriber event logs. Please refer to Subscriber Telemetry - Event Logs documetation for more information relating their use.

Events are only retained for upto 2 weeks.

GET

/v1/subscriber/{subscriber_id}/events

(telemetry)

List of Events.

Service
telemetry

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AccountsSubscriber AdministratorSubscriber Support

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	Unique Subscriber ID.	X
facility	query	string	Match facility. Authentication, Accounting and more.
severity	query	string	Match severity precisely. (info, warning, error, critical)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
event_id	body	string	Unique Event ID.
facility	body	string	Authentication, Accounting and more.
message	body	string	Short version of message.
severity	body	string	The severity level of the message. (info, warning, error, critical)
time	body	string	ISO 8601 Event Time.

Response Example

[
    {
        "time": "2024-08-07T11:33:17+00:00",
        "facility": "authentication",
        "severity": "info",
        "message": "Authentication: Authentication login success",
        "event_id": "1723028400::d7268c5d-54b0-11ef-aefc-174adb24f2cd"
    },
    {
        "time": "2024-08-05T12:46:32+00:00",
        "facility": "authentication",
        "severity": "info",
        "message": "Authentication: Authentication login success",
        "event_id": "1722859200::bd44210d-5328-11ef-bf64-cfca366fc35d"
    },
    {
        "time": "2024-07-31T05:57:34+00:00",
        "facility": "authentication",
        "severity": "info",
        "message": "Authentication: Authentication login success",
        "event_id": "1722402000::c85b25d4-4f01-11ef-9648-cfca366fc35d"
    },
    {
        "time": "2024-07-30T16:26:59+00:00",
        "facility": "authentication",
        "severity": "info",
        "message": "Authentication: Authentication login success",
        "event_id": "1722355200::8bcf84f0-4e90-11ef-b265-aff022b163c4"
    },
    {
        "time": "2024-07-29T07:06:02+00:00",
        "facility": "authentication",
        "severity": "info",
        "message": "Authentication: Authentication login success",
        "event_id": "1722236400::03d9363a-4d79-11ef-80c4-174adb24f2cd"
    },
    {
        "time": "2024-07-29T07:05:56+00:00",
        "facility": "disconnect",
        "severity": "error",
        "message": "disconnect: Error (server http://10.0.0.33)",
        "event_id": "1722236400::0020393a-4d79-11ef-8c67-cfca366fc35d"
    }
]

GET

/v1/subscriber/{subscriber_id}/event/{event_id}

(telemetry)

Get Event.

Service
telemetry

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AccountsSubscriber AdministratorSubscriber Support

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
event_id	url	string	Unique Event ID.	X
subscriber_id	url	string	Unique Subscriber ID.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
domain	body	string	NebularStack Domain
event_id	body	string	Unique Event ID.
facility	body	string	Authentication, Accounting and more.
message	body	string	Event message.
severity	body	string	The severity level of the message. (info, warning, error, critical)
subscriber_id	body	string	Unique Subscriber ID.
time	body	string	ISO 8601 Event Time.
username	body	string	Subscriber username.
virtual_id	body	string	Unique Virtual ID that triggered event.

Response Example

{
    "time": "2024-08-05T12:46:32+00:00",
    "domain": "isp.com",
    "subscriber_id": "00034ae6-4d79-11ef-80c4-174adb24f2cd",
    "virtual_id": "465be807-54f1-4bf6-b940-398ed95cdbe7",
    "username": "test@isp.com",
    "facility": "Authentication",
    "severity": "info",
    "message": "Authentication: Authentication login success\nUsername: test@isp.com\nVirtual-Router-ID: 465be807-54f1-4bf6-b940-398ed95cdbe7\nRequest:\nuser-name: test@isp.com\nchap-password: 0x661112163bf93a571d5f924c7ef868aba9\nnas-ip-address: 172.16.123.5\nnas-port: 100\nservice-type: Framed-User\nframed-protocol: PPP\nnas-identifier: mx204\nchap-challenge: 0xdf206be846a226de8b61b741f2d703606499b1db80\nnas-port-type: Ethernet\nacct-session-id: 89195146\nnas-port-id: ae2:114-100\nchargeable-user-identity: 0x00\nerx-pppoe-description: pppoe 70:a7:41:38:ed:f9\nerx-dhcp-mac-addr: 70a7.4138.edf9\nerx-qos-set-name: ae2-114\nerx-client-profile-name: PPPOE:\ncalabiyau-client-ip-address: 172.16.123.5\ncalabiyau-nas-profile: JUNIPER\ncalabiyau-nas-id: 19b88f68-0e9b-423f-82c8-2d4a5f83d4e3\ncalabiyau-user-id: 00034ae6-4d79-11ef-80c4-174adb24f2cd",
    "region": "South Africa",
    "event_id": "1722859200::bd44210d-5328-11ef-bf64-cfca366fc35d"
}

Caller Data Records (CDR)

The following API definitions describe howto query subscriber CDR logs. Please refer to Subscriber Telemetry - Caller Data Records documetation for more information relating their use.

There is a 32 day restriction on the time range for querying records. Data is retained for 5 years.

POST

/v1/subscriber/{subscriber_id}/cdr/records

(telemetry)

List Subscriber Caller Data Records (CDR).

Service
telemetry

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	Unique Subscriber ID.	X
end_time	body	string	End Report Date Time in ISO 8601.	X
start_time	body	string	Start Report Date Time in ISO 8601.	X

Request Example

{
    "start_time": "2024-08-01T00:00+02:00",
    "end_time": "2024-08-15T00:00+02:00"
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
acct_unique_id	body	string	Unique Session ID.
called_station_id	body	string	Subscriber called-station-id.
calling_station_id	body	string	Subscriber calling-station-id.
client_ip_address	body	string	Radius client IP Address.
download	body	string	Downloaded in Kilobytes.
duration	body	integer	Duration in seconds for session.
id	body	string	Unique CDR Record ID.
nas_ip_address	body	string	Session nas-ip-address.
start_time	body	string	Start Time of CDR Record.
terminate_cause	body	string	Terminate cause as reported by NAS.
update_time	body	string	Update Time of CDR Record.
upload	body	string	Uploaded in Kilobytes.
username	body	string	Subscriber username.

Response Example

[
    {
        "id": "d7231645-54b0-11ef-9d2b-aff022b163c4::2024-08-01",
        "start_time": "2024-08-07T11:33:17+00:00",
        "update_time": "2024-08-14T05:43:17+00:00",
        "acct_unique_id": "d7231645-54b0-11ef-9d2b-aff022b163c4",
        "username": "test@isp.com",
        "calling_station_id": null,
        "called_station_id": null,
        "nas_ip_address": "172.16.123.5",
        "client_ip_address": "172.16.123.5",
        "duration": 583800,
        "terminate_cause": null
    },
    {
        "id": "be4f2f06-5328-11ef-9295-174adb24f2cd::2024-08-01",
        "start_time": "2024-08-05T12:46:32+00:00",
        "update_time": "2024-08-07T11:33:10+00:00",
        "acct_unique_id": "be4f2f06-5328-11ef-9295-174adb24f2cd",
        "username": "test@isp.com",
        "calling_station_id": null,
        "called_station_id": null,
        "nas_ip_address": "172.16.123.5",
        "client_ip_address": "172.16.123.5",
        "duration": 168398,
        "terminate_cause": "Lost-Carrier"
    },
    {
        "id": "c859897c-4f01-11ef-a882-aff022b163c4::2024-08-01",
        "start_time": "2024-07-31T05:57:34+00:00",
        "update_time": "2024-08-05T11:30:11+00:00",
        "acct_unique_id": "c859897c-4f01-11ef-a882-aff022b163c4",
        "username": "test@isp.com",
        "calling_station_id": null,
        "called_station_id": null,
        "nas_ip_address": "172.16.123.5",
        "client_ip_address": "172.16.123.5",
        "duration": 451957,
        "terminate_cause": "NAS-Request"
    }
]

GET

/v1/subscriber/cdr/record/{cdr_id}

(telemetry)

Get Subscriber Caller Data Record (CDR).

Service
telemetry

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
cdr_id	url	string	Unique CDR ID.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
acct_session_id	body	string	NAS Session ID.
acct_unique_id	body	string	Unique CDR Record ID.
called_station_id	body	string	Subscriber called-station-id.
calling_station_id	body	string	Subscriber calling-station-id.
client_ip_address	body	string	Radius client IP Address.
duration	body	integer	Duration in seconds for session.
id	body	string	Unique CDR Record ID.
iplog[].prefix	body	string	IP Address / Prefix used by session.
iplog[].prefix_type	body	string	Type of IP Prefix (framed-ip-address, framed-ipv6-address, framed-ipv6-prefix, delegated-ipv6-prefix)
name	body	string	Subscriber name.
nas_identifier	body	string	NAS Identifier as configured or provided by NAS.
nas_ip_address	body	string	Session nas-ip-address.
nas_port	body	string	NAS Port as configured or provided by NAS.
nas_port_id	body	string	NAS Port ID as configured or provided by NAS.
nas_port_type	body	string	NAS Port Type as configured or provided by NAS.
profile	body	string	Name of Subscriber Profile for CDR record.
service	body	string	Name of Service Profile for CDR record.
start_time	body	string	Start Time of CDR Record.
terminate_cause	body	string	Terminate cause as reported by NAS.
update_time	body	string	Update Time of CDR Record.
username	body	string	Subscriber username.
virtual	body	string	Name of Virtual Server for CDR record.

Response Example

{
    "id": "be4f2f06-5328-11ef-9295-174adb24f2cd::2024-08-01",
    "start_time": "2024-08-05T12:46:32+00:00",
    "update_time": "2024-08-07T11:33:10+00:00",
    "acct_session_id": "89195146",
    "acct_unique_id": "be4f2f06-5328-11ef-9295-174adb24f2cd",
    "name": "Test Customer PPPOE",
    "username": "test@isp.com",
    "calling_station_id": null,
    "called_station_id": null,
    "nas_ip_address": "172.16.123.5",
    "nas_identifier": "mx204",
    "nas_port": "100",
    "nas_port_type": "Ethernet",
    "nas_port_id": "ae2:114-100",
    "client_ip_address": "172.16.123.5",
    "realm": null,
    "realm_id": null,
    "duration": 168398,
    "upload": 871612,
    "download": 16534488,
    "framed_protocol": "PPP",
    "vrf": null,
    "client_mac_address": null,
    "policy_in": null,
    "policy_out": null,
    "imsi": null,
    "msisdn": null,
    "charging_id": null,
    "sgsn_address": null,
    "ggsn_address": null,
    "terminate_cause": "Lost-Carrier",
    "profile": "25 Mbps Uncapped",
    "service": "BROADBAND (IPV4 NAT)",
    "virtual": "Broadband",
    "iplog": [
        {
            "prefix_type": "framed-ip-address",
            "prefix": "100.66.119.120"
        }
    ]
}

Subscriber Reports

A subscriber report contains information about all subscribers within a the provided domain context. The available report types are: Subscriber Usage; Subscriber Credit Usage; and Active/Inactive Subscribers.

The following API definitions describe how to query subscriber reports.

POST

/v1/subscriber/report

(telemetry)

Subscriber Report.

Service
telemetry

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
format	header	string	The format in which to report the report. Accepted values - "csv", "json"
month	body	string	The month for which the report is generated (in the form "YYYY-MM")
timezone	body	string	The timezone string representing the timezone in which the report is generated
type	body	string	The report type. Accepted values - "USAGE", "CREDIT", "ACTIVE_INACTIVE"

Request Example

{
    "type": "USAGE",
    "timezone": "Africa/Johannesburg",
    "month": "2024-11"
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
Report Data	body	string	Report Data.

Response Example

{
    "subscriber_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "subscriber_name": "XXX",
    "subscriber_username": "user@domain.co.za",
    "subscriber_service": "XXX",
    "subscriber_package": "XXX",
    "download_gb": 999.99,
    "upload_gb": 999.99,
    "combined_gb": 999.99,
    "download_kb": 9999999,
    "upload_kb": 9999999,
    "combined_kb": 9999999
}