Overview
Statistics
7
Operations
0
Skills
Storage
Category
Retrieve usage statistics for Object Store v2 stores, environments, and regions.
Servers
-
https://object-store-stats.anypoint.mulesoft.com/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 organization request counts getOrganizationRequestCounts
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get list of request counts. If you are using connected app, "Store Metrics Viewer" scope is needed. For query timeframes and retention refer to OSv2 documentation
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
Query Parameters
startDate *:
string(date-time)The startDate query parameter.
endDate *:
string(date-time)The endDate query parameter.
period *:
stringThe period query parameter.
isMaster *:
booleanIf true, provide OS usage for master org along with all underlying sub orgs. If false provide OS usage for only org provided.
default:
FalseResponse
List of request counts, one per period in the queried time frame.
Examples
application/json
[
{
"timeStamp": "2015-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-01-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-02-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-03-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-04-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-05-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-06-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-07-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-08-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-09-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-10-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-11-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-01-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-02-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-03-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-04-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-05-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-06-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-07-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-08-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-09-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-10-01T00:00:00+00:00",
"objectStoreRequestCount": 12
},
{
"timeStamp": "2017-11-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
}
]
List organization environments listOrganizationEnvironments
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get list of environments with data for a specific queried time frame. This api will also return list of deleted environments. If you are using connected app, "Store Metrics Viewer" scope is needed. For query timeframes and retention refer to OSv2 documentation
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
Query Parameters
startDate *:
string(date-time)The startDate query parameter.
endDate *:
string(date-time)The endDate query parameter.
period *:
stringThe period query parameter.
Response
List of environments with data in the queried time frame.
Examples
application/json
[
"myEnvironment1",
"myEnvironment2"
]
Get environment request counts getEnvironmentRequestCounts
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get list of request counts. If you are using connected app, "Store Metrics Viewer" scope is needed. For query timeframes and retention refer to OSv2 documentation
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(date-time)The startDate query parameter.
endDate *:
string(date-time)The endDate query parameter.
period *:
stringThe period query parameter.
Response
List of request counts, one per period in the queried time frame.
Examples
application/json
[
{
"timeStamp": "2015-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-01-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-02-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-03-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-04-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-05-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-06-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-07-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-08-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-09-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-10-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-11-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-01-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-02-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-03-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-04-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-05-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-06-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-07-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-08-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-09-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-10-01T00:00:00+00:00",
"objectStoreRequestCount": 12
},
{
"timeStamp": "2017-11-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
}
]
List environment regions listEnvironmentRegions
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get list of regions with data for a specific queried time frame. If you are using connected app, "Store Metrics Viewer" scope is needed. For query timeframes and retention refer to OSv2 documentation
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(date-time)The startDate query parameter.
endDate *:
string(date-time)The endDate query parameter.
period *:
stringThe period query parameter.
Response
List of regions with data in the queried time frame.
Examples
application/json
[
"us-east-1",
"eu-west-2"
]
Get region request counts getRegionRequestCounts
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get list of request count per region. If you are using connected app, "Store Metrics Viewer" scope is needed. For query timeframes and retention refer to OSv2 documentation
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
startDate *:
string(date-time)The startDate query parameter.
endDate *:
string(date-time)The endDate query parameter.
period *:
stringThe period query parameter.
Response
List of request count per region, one per period in the queried time frame.
Examples
application/json
[
{
"timeStamp": "2015-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-01-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-02-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-03-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-04-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-05-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-06-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-07-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-08-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-09-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-10-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-11-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-01-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-02-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-03-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-04-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-05-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-06-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-07-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-08-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-09-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-10-01T00:00:00+00:00",
"objectStoreRequestCount": 12
},
{
"timeStamp": "2017-11-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
}
]
List region stores listRegionStores
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get list of stores with data for a specific queried time frame. This api will also return list of deleted stores. If you are using connected app, "Store Metrics Viewer" scope is needed. For query timeframes and retention refer to OSv2 documentation
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
startDate *:
string(date-time)The startDate query parameter.
endDate *:
string(date-time)The endDate query parameter.
period *:
stringThe period query parameter.
Response
List of stores with data in the queried time frame.
Examples
application/json
[
"myStore1",
"myStore2",
"anotherSampleStore"
]
Get store request counts getStoreRequestCounts
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get list of request count per store. If you are using connected app, "Store Metrics Viewer" scope is needed. For query timeframes and retention refer to OSv2 documentation
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.
storeId *:
stringThe store ID to identify the target resource.
Query Parameters
startDate *:
string(date-time)The startDate query parameter.
endDate *:
string(date-time)The endDate query parameter.
period *:
stringThe period query parameter.
Response
List of request count per store, one per period in the queried time frame.
Examples
application/json
[
{
"timeStamp": "2015-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-01-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-02-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-03-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-04-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-05-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-06-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-07-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-08-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-09-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-10-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-11-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2016-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-01-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-02-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-03-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-04-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-05-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-06-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-07-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-08-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-09-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-10-01T00:00:00+00:00",
"objectStoreRequestCount": 12
},
{
"timeStamp": "2017-11-01T00:00:00+00:00",
"objectStoreRequestCount": 0
},
{
"timeStamp": "2017-12-01T00:00:00+00:00",
"objectStoreRequestCount": 0
}
]