RErespan
Dashboard

Get cache hit summary

Changed on

Returns cache hit metrics aggregated over the time range.

post/api/dashboard/cache-hit-metrics/summary/

Request

  • Base URL
    https://api.respan.ai
  • URL
    https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

summary_type'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' | 'last_24h' | 'all'

Preset time range. Use this or explicit start_time / end_time.

datestring date

Base date used with summary_type presets.

start_timestring date-time

Optional explicit ISO start time.

end_timestring date-time

Optional explicit ISO end time.

time_tick'minute' | 'hour' | 'day'

Bucket granularity for time-series responses.

timezone_offsetnumber

Timezone offset, in hours, used when resolving preset ranges.

Response

Successful response.

Changes

  • c30bcb383ee8Revision changes
    • breaking

      the / response's property format changed from double to no format for status

    • breaking

      the / response's property format changed from double to no format for status

    • info

      api operation id dashboard_getCacheHitMetricsSummary removed and replaced with getCacheHitMetricsSummary

    • info

      the endpoint scheme security DashboardJwt was added to the API

    • info

      api tag Dashboard added

    • info

      api tag dashboard removed

    • info

      for the query request parameter timezone_offset, the format was generalized from double to no format

  • b830b79cfd52Revision changes
    • info

      added the non-success response with the status