Overview
Statistics
5
Operations
0
Skills
Messaging
Category
Retrieve usage statistics for Anypoint MQ queues, exchanges, and environments.
Servers
-
https://anypoint.mulesoft.com/mq/stats/api/{version} -
https://{region}.anypoint.mulesoft.com/mq/stats/api/{version} -
https://{region}.platform.mulesoft.com/mq/stats/api/{version}
Authentication & Security
-
oauth_2_0 oauth2
This API supports OAuth 2.0 for authenticating all API requests.
Get Organizations By Organizationid getOrganizationsByOrganizationid
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
MQ Usage Metrics by date for an organization,
across all environments. <br>
You can use this API to see number of api requests made,
number of messages received, number of billable units that depends on
the number of messages delivered to subscribers of a queue, and
message byte count sent & received by an organization. <br>
If you are using connected app, "Read MQ Stats" scope is needed. <br>
For query timeframes and retention refer to MQ Stats documentation. <br>
Note: This API has a limit of 10 requests per minute.
across all environments. <br>
You can use this API to see number of api requests made,
number of messages received, number of billable units that depends on
the number of messages delivered to subscribers of a queue, and
message byte count sent & received by an organization. <br>
If you are using connected app, "Read MQ Stats" scope is needed. <br>
For query timeframes and retention refer to MQ Stats documentation. <br>
Note: This API has a limit of 10 requests per minute.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
Query Parameters
startDate *:
string(rfc2616)Start date of the desired time window. MQ usage data is retained for up to 2 years depending on the granularity of the data requested.
endDate *:
string(rfc2616)End date of the desired time window.
period *:
stringThe granularity of data points. It can take values : 1hour, 1day, 1month.
Response
Successful operation.
items:
arrayArray items
Examples
application/json
[
{
"timestamp": "2018-11-08T00:00Z",
"apiRequestCount": 0,
"messageReceiptCount": 0,
"billableUnitCount": 0,
"messageByteCount": 0
}
]
Get Organizations By Organizationid Environments By Environmentid getOrganizationsByOrganizationidEnvironmentsByEnvironmentid
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
MQ usage metrics by date for an organization, for a particular envrionment. <br>
You can use this API to see number of api requests made,
number of messages received, number of billable units that depends on
the number of messages delivered to subscribers of a queue, and
message byte count sent & received by an organization, filtered by an environment. <br>
If you are using connected app, "Read MQ Stats" scope is needed. <br>
For query timeframes and retention refer to MQ Stats documentation. <br>
Note: This API has a limit of 10 requests per minute.
You can use this API to see number of api requests made,
number of messages received, number of billable units that depends on
the number of messages delivered to subscribers of a queue, and
message byte count sent & received by an organization, filtered by an environment. <br>
If you are using connected app, "Read MQ Stats" scope is needed. <br>
For query timeframes and retention refer to MQ Stats documentation. <br>
Note: This API has a limit of 10 requests per minute.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
Query Parameters
startDate *:
string(rfc2616)Start date of the desired time window. MQ usage data is retained for up to 2 years depending on the granularity of the data requested.
endDate *:
string(rfc2616)End date of the desired time window.
period *:
stringThe granularity of data points. It can take values : 1hour, 1day, 1month.
Response
Successful operation.
items:
arrayArray items
Examples
application/json
[
{
"timestamp": "2018-11-08T00:00Z",
"apiRequestCount": 0,
"messageReceiptCount": 0,
"billableUnitCount": 0,
"messageByteCount": 0
}
]
Get Organizations By Organizationid Environments By Environmentid Regions By Regionid Queues getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidQueues
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Realtime Stats for queues. <br>
Use this API to get current up-to-the-minute information about the number of visible and
in-flight messages in a queue. <br>
If you are using connected app, "View Destinations" or "Administer destinations" scope is needed. <br>
Note: This API has a limit of 100 requests per minute.
Use this API to get current up-to-the-minute information about the number of visible and
in-flight messages in a queue. <br>
If you are using connected app, "View Destinations" or "Administer destinations" scope is needed. <br>
Note: This API has a limit of 100 requests per minute.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
regionId *:
stringThe region ID to identify the target resource.
Query Parameters
destinationIds *:
stringComma-separated list of destination IDs.
default:
myDestinationResponse
Successful operation.
items:
arrayArray items
Examples
application/json
[
{
"destination": "myDestinationId",
"messages": 100,
"inflightMessages": 10
}
]
Get Organizations By Organizationid Environments By Environmentid Regions By Regionid Queues By Queueid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidQueuesByQueueid
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Historic stats for a queue. <br>
Use this API to get historic stats for a queue, up to 15 months old. <br>
This stats is not real time and expect up to 10 minutes latency before data is published. <br>
To keep the volume of data under control, historic data is retained at reduced levels of granularity. <br>
Second level data points are retained for 3 hours, one minute data points are available for past 15 days, five minute data points up to 63 days and one hour data points for up to 15 months. <br>
If you are using connected app, "View Destinations" or "Administer destinations" scope is needed. <br>
Note: This API has a limit of 100 requests per minute.
Use this API to get historic stats for a queue, up to 15 months old. <br>
This stats is not real time and expect up to 10 minutes latency before data is published. <br>
To keep the volume of data under control, historic data is retained at reduced levels of granularity. <br>
Second level data points are retained for 3 hours, one minute data points are available for past 15 days, five minute data points up to 63 days and one hour data points for up to 15 months. <br>
If you are using connected app, "View Destinations" or "Administer destinations" scope is needed. <br>
Note: This API has a limit of 100 requests per minute.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
regionId *:
stringThe region ID to identify the target resource.
queueId *:
stringIdentifier of a destination.
minLength: 1, maxLength: 127
Query Parameters
startDate *:
string(rfc2616)Start date of the desired time window. Note that the earliest start date one can specify is 3 months before the current time for 1hour granularity, 12 months for 1day granularity, 24 months for 1month granularity.
endDate *:
string(rfc2616)End date of the desired time window.
period *:
integerThe time granularity of metrics, expressed in seconds.
min: 1, max: 86400
Response
Successful operation.
destination:
stringinflightMessages:
arraymessages:
arraymessagesVisible:
arraymessagesSent:
arraymessagesReceived:
arraymessagesAcked:
arrayExamples
application/json
{
"destination": "myDestination",
"messages": [
{
"date": "2017-07-26T00:00:00.000+0000",
"value": 2126
},
{
"date": "2017-07-27T00:00:00.000+0000",
"value": 2126
},
{
"date": "2017-07-28T00:00:00.000+0000",
"value": 587
}
],
"inflightMessages": [
{
"date": "2017-07-26T00:00:00.000+0000",
"value": 0
},
{
"date": "2017-07-27T00:00:00.000+0000",
"value": 0
},
{
"date": "2017-07-28T00:00:00.000+0000",
"value": 0
}
],
"messagesVisible": [
{
"date": "2017-07-26T00:00:00.000+0000",
"value": 2126
},
{
"date": "2017-07-27T00:00:00.000+0000",
"value": 2126
},
{
"date": "2017-07-28T00:00:00.000+0000",
"value": 587
}
],
"messagesSent": [
{
"date": "2017-07-26T00:00:00.000+0000",
"value": 0
},
{
"date": "2017-07-27T00:00:00.000+0000",
"value": 0
},
{
"date": "2017-07-28T00:00:00.000+0000",
"value": 0
}
],
"messagesReceived": [
{
"date": "2017-07-26T00:00:00.000+0000",
"value": 0
},
{
"date": "2017-07-27T00:00:00.000+0000",
"value": 0
},
{
"date": "2017-07-28T00:00:00.000+0000",
"value": 0
}
],
"messagesAcked": [
{
"date": "2017-07-26T00:00:00.000+0000",
"value": 0
},
{
"date": "2017-07-27T00:00:00.000+0000",
"value": 0
},
{
"date": "2017-07-28T00:00:00.000+0000",
"value": 0
}
]
}
Get Organizations By Organizationid Environments By Environmentid Regions By Regionid Exchanges By Exchangeid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidExchangesByExchangeid
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Historic Stats for Exchange. <br>
Use this API to get historic stats for an exchange, up to 15 months old. <br>
This stats is not real time and expect up to 10 minutes latency before data is published. <br>
To keep the volume of data under control, historic data is retained at reduced levels of granularity. <br>
Second level data points are retained for 3 hours, one minute data points are available for past 15 days, five minute data points up to 63 days and one hour data points for up to 15 months. <br>
If you are using connected app, "View Destinations" or "Administer destinations" scope is needed. <br>
Note: This API has a limit of 100 requests per minute.
Use this API to get historic stats for an exchange, up to 15 months old. <br>
This stats is not real time and expect up to 10 minutes latency before data is published. <br>
To keep the volume of data under control, historic data is retained at reduced levels of granularity. <br>
Second level data points are retained for 3 hours, one minute data points are available for past 15 days, five minute data points up to 63 days and one hour data points for up to 15 months. <br>
If you are using connected app, "View Destinations" or "Administer destinations" scope is needed. <br>
Note: This API has a limit of 100 requests per minute.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
regionId *:
stringThe region ID to identify the target resource.
exchangeId *:
stringIdentifier of a destination.
minLength: 1, maxLength: 127
Query Parameters
startDate *:
string(rfc2616)Start date of the desired time window. Note that the earliest start date one can specify is 3 months before the current time for 1hour granularity, 12 months for 1day granularity, 24 months for 1month granularity.
endDate *:
string(rfc2616)End date of the desired time window.
period *:
integerThe time granularity of metrics, expressed in seconds.
min: 1, max: 86400
Response
Successful operation.
0:
objectExamples
application/json
{
"destination": "myDestinationId",
"messagesPublished": 100,
"messagesDelivered": 10
}