# 查询指标 (/zh/docs/conta-digital/endpoints/account/get_metrics)

## GET /transactions/metrics

`GET https://api.hub.payzu.com.br/api/v1/transactions/metrics`

Scope: `STATEMENT_READ`. Returns the account figures for the period: charges, conversion, refunds, disputes, withdrawals and deposits.

### Query params

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `dateFrom` | string | no | Start of the period. Without `dateFrom` and `dateTo`, the last 30 days are used. |
| `dateTo` | string | no | End of the period. ISO 8601 or `YYYY-MM-DD`. |

### Responses

**200** Period metrics.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `period` | object | yes | Period actually used. |
| `period.from` | string | yes | First instant counted. — format: date-time |
| `period.to` | string | yes | Last instant counted. — format: date-time |
| `rails` | object[] | yes | One item per payment method of the account. Charges count by creation date. |
| `withdrawals` | object | yes | Withdrawals of the period that did not fail. |
| `withdrawals.count` | integer | yes | Count. |
| `withdrawals.amount` | integer | yes | Total debited, including the fee. In cents. |
| `deposits` | object | yes | Pix received without a charge, by arrival date. |
| `deposits.count` | integer | yes | Count. |
| `deposits.amount` | integer | yes | Gross amount. In cents. |
| `deposits.netAmount` | integer | yes | Amount credited. In cents. |
| `pixInflow` | object | null | yes | Everything that came in by Pix: paid charges and deposits. `null` when the account has no Pix. |
| `pixInflow.count` | integer | yes | Count. |
| `pixInflow.amount` | integer | yes | Gross amount. In cents. |

**400** Invalid request.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Description in Portuguese, ready to display. It may change at any time. |
| `code` | string | yes | Stable error code. Your system decides what to do based on it. |
| `details` | object | no | Structured error context, when available. |

**401** Missing, invalid or expired credential.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Description in Portuguese, ready to display. It may change at any time. |
| `code` | string | yes | Stable error code. Your system decides what to do based on it. |
| `details` | object | no | Structured error context, when available. |

**403** Not allowed: scope, IP or disabled operation.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Description in Portuguese, ready to display. It may change at any time. |
| `code` | string | yes | Stable error code. Your system decides what to do based on it. |
| `details` | object | no | Structured error context, when available. |