FUP

Get traffic usage

Service traffic usageRetrieve internet service traffic usage info

get/admin/fup/usage/{service_id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/fup/usage/{service_id}
  • Auth: HTTP basic

Path parameters

service_idnumber double required
Example:151

The internet service ID

Query parameters

with_textsboolean required
Example:true

Get texts for the Progress widget

sub_idnumber double
Example:1

Optional. Available for the main LBA (Linked Billing Account) customer. When provided, returns the traffic usage of the sub-account's service; the sub-account must belong to the main customer taken from the token, and the service must belong to that sub-account.

Response

traffic_amountnumber

Total amount of used traffic in bytes

over_usagenumber

Amount of traffic used beyond the allocated limit in bytes

used_amountnumber

Used traffic amount in bytes

remains_amountnumber

Remains traffic amount in bytes

cap_amountnumber

CAP traffic amount in bytes

used_percentnumber

Used traffic part in percents

remains_percentnumber

Remains traffic part in percents

cap_percentnumber

CAP traffic part in percents

bonus_trafficnumber

Bonus traffic

bonus_is_unlimitednumber

Bonus is unlimited

bonus_remains_amountnumber

Bonus remains amount

bonus_cap_amountnumber

Bonus CAP amount

bonus_used_percentnumber

Bonus used percent

bonus_remains_percentnumber

Bonus remains percent

bonus_cap_percentnumber

Bonus CAP percent

cap_bar_positionnumber

Position of CAP bar (on the Progress widget)

remains_bar_positionnumber

Position of remains bar (on the Progress widget)

used_textstring

Title of used bar. Returned only if param with_texts is true.

used_label_titlestring

Title of used label. Returned only if param with_texts is true.

capped_altstring

Text on hover of CAP bar. Returned only if param with_texts is true.

capped_not_used_textstring

Title of CAP bar. Returned only if param with_texts is true.

capped_text_allstring

Title of the CAP bar, indicating the total allocated limit.

all_textstring

All plan traffic title. Returned only if param with_texts is true.

remains_textstring

Title of remains bar. Returned only if param with_texts is true.

used_altstring

Text on hover of used bar. Returned only if param with_texts is true.

remains_altstring

Text on hover of remains bar. Returned only if param with_texts is true.

bonus_capped_text_allstring

Title of the bonus CAP bar, indicating the total bonus traffic allocated.

full_cap_amountnumber

Full CAP traffic amount in bytes

bonus_all_textstring

Title indicating the total bonus traffic available

bonus_used_label_titlestring

Title of the label indicating the amount of bonus traffic used

bonus_used_textstring

Text displaying the used bonus traffic amount

bonus_used_altstring

Text displayed on hover over the bonus usage bar, showing the used and total bonus traffic

bonus_remains_textstring

Text displaying the remaining bonus traffic

bonus_remains_altstring

Text displayed on hover over the bonus remaining bar, showing the remaining bonus traffic

bonus_capped_not_used_textstring

Title of the bonus CAP bar, indicating the amount of bonus traffic not yet used

bonus_capped_altstring

Text displayed on hover over the bonus CAP bar, showing the remaining and total bonus traffic

Example response

{
  "traffic_amount": 40000000000,
  "over_usage": 0,
  "used_amount": 323862,
  "remains_amount": 676138,
  "cap_amount": 2000000,
  "used_percent": 10.79,
  "remains_percent": 22.53,
  "cap_percent": 66.66,
  "bonus_traffic": 0,
  "bonus_is_unlimited": 0,
  "bonus_remains_amount": 0,
  "bonus_cap_amount": 0,
  "bonus_used_percent": 0,
  "bonus_remains_percent": 0,
  "bonus_cap_percent": 0,
  "cap_bar_position": 2,
  "remains_bar_position": 1,
  "used_text": "323.86 KB",
  "used_label_title": "323.86 KB",
  "capped_alt": "Remains: 2 MB / 2 MB CAP",
  "capped_not_used_text": "2 MB",
  "capped_text_all": "2 MB",
  "all_text": "1 MB",
  "remains_text": "676.14 KB",
  "used_alt": "Used: 323.86 KB / 1 MB (+2 MB CAP)",
  "remains_alt": "Remains: 676.14 KB / 1 MB (+2 MB CAP)",
  "bonus_capped_text_all": "(+2 MB Bonus CAP)",
  "full_cap_amount": 2000000,
  "bonus_all_text": "0 B",
  "bonus_used_label_title": "0 B",
  "bonus_used_text": "0 B",
  "bonus_used_alt": "Used: 0 B \\/ 0 B",
  "bonus_remains_text": "``",
  "bonus_remains_alt": "Remains: 0 B \\/ 0 B",
  "bonus_capped_not_used_text": "0 B",
  "bonus_capped_alt": "Remains: 0 B \\/ 0 B Bonus CAP"
}

Changes

No recorded changes to this operation across all 1 revision of this API.