Overview
Statistics
3
Operations
0
Skills
Monitoring
Category
Search and describe metric types for the Anypoint Observability platform.
Servers
-
https://anypoint.mulesoft.com/observability/api/v1 -
https://{region}.anypoint.mulesoft.com/observability/api/v1 -
https://{region}.platform.mulesoft.com/observability/api/v1
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
Get Metric Types getMetricTypes
GET
Try it out
Header Parameters
Custom Query Parameters
Custom Headers
Get a list of all supported metric names and descriptions.
Header Parameters
Authorization *:
stringBearer token for API authentication.
Response
Request processed successfully. The response contains list of metric types.
items:
arrayArray items
Examples
application/json
[
{
"name": "mulesoft.app",
"label": "Application Inbound Metrics",
"description": "Mulesoft Application inbound request metrics"
},
{
"name": "mulesoft.app.outbound",
"label": "Application Outbound Metrics",
"description": "Mulesoft Application outbound request traffic metrics"
},
{
"name": "mulesoft.message",
"label": "Mule Messages",
"description": "Mulesoft Application outbound request traffic metrics"
},
{
"name": "mulesoft.api",
"label": "API Metrics",
"description": "Mulesoft API traffic metrics"
},
{
"name": "mulesoft.api.client_ip",
"label": "API Client IP Metrics",
"description": "Mulesoft API traffic metrics with client ip attributes"
},
{
"name": "mulesoft.entity",
"label": "Entity Metrics",
"description": "Mulesoft Entity traffic metrics"
},
{
"name": "mulesoft.app.jvm.cpu",
"label": "Application CPU",
"description": "Mulesoft App JVM cpu metrics"
},
{
"name": "mulesoft.app.jvm.memory",
"label": "Application JVM Memory",
"description": "Mulesoft App JVM memory metrics"
},
{
"name": "mulesoft.app.jvm.classes",
"label": "JVM Classes",
"description": "Mulesoft App JVM class loader metrics"
},
{
"name": "mulesoft.app.jvm.gc",
"label": "Garbage Collector",
"description": "Mulesoft App GC metrics"
},
{
"name": "mulesoft.app.threads",
"label": "Application Threads",
"description": "Mulesoft App Thread metrics"
},
{
"name": "mulesoft.app.memory",
"label": "Virtual Memory",
"description": "Mulesoft App VirtualMemory metric"
}
]
Get Metric Types Metrictypename Describe getMetricTypesMetrictypenameDescribe
GET
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get the metric descriptor by a metric type name.
Path Parameters
metricTypeName *:
stringThe metricTypeName to identify the target resource.
Header Parameters
Authorization *:
stringAuthorization token
Response
Successful operation.
name *:
stringlabel:
stringdescription:
stringattributes *:
arraymeasurements *:
arrayExamples
application/json
{
"name": "mulesoft.app",
"label": "Application Inbound Metrics",
"description": "Mulesoft Application inbound request metrics",
"attributes": [
{
"name": "flow.id",
"data_type": "string",
"label": "Flow ID",
"description": "Invoked flow"
}
],
"measurements": [
{
"name": "requests",
"data_type": "number",
"label": "Request Counts",
"description": "Request Count in a particular time interval"
}
]
}
Create Metrics Search createMetricsSearch
POST
Try it out
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Fetch metrics with rich filtering and aggregation capabilities.
Query Parameters
limit:
integerSet a query limit as part of URI instead of the body. Primarily used for pagination. If different limits are defined for the body and query parameter, the API returns "400 Bad Request" due to the collision.
min: 1, max: 2000
offset:
integerSets a query offset for result set. Primarily used for pagination. If different offset values are defined for the body and query parameter, the API returns "400 Bad Request" due to the collision.
min: 0
Header Parameters
Authorization *:
stringAuthorization token
Request Body
jsonquery *:
stringSpecifies the search query to execute.
* The query must select from the
* The query must select at least one aggregated value.
* The WHERE clause must contain timestamp filter.
* The query must select from the
metric_type from the list of supported metrics.* The query must select at least one aggregated value.
* The WHERE clause must contain timestamp filter.
minLength: 1, pattern:
^select (.*) from (.*) where timestamp between ([0-9]+) and ([0-9]+)(.*)$Response
Successful operation.
data *:
arrayAn array of results with a shape defined by
Search Query.SelectClause section.metadata *:
objectContains metadata about the response.
Examples
application/json
{
"data": [
{}
],
"metadata": {
"pagination": {
"self": "string",
"prev": "string",
"next": "string",
"queryMethod": "POST",
"query": {
"query": "select timestamp, count(requests) as totalCount from \"mulesoft.api\" where timestamp between 1686087009573 and 1686088299573"
}
}
}
}