NSns-api
iNSight

Query Data from iNSight

Changed on
get/insight/{label}

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/insight/{label}
  • Auth
    HTTP bearer

Path parameters

label'core_activecalls' | 'core_domains' | 'node_load5' | 'node_load5_max' | 'alerts' | 'core_subscribers' | 'core_registered' | 'nsnode_sockets' | 'system_packet_dispatched_total' | 'sip_invite_received_total' | 'sbus_system_queued' | 'custom' required

Query parameters

range'last_hour' | 'last_6_hours' | 'last_12_hours' | 'last_24_hours' | 'last_7_days' | 'last_28_days'

The range to use in the query, using this option will avoid the need to calculate start, end and step.

aggregated'aggregated' | 'server'

Select Eiterh aggregated data or by server.

startnumber

This is the start value when using pagination. 0 is the default and the minimum value. For example the default of 0 paired with the default limit of 100 would return the first 100 objects in the data request. A start of 100 and a default limit of 100 would give you the second 100 results in the response.

The timestamp to start the range. Optional and will override range values.

endinteger

The timestamp to end the range. Optional and will override range values.

stepstring

The interval to use in the query. Optional and will override range values.

querystring

advanced use only, will override full query if label set to "custom" you can use to provide full promQL query

Response

serverstring

Optional Server is aggregated by server

valuenumber required

The value

tsinteger required

The timestamp for the value. Modulo the expected interval/step

Changes