Sign in
Settlement Metrics

Settlement Dashboard

Changed on

The TV's figures for the web app, over a preset or custom range in the reporting timezone.

get/settlement-metrics/dashboard

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/dashboard
  • 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
source_synced_atstring date-time nullable
source_statusstring required
major_thresholdnumber required
hide_last_monthboolean

Changes

  • 912982f625cdRevision changes
    • warning

      added the new quarter enum value to the response property for the response status

    • warning

      added the new year enum value to the response property for the response status

    • info

      added the new enum value quarter to the query request parameter period

    • info

      added the new enum value year to the query request parameter period

  • 7296f576bb94Revision changes
    • info

      added the optional property to the response with the status