# Public API – Reports & Analytics

Operations related to patients, appointments, providers and so on.

Version: 185.0.9

## Servers

Sandbox
```
https://test.hs1api.com/ascend-gateway/api
```

Prod
```
https://prod.hs1api.com/ascend-gateway/api
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### oAuthSandbox

OAuth 2.0 client credentials (Sandbox)

Type: oauth2

## Download OpenAPI description

[Public API – Reports & Analytics](https://papidocs.hs1api.com/_bundle/PublicAPI/api-reports-and-analytics.yaml)

## Usage Report (V1)

Usage Report endpoints

### Returns a UsageReportV1 based on the time range and endpoint name.

 - [GET /v1/usagereport](https://papidocs.hs1api.com/publicapi/api-reports-and-analytics/usage-report-(v1)/getusagereportv1.md): Endpoint usage statistics for an optional time window and endpoint name.

Quirk: If you call this on the first calendar day of the month, the API returns no statistics (documented behavior).

Dates: startDate and endDate use YYYY-MM-DD; they must not be equal; endDate cannot precede startDate or
exceed today. endpoint is optional; when omitted, results are broken down by endpoint. Invalid combinations return 400.

## Audits (V1)

Audits endpoints

### Returns a list of audits based on filter criteria

 - [GET /v1/audits](https://papidocs.hs1api.com/publicapi/api-reports-and-analytics/audits-(v1)/getauditsv1.md): Query shape: Prefer a narrow filter—combine scoping filters with lastModified or date bounds where supported. A very wide date range with no other scoping can 408 (timeout) on large tenants; retry with a smaller window or use cursor pagination (lastId with lastModified—see parameter descriptions).

Empty results: 200 with data: [] means no audits matched; it does not indicate invalid filter values.

responseFields: Use only names allowed on this operation (see the responseFields parameter). Use ALL or the documented flat field list.

Pagination: The page query parameter is deprecated where lastId is supported; lastModified / lastId style pagination is preferred.