# Retrieve the users report

`GET https://api.cademi.com.br/api/v3/reports/users`

Operation ID: `reports.users.get` · API v3

Returns summary figures and a time series of user registrations and activity.

`from` and `to` are optional and default to the last 90 days. `from` must not be later than `to`, and the range cannot exceed 90 days.

Figures are aggregated periodically rather than in real time. The `consistency` object indicates the data source and how fresh the figures are.

Required permissions: `reports.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `from` | query | string (date) | no |  |
| `to` | query | string (date) | no |  |

## Responses

### 200

Returns the users report.

Body: `data`: object.

Fields of object:

| Field | Type | Required | Description |
|---|---|---|---|
| `consistency` | object | yes |  |
| `series` | array of object | yes |  |
| `summary` | object | yes |  |
| `window` | object | yes |  |

### 400

The request contains an unsupported query parameter.

Body: Error.

### 401

The credential is missing, malformed, expired, or revoked.

Body: Error.

### 403

The current credentials do not have the permission required by this operation.

Body: Error.

### 422

The request body or query parameters failed validation.

Body: ValidationFailed.

Full schema: https://cademi.dev/openapi/v3.json