Skip to main content
GET
/
analytics
/
dashboards
/
notes-breakdown
/
notes-breakdown
Get Notes Breakdown
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/notes-breakdown/notes-breakdown \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "providerName": "<string>",
      "providerId": "<string>",
      "totalNotes": 123,
      "uniquePatients": 123,
      "uniqueLocations": 123,
      "firstNoteDate": "2023-11-07T05:31:56Z",
      "lastNoteDate": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

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> | null
Available options:
location,
created_date,
week,
month
group_key
string | null
timezone
string
required

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

sort_by
string
default:total_notes
sort_direction
enum<string>
default:desc
Available options:
asc,
desc
start_date
string | null
end_date
string | null
location_ids
string[] | null
location_names
string[] | null
provider_ids
string[] | null
provider_names
string[] | null
location
string | null
created_date
string | null
week
string | null
month
string | null
page
integer | null
per_page
integer | null

Response

Successful Response

data
NotesBreakdownItem · object[]
required
total
integer
required