Skip to main content
Analytics endpoints summarize calls and opportunities across a selected set of practices. Most analytics requests require a resource scope and accept a reporting period.

​
Select a resource scope

Use one of these parameters to select the practices included in a report: Use Organization, practice, and resource IDs to understand how IDs and access scope work, then use the access-scope endpoint to discover valid identifiers for the authenticated account.
Use a single scope parameter unless an endpoint explicitly documents another behavior. A request fails when its scope contains a resource your account cannot access.

​
Set the reporting period

Most analytics endpoints accept:
  • call_start_time_after: Start date in YYYY-MM-DD format. The start date is included.
  • call_start_time_before: End date in YYYY-MM-DD format. The end date is excluded.
For example, use 2026-08-01 through 2026-09-01 to report on August. Always provide both dates when you need a repeatable reporting period. When an endpoint permits omitted dates, the default period is shown on that endpoint’s reference page.

​
Filter by participant type

Some endpoints accept non_practice_participant_type to filter calls by the other participant. Repeat the parameter to include multiple types:
Supported values include new_patient, existing_patient, contractor_vendor, insurance_provider, not_applicable, not_applicable_internal, and others.

​
Understand endpoint-specific filters

Not every analytics endpoint supports hierarchy scope:
  • Industry benchmarks aggregate eligible industry data and accept industry_type instead of organization, region, or practice scope.
  • Top mentions compare either one practice or an industry benchmark. Supply practice__id, or set industry_average=true, but not both.
  • Time-series endpoints can expose a granularity parameter.
  • By-practice endpoints are paginated and may also support CSV responses.
Use only the parameters listed for an endpoint. An unsupported query parameter may be ignored.