Oracle Management Cloud APM REST API

All REST Endpoints

Ajax Call Metrics

The Ajax Call Metrics API lets you retrieve information and performance metrics about Ajax Calls from your Pages in your monitored application servers

Get Ajax call by ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/ajaxCalls/{id}
Get Ajax call summary for a page ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages/{id}/ajaxCallsSummary
Get Ajax calls: Method: get
Path: /serviceapi/apm.dataserver/api/v1/ajaxCalls
Get Ajax calls for a page ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages/{id}/ajaxCalls
Get geographical data for an Ajax call: Method: get
Path: /serviceapi/apm.dataserver/api/v1/ajaxCalls/{id}/dataSeries
Get pages for a ajax call ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/ajaxCalls/{id}/pages
Get requests for Ajax call ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/ajaxCalls/{id}/requests
Get time series data for an Ajax call: Method: get
Path: /serviceapi/apm.dataserver/api/v1/ajaxCalls/{id}/timeSeries

Application Server Metrics

The Application Server Metrics API lets you retrieve information and performance metrics about monitored application servers

Delete application definition: Method: delete
Path: /serviceapi/apm.dataserver/api/v1/applications/{applicationName}
Get application definition by name: Method: get
Path: /serviceapi/apm.dataserver/api/v1/applications/{applicationName}
Get Application rollup summary for a given application name: Method: get
Path: /serviceapi/apm.dataserver/api/v1/applications/summary/{applicationName}
Get Application rollup summary for EUM , on a given application Name: Method: get
Path: /serviceapi/apm.dataserver/api/v1/applications/summary/{applicationName}/eumSummary
Get application server agent info: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appserveragent
Get application servers and their JVM metrics: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers
Get Application Summary for server requests: Method: get
Path: /serviceapi/apm.dataserver/api/v1/applications/summary/{applicationName}/serverSummary
Get connection pool data for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/connectionPools
Get connection pool data for known application server & connection pool IDs: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/connectionPools/{id}
Get database SQL summary information for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/databaseSqls
Get host information: Method: get
Path: /serviceapi/apm.dataserver/api/v1/hostinfo
Get host information by ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/hostinfo/{id}
Get information and JVM metrics about an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}
Get JVM information: Method: get
Path: /serviceapi/apm.dataserver/api/v1/jvminfo
Get JVM information by ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/jvminfo/{id}
Get operation by ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/operations/{id}
Get operations: Method: get
Path: /serviceapi/apm.dataserver/api/v1/operations
Get request summary information for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/requestSummary
Get resource operation genre: Method: get
Path: /serviceapi/apm.dataserver/api/v1/operationGenres
Get thread pool data for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/threadPools
Get thread pool data for known application server & thread pool IDs: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/threadPools/{id}
Get thread pool summary information for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/threadPoolSummary
Get time series data for an application server: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/timeSeries
Notify agents with new configuration: Method: post
Path: /serviceapi/apm.dataserver/api/v1/services/appservers/notify
Start profiler job: Method: post
Path: /serviceapi/apm.dataserver/api/v1/profiler/jobs

Connection Pool Metrics

The Connection Pool Metrics API lets you retrieve information and performance metrics about Connection Pools from your monitored application servers

Get connection pool data for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/connectionPools
Get connection pool data for known application server & connection pool IDs: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/connectionPools/{id}

End User Application Metrics

The End User Application Metrics API lets you retrieve information and performance metrics about applications collected via the Browser Agent.

Get application metric time series: Method: get
Path: /serviceapi/apm.dataserver/api/v1/applications/getMetricTimeBuckets

End User Page Update Metrics

The End User Page Update Metrics API lets you retrieve information and performance metrics about page updates collected via the Browser Agent.

Get page updates: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pageUpdates/getList

End User Session Metrics

The End User Session Metrics API lets you retrieve information and performance metrics about sessions collected via the Browser Agent.

Get browser types: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/getBrowserTypes
Get browser versions: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/getBrowserVersions
Get device operating system types: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/getDeviceOSTypes
Get device operating system versions: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/getDeviceOSVersions
Get device types: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/getDeviceTypes
Get events by session ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/getEvents
Get geographical data for a page: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/getGeoMapDataSeries
Get session by ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/get
Get session health breakdown: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/getSessionHealthBreakdown
Get sessions: Method: get
Path: /serviceapi/apm.dataserver/api/v1/sessions/getAll

Environment Resources

The Environment Resources API lets you retrieve from (or update) information about other resources in the system environment

Get Application Performance Index thresholds: Method: get
Path: /serviceapi/apm.dataserver/api/v1/getApDexThresholds
Get IP address masking: Method: get
Path: /serviceapi/apm.dataserver/api/v1/getIpMasking
Get Session Health weights: Method: get
Path: /serviceapi/apm.dataserver/api/v1/getSesHealthWeights
Set Application Performance Index thresholds: Method: post
Path: /serviceapi/apm.dataserver/api/v1/setApDexThresholds
Set IP Masking value: Method: post
Path: /serviceapi/apm.dataserver/api/v1/setIpMasking
Set Session Health weights: Method: post
Path: /serviceapi/apm.dataserver/api/v1/setSesHealthWeights

Logical Server Request Metrics

Get logical requests: Method: get
Path: /serviceapi/apm.dataserver/api/v1/applications/{applicationName}/logicalServerRequests
Get logical requests by ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/applications/{applicationName}/logicalServerRequests/{id}

