v3

latestOpenAPI 3.1.02026-07-318648277.6 KB
Analytics

All-Time Summary

Get lifetime statistics for your account.

get/v1/analytics/summary

Query parameters

start_datestring date

Start date (YYYY-MM-DD)

end_datestring date

End date (YYYY-MM-DD)

Response

Summary statistics retrieved successfully

total_api_requestsinteger
total_credits_consumednumber
unique_products_usedinteger
successful_requestsinteger
failed_requestsinteger
success_ratenumber
avg_response_time_msnumber
first_requeststring date-time nullable
last_requeststring date-time nullable

Example response

{
  "total_api_requests": 1250000,
  "total_credits_consumed": 425000.5,
  "unique_products_used": 15,
  "successful_requests": 1150000,
  "failed_requests": 100000,
  "success_rate": 92,
  "avg_response_time_ms": 245,
  "first_request": "2023-06-15T10:30:00.000Z",
  "last_request": "2024-02-01T14:22:00.000Z"
}