ARM Monitoring Query API

1.0.0

Overview

Statistics
8 Operations
0 Skills
Monitoring Category
Query application metrics and performance data for Mule applications managed through Anypoint Runtime Manager. Filter by application, time range, and environment.

Servers

  • US https://anypoint.mulesoft.com/monitoring/query/api/v{version}/organizations/{organizationId}/environments/{envId}
  • EU https://eu1.anypoint.mulesoft.com/monitoring/query/api/v{version}/organizations/{organizationId}/environments/{envId}
  • CA https://ca1.platform.mulesoft.com/monitoring/query/api/v{version}/organizations/{organizationId}/environments/{envId}
  • JP https://jp1.platform.mulesoft.com/monitoring/query/api/v{version}/organizations/{organizationId}/environments/{envId}

Authentication & Security

  • bearerAuth http

    Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login

  • clientAuth oauth2

    OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

List application metrics listApplicationMetrics

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of application metrics with aggregated values.

Query Parameters

id *: integer
detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
applications *: array

List application metrics by IDs listApplicationMetricsByIds

POST

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Returns a list of application metrics with aggregated values corresponding with the provided ids.

Query Parameters

detailed: boolean

Request Body

json
ids *: array

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
applications *: array

Get application metrics by ID getApplicationMetricsById

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of application metrics with the aggregated values.

Path Parameters

id *: string

Query Parameters

detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
applications *: array

List application flow metrics listApplicationFlowMetrics

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of flow metrics with aggregated values.

Path Parameters

id *: string

Query Parameters

id *: integer
detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
flows *: array

List application flow metrics by IDs listApplicationFlowMetricsByIds

POST

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Returns a list of flow metrics with aggregated values corresponding with the provided ids.

Path Parameters

id *: string

Query Parameters

detailed: boolean

Request Body

json
ids *: array

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
flows *: array

List target metrics listTargetMetrics

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of target metrics with aggregated values.

Query Parameters

id *: integer
detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
targets *: array

List target metrics by IDs listTargetMetricsByIds

POST

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Returns a list of target metrics with aggregated values corresponding with the provided ids.

Query Parameters

detailed: boolean

Request Body

json
ids *: array

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
targets *: array

Get target metrics by ID getTargetMetricsById

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of target metrics with the aggregated values.

Path Parameters

id *: string

Query Parameters

detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
targets *: array