API key usage

## Overview The **API Usage Metrics API** provides detailed, per-day usage statistics associated with a specific API key. This endpoint enables clients to monitor and audit their API consumption across supported AwardTool services, including Panorama data endpoints and real-time search operations. Usage data is aggregated by date and is intended for billing validation, quota monitoring, and operational transparency. --- ## Authentication All requests must include a valid `api_key`. --- ## Request ### Request Body ``` json { "api_key": "YOUR_API_KEY" } ``` ### Request Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | `api_key` | String | Yes | API key for which usage statistics are being requested. | --- ## Response ### Successful Response ``` json { "data": [ { "date": "2023-12-11", "api_key": "683de76f-2e37-4253-8dbf-fd88b507bbc4", "panorama_flight_data": 1, "panorama_calendar_data": 1, "panorama_route_data": 1, "real_time_search": 3 }, { "date": "2023-12-12", "api_key": "YOUR_API_KEY", "panorama_calendar_data": 1, "api_usage": 2 } ], "status": 200 } ``` --- ## Response Fields ### Top-Level Fields | Field | Type | Description | | --- | --- | --- | | `data` | Array | List of daily usage records associated with the API key. | | `status` | Number | HTTP-like status code indicating request success. | --- ### Daily Usage Record Fields Each object in the `data` array represents usage metrics for a specific date. | Field | Type | Description | | --- | --- | --- | | `date` | String | Usage date (YYYY-MM-DD). | | `api_key` | String | API key associated with the usage record. | | `panorama_flight_data` | Number | Number of Panorama flight data requests. | | `panorama_calendar_data` | Number | Number of Panorama calendar data requests. | | `panorama_route_data` | Number | Number of Panorama route data requests. | | `real_time_search` | Number | Number of real-time search requests. | | `api_usage` | Number | Number of API usage retrieval calls (this endpoint). | **Note:** Fields may vary by date depending on which services were accessed on that day. Missing fields indicate zero usage for that category. --- ## Usage Notes - Usage data is aggregated **per day** and **per API key**. - Counts reflect **successful API calls** only. - This endpoint is intended for **monitoring and reporting** purposes and does not modify usage quotas. - Historical usage availability may be subject to retention limits. --- ## Common Use Cases - Validate monthly usage against contractual limits - Power internal billing and invoicing workflows - Monitor consumption trends and optimize API usage - Display usage dashboards for enterprise clients --- ## Error Handling | Status | Description | | --- | --- | | 400 | Invalid or missing API key | | 401 | Unauthorized access | | 500 | Internal server error |