HomeGuidesAPI Reference
API Reference

Get IPSLA time series statistics for network performance monitoring.

Retrieves IP SLA (Service Level Agreement) time series statistics for a specific appliance. Returns metrics including latency, packet loss, jitter, and probe status over the specified time range. Supports both JSON and CSV output formats.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

string

Configuration key identifying the IPSLA monitor. Format: 'type=$monitorType;tunnel-name=$tunnelName;src-port-label=$portLabel'.

string

Target URL or IP address specified in the IPSLA monitor configuration. Leading/trailing whitespace is automatically trimmed.

int64
required
≥ 0

Start of the time range as Unix epoch timestamp in seconds. Must be non-negative and less than endTime.

int64
required
≥ 0

End of the time range as Unix epoch timestamp in seconds. Must be non-negative and greater than startTime.

string
enum
required

Data aggregation interval determining the resolution of returned statistics. Case-insensitive.

Allowed:
int32
1 to 10000
Defaults to 10000

Maximum number of statistics records to return. Default and maximum value is 10000.

string
enum
Defaults to json

Response format type. When set to 'csv', returns data as CSV file download. Default is JSON.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized - Authentication credentials are missing or invalid.

403

Forbidden - User does not have READ or READ_WRITE permission.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.ms-excel