# Consultar métricas (/docs/conta-digital/endpoints/account/get_metrics)

## GET /transactions/metrics

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

Escopo: `STATEMENT_READ`. Devolve os números da conta no período: cobranças, conversão, estornos, contestações, saques e depósitos.

### Query params

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `dateFrom` | string | no | Início do período. Sem `dateFrom` e `dateTo`, valem os últimos 30 dias. |
| `dateTo` | string | no | Fim do período. ISO 8601 ou `AAAA-MM-DD`. |

### Responses

**200** Métricas do período.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `period` | object | yes | Período efetivamente usado. |
| `period.from` | string | yes | Primeiro instante contado. — format: date-time |
| `period.to` | string | yes | Último instante contado. — format: date-time |
| `rails` | object[] | yes | Um item por meio de pagamento da conta. As cobranças contam pela data de criação. |
| `withdrawals` | object | yes | Saques do período que não falharam. |
| `withdrawals.count` | integer | yes | Quantidade. |
| `withdrawals.amount` | integer | yes | Total debitado, com a tarifa. Em centavos. |
| `deposits` | object | yes | Pix recebidos sem cobrança, pela data em que caíram. |
| `deposits.count` | integer | yes | Quantidade. |
| `deposits.amount` | integer | yes | Valor bruto. Em centavos. |
| `deposits.netAmount` | integer | yes | Valor creditado. Em centavos. |
| `pixInflow` | object | null | yes | Tudo o que entrou por Pix: cobranças pagas e depósitos. `null` quando a conta não tem Pix. |
| `pixInflow.count` | integer | yes | Quantidade. |
| `pixInflow.amount` | integer | yes | Valor bruto. Em centavos. |

**400** Requisição inválida.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**401** Credencial ausente, inválida ou expirada.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**403** Sem permissão: escopo, IP ou operação desabilitada.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |