Skip to main content
GET
/
integrations
/
v2
/
resource-records
/
{integration_id}
/
patients
/
statistics
Get Patients Dashboard
curl --request GET \
  --url https://api-qa.interactly.ai/integrations/v2/resource-records/{integration_id}/patients/statistics \
  --header 'Authorization: Bearer <token>'
{
  "overview": {
    "total": 0
  },
  "trends": [
    {
      "_id": "2023-11-07T05:31:56Z",
      "successful": 0,
      "failed": 0
    }
  ],
  "source": [
    {
      "_id": "<string>",
      "count": 0
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

​
integration_id
string
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Query Parameters

​
debug
boolean
default:false

Enable debug mode to include additional logging for troubleshooting

​
size
integer
default:300

Number of items per page

Required range: x >= 1
​
page
integer
default:1

Page number

Required range: x >= 1
​
search
string | null

Search keywords

​
start
string<date-time> | null

Filter by start time (ISO 8601 format)

​
end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Successful Response

Response model for patients dashboard data. Contains overview, trends, and source information for patients.

​
overview
Patients Overview · object
required

Overview of total patients in the date range

​
trends
StatsTrend · object[]

List of patient trends broken down by date, showing successful and failed counts

​
source
StatsSource · object[]

List of patient sources with counts, showing where patients originated