provider
analytics
analytics

Get Notes Breakdown Summary

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

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

Query parameters

timezonestring required

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

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

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.