Control Panel — API documentation

Utilization

Bandwidth usage Read-only

The Utilizations object shows daily bandwidth usage.

By default, the API only returns the date and the bytes utilized on that date. To group the utilization data under more fields, use the fields filter. For eg:- to group the utilization data by the app and stream name, pass fields=app,stream as one of your query parameters. Check the supported fields in the Filters tab.

Descriptions

type Integer Autogenerated

Specify the object type to be summarized

Flags:

  • 4 - VSN
  • 6 - VSE
  • 7 - PushPublish/Restreaming

Sample value:6

date String Autogenerated

The date the summarized data should represent.

Sample value:2019-12-23

bytes Integer Synthetic

Number of bytes used.

Sample value:1234567

app String Autogenerated

Unique identifier of the VSE App

Sample value:example-origin

inst String Autogenerated

Unique identifier of the VSE Application Instance

Sample value:live

stream String Autogenerated

Unique identifier of the VSE stream

Sample value:stream1

server Integer Autogenerated

Unique identifier of the server.

Sample value:123

start_date String

The date the summarized data should start at.

Sample value:2019-12-23

end_date String

The date the summarized data should end at.

Sample value:2019-12-30

fields Integer

Filter the response with the specified fields

Enum:date, type, server, app, inst, stream

Sample value:stream

vse_meta Integer

Unique identifier of the VSE Metadata

Sample value:

type Integer Autogenerated

Specify the object type to be summarized

Flags:

  • 4 - VSN
  • 6 - VSE
  • 7 - PushPublish/Restreaming

Sample value:6

app String Autogenerated

Unique identifier of the VSE App

Sample value:example-origin

inst String Autogenerated

Unique identifier of the VSE Application Instance

Sample value:live

stream String Autogenerated

Unique identifier of the VSE stream

Sample value:stream1

None
None

Examples

Get the Utilization object.

Example URL

https://api.scaleengine.net/dev/v2/utilizations/

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/dev/v2/utilizations/

Example response data

{
    "data": [
        {
            "date": "2021-10-19",
            "bytes": "185080787782"
        },
        {
            "date": "2021-10-20",
            "bytes": "150280475393"
        },
        {
            "date": "2021-10-21",
            "bytes": "141589065698"
        },
        {
            "date": "2021-10-22",
            "bytes": "27894963079"
        },
        {
            "date": "2021-10-23",
            "bytes": "4716902807"
        }
}

This object is read-only and cannot be created

This object is read-only and cannot be updated

This object is read-only and cannot be deleted

Errors

ACCESS_VIOLATION

You do not have access to modify this field