PII Configuration

The PII Configuration API enables the configuration of parameters that control how PII sensitive data is handled, allowing identification and replacement of PII data through regular expressions, as well as controlling the processing or discarding of portions of the traffic that have been identified as possible carriers of PII sensitive information.

Gets the configuration: Method: get
Path: /serviceapi/apm.dataserver/api/v1/piiConfig/get
Set PII Configuration: Method: post
Path: /serviceapi/apm.dataserver/api/v1/piiConfig/set

Page Metrics

The Page Metrics API lets you retrieve information and performance metrics about Pages in your monitored application servers

Get Ajax call summary for a page ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages/{id}/ajaxCallsSummary
Get Ajax calls for a page ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages/{id}/ajaxCalls
Get Application Performance Index thresholds: Method: get
Path: /serviceapi/apm.dataserver/api/v1/getApDexThresholds
Get baseline and anomaly data for a page: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages/{id}/baselines
Get IP address masking: Method: get
Path: /serviceapi/apm.dataserver/api/v1/getIpMasking
Get page by ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages/{id}
Get pages: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages
Get pages for a ajax call ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/ajaxCalls/{id}/pages
Get Session Health weights: Method: get
Path: /serviceapi/apm.dataserver/api/v1/getSesHealthWeights
Get time series data for multiple pages: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages/timeSeries
Set Application Performance Index thresholds: Method: post
Path: /serviceapi/apm.dataserver/api/v1/setApDexThresholds
Set IP Masking value: Method: post
Path: /serviceapi/apm.dataserver/api/v1/setIpMasking
Set Session Health weights: Method: post
Path: /serviceapi/apm.dataserver/api/v1/setSesHealthWeights

Profiler Group Data

Application Performance Monitoring REST API for profiler

Get all profiler groups: Method: get
Path: /serviceapi/apm.dataserver/api/v1/profiler/jobs
Start profiler job: Method: post
Path: /serviceapi/apm.dataserver/api/v1/profiler/jobs

Server Link Metrics

The Server Link Metrics API lets you retrieve information and performance metrics about calls made within a Server Request in your monitored application servers

Get link summary for request ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/requests/{id}/operationLinks

Server Request Metrics

The Server Request Metrics API lets you retrieve information and performance metrics about Server Requests in your monitored application servers

Get database SQL summary information for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/databaseSqls
Get instance summaries for a request ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/requests/{id}/instances
Get profilers for an App Server: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/jobs
Get request summary information for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/requestSummary
Get requests for Ajax call ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/ajaxCalls/{id}/requests

Service Metrics

Create service definition: Method: post
Path: /serviceapi/apm.dataserver/api/v1/services
Get service definitions: Method: get
Path: /serviceapi/apm.dataserver/api/v1/services

Synthetic Monitoring

The Synthetic Monitoring API lets you create tests and retrieve information and performance metrics about created tests

Create synthetic test definition: Method: post
Path: /serviceapi/apm.dataserver/api/v1/synthetic/tests
Delete entity test for meId: Method: delete
Path: /serviceapi/apm.dataserver/api/v1/synthetic/tests/{id}
Get Synthetic Locations: Method: get
Path: /serviceapi/apm.dataserver/api/v1/synthetic/locations
Get Synthetic Test by Managed Entity ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/synthetic/tests/{id}
Get Synthetic Tests: Method: get
Path: /serviceapi/apm.dataserver/api/v1/synthetic/tests
Update synthetic test definition: Method: put
Path: /serviceapi/apm.dataserver/api/v1/synthetic/tests

Thread Pool Metrics

The Thread Pool Metrics API lets you retrieve information and performance metrics about Thread Pools from your monitored application servers

Get thread pool data for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/threadPools
Get thread pool data for known application server & thread pool IDs: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/threadPools/{id}
Get thread pool summary information for an application server ID: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/threadPoolSummary

Time Series Metrics

The Time Series Metrics API lets you retrieve information and performance metrics about time series data from your monitored application servers

Get baseline and anomaly data for a page: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages/{id}/baselines
Get time series data for an Ajax call: Method: get
Path: /serviceapi/apm.dataserver/api/v1/ajaxCalls/{id}/timeSeries
Get time series data for an application server: Method: get
Path: /serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/timeSeries
Get time series data for multiple pages: Method: get
Path: /serviceapi/apm.dataserver/api/v1/pages/timeSeries

Web Applications

The Web Application API facilitates configuration of Web Applications, identification through URL patterns, as well as managing Web Application related attributes, like naming of contextual information on Pages and Ajax Calls, and how to simplify URLs for better identification and aggregation.

Create Web Application definition: Method: post
Path: /serviceapi/apm.dataserver/api/v1/webApps/create
Get all Web Application definitions: Method: get
Path: /serviceapi/apm.dataserver/api/v1/webApps/getAll
Get the unconfigurable rules that are always applied.: Method: get
Path: /serviceapi/apm.dataserver/api/v1/webApps/alwaysAppliedRegexes
Get web-application metrics: Method: get
Path: /serviceapi/apm.dataserver/api/v1/webApps/getMetrics
Test a set of regular expressions: Method: post
Path: /serviceapi/apm.dataserver/api/v1/webApps/testRegexes
Update Web Application definition: Method: post
Path: /serviceapi/apm.dataserver/api/v1/webApps/update
Validate regular expression: Method: get
Path: /serviceapi/apm.dataserver/api/v1/webApps/validateRegex