added
Organization Usage Endpoint
December 18th, 2024 by Sam Moskal
We're excited to introduce the Organization Usage endpoint, a new addition to our API that allows organizations to retrieve detailed API usage statistics. This feature provides enhanced visibility and control over your API consumption.
Key Features:
- Retrieve month-to-date usage data aligned with https://dash.genability.com/org/usage
- Flexible data retrieval for monitoring, alarming, and analytics
- Daily updates at midnight UTC
- Secure authentication using appId and appKey
Endpoint Details:
- Resource URI: GET /rest/v1/orgs/usage
- Optional parameters:
- populateAggregateUsage (boolean)
- populateChildOrgs (boolean)
- populateMasterTariffIds (boolean)
- startYearMonth (dateTime)
- endYearMonth (dateTime)
- Usage Data Includes:
- API credits
- Calculation credits
- Tariff credits
- Switch account metrics
- Storage profile information
- Residential and commercial tariff counts
Please refer to our developer docs for more information.