> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peerlogic.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Analytics scope and time ranges

> Scope Peerlogic analytics to organizations, regions, or practices and apply consistent reporting periods.

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:

| Parameter | Purpose |
| - | - |
| `organization_id` | Include accessible practices in one organization. |
| `region_id` | Include accessible practices assigned to one region. |
| `practice_ids` | Include one or more accessible practices. Separate multiple IDs with commas. |

Use [Organization, practice, and resource IDs](/concepts/organizations-and-practices) to understand how IDs and access scope work, then use the [access-scope endpoint](/peerlogic-api-reference/organizations-and-practices/list-accessible-organizations-and-practices) to discover valid identifiers for the authenticated account.

```bash theme={null}
curl "https://api.prod.peerlogic.com/api/calls/aggregates/call-counts/?region_id=REGION_ID&call_start_time_after=2026-08-01&call_start_time_before=2026-09-01&include_calls_overall=true" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

<Note>
  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.
</Note>

## 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:

```text theme={null}
?non_practice_participant_type=new_patient&non_practice_participant_type=existing_patient
```

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.


## Related topics

- [List call analytics filter options](/peerlogic-api-reference/call-insights/list-call-analytics-filter-options.md)
- [Get opportunities by practice](/peerlogic-api-reference/call-insights/get-opportunities-by-practice.md)
- [List call filter options](/peerlogic-api-reference/call-insights/list-call-filter-options.md)
- [Get call counts by practice](/peerlogic-api-reference/call-insights/get-call-counts-by-practice.md)
- [Get call performance metrics](/peerlogic-api-reference/call-insights/get-call-performance-metrics.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.