Since this is undocumented at the moment, I decided to start digging around.
API Endpoint
/api2/perfstack
https://swservername/api2/perfstack
Query Paramaters
- count
- resolution
- startTime
- endTime
- details
- relations
PerfStack Query Paramaters
- offset
- length
- orderBy
- sort
- displayName
- status
- type
- user
- updateLastAccessed
MetaData
Endpoint: metadata/
States
Endpoint: metadata/states
Lists All States
https://swservername/api2/perfstack/metadata/states
Lists a single state by ID
metadata/states/{statusIds}
Example: https://swservername/api2/perfstack/metadata/states/1
Types
Endpoint: metadata/types
List all Types
https://swservername/api2/perfstack/metadata/types
List specific Type
metadata/types/{entityTypeCdl}
Entities
Endpoint: entities/
Query Parameters
- Length
- Offset
Get Entity Info
Endpoint: entities/{entityIdsCdl}
Filters
- entityId
Query Parameters – Used to Get Metrics
- Count
- Resolution
- StartDate
- EndDate
Examples:
Gets entity information for a single node based on entityID
https://swservername/api2/perfstack/entities/0_Orion.Nodes_2055/
Get Metrics for entityID, returns first measurement for each metric
https://swservername/api2/perfstack/entities/0_Orion.Nodes_2055/?count=1
Get Available Metrics For Entity
Endpoint: entities/{entityIdsCdl}/metrics
Filters
- entityId
Query Parameters – Used to Get Metrics
- Count
- Resolution
- StartDate
- EndDate
Examples:
Gets all metric types for a specific entity
https://swservername/api2/perfstack/entities/0_Orion.Nodes_2055/metrics
Get Metrics for entityID, returns first measurement for each metric
https://swservername/api2/perfstack/entities/0_Orion.Nodes_2055/metrics/?count=1
Get Relationships for Entity
Endpoint: entities/{entityIdsCdl}/relationships
Example: https://swservername/api2/perfstack/entities/0_Orion.Nodes_2055/relationships
States
Endpoint: entities/states
List all states
https://swservername/api2/perfstack/entities/states
List state by ID
Endpoint: /states/{statusIds}
Example: https://swservername/api2/perfstack/entities/states/2
Types
Endpoint: entities/types
List all Types
https://swservername/api2/perfstack/entities/types
List by TypeID
Endpoint: entities/types/{entityTypeCdl}
Metrics
Endpoint: metrics/
Filters
- entityId
- metricId
Query Parameters
- Count
- Resolution
- StartDate
- EndDate
Get Measurement For Entity
Endpoint: metrics/{id}
Get Groups For Entity
Endpoint: metrics/{entityId}/groups
Get Measurement For Group
Endpoint: metrics/{entityId}/groups/{groupId}