v1

latestOpenAPI 3.1.0Commercial License2026-07-132434129.1 KB

Usage Statistics

Get usage summary

        Retrieves aggregated summary statistics for your API key within a specified date range.
        Returns totals and averages without hourly breakdown, useful for dashboard overview.

        **Authorization:** Requires valid API key.

        **Example usage:**
        ```
        GET /api/v1/usage/summary?api_key=YOUR_KEY&start_date=2025-11-01T00:00:00Z&end_date=2025-11-04T00:00:00Z
        ```

get/api/v1/usage/summary

Query parameters

api_keystring required

Your API key

start_datestring date-time required

Start date in ISO 8601 format (inclusive)

end_datestring date-time required

End date in ISO 8601 format (exclusive)

api_type'IP' | 'ADVANCED_EMAIL_VALIDATION'

Filter by API type (optional)

Response

Successfully retrieved usage summary

apiKeystring required

apiTypestring required

periodStartstring date-time required

periodEndstring date-time required

totalRequestsinteger required

successfulRequestsinteger required

rateLimitedRequestsinteger required

quotaConsumedinteger required

batchOperationsinteger required

avgRequestDurationMsnumber double nullable