Sign in
Settlement Metrics

Retained Dashboard

Changed on

The TV's firm-wide retained-case figures for the web app.

get/settlement-metrics/retained

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/settlement-metrics/retained
  • Auth: none declared

Query parameters

period'today' | 'week' | 'month' | 'quarter' | 'year' | 'custom'
start_datestring date nullable

First local day of a custom range (period=custom), inclusive

end_datestring date nullable

Last local day of a custom range (period=custom), inclusive

Response

Successful Response

period'today' | 'week' | 'month' | 'quarter' | 'year' | 'custom' required
start_datestring date required
end_datestring date required
previous_start_datestring date required
previous_end_datestring date required
bucket'day' | 'week' | 'month' required
timezonestring required
generated_atstring date-time required
cases_synced_atstring date-time nullable
source_statusstring required
hide_last_monthboolean
totalsinteger required
previous_totalsinteger required
busiest_daystring date nullable
busiest_day_countinteger
previous_busiest_day_countinteger
by_weekdayinteger[]

Changes

  • d8e87bdbfbf2Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      response property progress/items/retained list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

  • cbec4df5dc85Revision changes
    • info

      endpoint added