# Object Store v2 Statistics API

Retrieve usage statistics for Object Store v2 stores, environments, and regions.

- **Version:** 1.0.0
- **Category:** Storage
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/object-store-v2-stats/api.yaml)

## Servers
- `https://object-store-stats.anypoint.mulesoft.com/api/v1`

## Operations (7)
### GET /organizations/{organizationId}

**Operation ID:** `getOrganizationsByOrganizationid`
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](https://docs.mulesoft.com/object-store/osv2-apis#osv2-usage-limits)

**Parameters:**
| `startDate` | query | The startDate query parameter. | required |
| `endDate` | query | The endDate query parameter. | required |
| `period` | query | The period query parameter. | required |
| `isMaster` | query | If true, provide OS usage for master org along with all underlying sub orgs. If false provide OS usage for only org provided.
 | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments

**Operation ID:** `getOrganizationsByOrganizationidEnvironments`
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](https://docs.mulesoft.com/object-store/osv2-apis#osv2-usage-limits)

**Parameters:**
| `startDate` | query | The startDate query parameter. | required |
| `endDate` | query | The endDate query parameter. | required |
| `period` | query | The period query parameter. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentid`
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](https://docs.mulesoft.com/object-store/osv2-apis#osv2-usage-limits)

**Parameters:**
| `startDate` | query | The startDate query parameter. | required |
| `endDate` | query | The endDate query parameter. | required |
| `period` | query | The period query parameter. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/regions

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRegions`
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](https://docs.mulesoft.com/object-store/osv2-apis#osv2-usage-limits)

**Parameters:**
| `startDate` | query | The startDate query parameter. | required |
| `endDate` | query | The endDate query parameter. | required |
| `period` | query | The period query parameter. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/regions/{regionId}

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionid`
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](https://docs.mulesoft.com/object-store/osv2-apis#osv2-usage-limits)

**Parameters:**
| `startDate` | query | The startDate query parameter. | required |
| `endDate` | query | The endDate query parameter. | required |
| `period` | query | The period query parameter. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/stores

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidStores`
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](https://docs.mulesoft.com/object-store/osv2-apis#osv2-usage-limits)

**Parameters:**
| `startDate` | query | The startDate query parameter. | required |
| `endDate` | query | The endDate query parameter. | required |
| `period` | query | The period query parameter. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/regions/{regionId}/stores/{storeId}

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidRegionsByRegionidStoresByStoreid`
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](https://docs.mulesoft.com/object-store/osv2-apis#osv2-usage-limits)

**Parameters:**
| `startDate` | query | The startDate query parameter. | required |
| `endDate` | query | The endDate query parameter. | required |
| `period` | query | The period query parameter. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `regionId` | query | The region ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |