Skip to main content
GET
/
analytics
/
dashboards
/
notes-breakdown
/
notes-breakdown-group-summaries
Get Notes Breakdown Group Summaries
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/notes-breakdown/notes-breakdown-group-summaries \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "groupKey": "<string>",
    "totalNotes": 123,
    "providerCount": 123,
    "uniquePatients": 123,
    "uniqueLocations": 123,
    "earliestFirstNoteDate": "2023-11-07T05:31:56Z",
    "latestLastNoteDate": "2023-11-07T05:31:56Z"
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
group_by
enum<string>
required
Available options:
location,
created_date,
week,
month
​
timezone
string
required

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

​
start_date
string | null
​
end_date
string | null
​
location_ids
string[] | null
​
location_names
string[] | null
​
provider_ids
string[] | null
​
provider_names
string[] | null

Response

Successful Response

​
groupKey
string
required

The group key this summary belongs to

​
totalNotes
integer
required

Total number of notes in this group

​
providerCount
integer
required

Number of providers in this group

​
uniquePatients
integer
required

Number of unique patients

​
uniqueLocations
integer
required

Number of unique locations

​
earliestFirstNoteDate
string<date-time> | null

Earliest first note date across all providers

​
latestLastNoteDate
string<date-time> | null

Latest last note date across all providers