Get Patient Analytics Grouped
curl --request GET \
--url https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"groups": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"summary": {
"totalPatients": 0,
"totalSpent": 0,
"totalAppointments": 0,
"avgSpent": 0,
"avgTenureDays": 123,
"uniqueServices": 0,
"uniqueProviders": 0
},
"rows": [
{
"patient": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"type": "PATIENT",
"locationId": "<string>",
"dateOfBirth": "2023-12-25",
"onSchedulingBlacklist": true
},
"patientSource": "<string>",
"firstAppointmentDate": "2023-11-07T05:31:56Z",
"lastAppointmentDate": "2023-11-07T05:31:56Z",
"lastAppointmentServices": [
"<string>"
],
"lastAppointmentProviders": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
}
],
"totalSpent": 0,
"appointmentCount": 0
}
]
}
],
"grandTotals": {
"totalPatients": 0,
"totalSpent": 0,
"totalAppointments": 0,
"avgSpent": 0,
"avgTenureDays": 123,
"uniqueServices": 0,
"uniqueProviders": 0
},
"totalCount": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Analytics
Get Patient Analytics Grouped
Get patient analytics data grouped by location, patient_source, or provider.
Returns groups with summary stats and paginated patient rows per group.
GET
/
analytics
/
dashboards
/
patient-breakdown
/
patient-analytics-grouped
Get Patient Analytics Grouped
curl --request GET \
--url https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/analytics/dashboards/patient-breakdown/patient-analytics-grouped")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"groups": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"summary": {
"totalPatients": 0,
"totalSpent": 0,
"totalAppointments": 0,
"avgSpent": 0,
"avgTenureDays": 123,
"uniqueServices": 0,
"uniqueProviders": 0
},
"rows": [
{
"patient": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"type": "PATIENT",
"locationId": "<string>",
"dateOfBirth": "2023-12-25",
"onSchedulingBlacklist": true
},
"patientSource": "<string>",
"firstAppointmentDate": "2023-11-07T05:31:56Z",
"lastAppointmentDate": "2023-11-07T05:31:56Z",
"lastAppointmentServices": [
"<string>"
],
"lastAppointmentProviders": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
}
],
"totalSpent": 0,
"appointmentCount": 0
}
]
}
],
"grandTotals": {
"totalPatients": 0,
"totalSpent": 0,
"totalAppointments": 0,
"avgSpent": 0,
"avgTenureDays": 123,
"uniqueServices": 0,
"uniqueProviders": 0
},
"totalCount": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Query Parameters
Available options:
location, patient_source, provider Available options:
asc, desc Required range:
1 <= x <= 500⌘I
