Get Notes Breakdown Summary

Get summary statistics for ungrouped notes breakdown (all filtered results).

get/analytics/dashboards/notes-breakdown/notes-breakdown-summary

Request

Base URL
https://docs.decodahealth.com (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: TENANT, API-KEY
TypeScript
https://skmtc.dev/decodahealth/apis/decoda-api/docs/analytics/dashboards/notes-breakdown/notes-breakdown-summary/get.ts
A function with typed inputs. Its response is checked against the schema.

timezonestring required

Timezone for date grouping (e.g., 'America/New_York', 'UTC')

start_datestring nullable

end_datestring nullable

location_idsstring[] nullable

location_namesstring[] nullable

provider_idsstring[] nullable

provider_namesstring[] nullable

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Successful Response

groupKeystring required

The group key this summary belongs to

totalNotesinteger required

Total number of notes in this group

providerCountinteger required

Number of providers in this group

uniquePatientsinteger required

Number of unique patients

uniqueLocationsinteger required

Number of unique locations

earliestFirstNoteDatestring date-time nullable

Earliest first note date across all providers

latestLastNoteDatestring date-time nullable

Latest last note date across all providers

No recorded changes to this operation across all 2 revisions of this API.