Pular para o conteúdo principal
GET
/
v1
/
reports
/
contexts
/
{contextId}
/
dashboard
/
volume
Obter estatísticas de volume
curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/volume \
  --header 'Authorization: Bearer <token>'
{
  "matchedAmount": "<string>",
  "matchedTransactions": 123,
  "periodEnd": "<string>",
  "periodStart": "<string>",
  "totalAmount": "<string>",
  "totalTransactions": 123,
  "unmatchedAmount": "<string>",
  "unmatchedCount": 123
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer token authentication (format: "Bearer {token}")

Cabeçalhos

​
X-Request-Id
string

Um identificador único para rastrear a requisição entre serviços.

Parâmetros de caminho

​
contextId
string
obrigatório

O identificador único do contexto de conciliação.

Parâmetros de consulta

​
date_from
string
obrigatório

Data inicial (YYYY-MM-DD)

​
date_to
string
obrigatório

Data final (YYYY-MM-DD)

​
source_id
string

Filtro de ID da fonte

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

​
matchedAmount
string
​
matchedTransactions
integer
​
periodEnd
string
​
periodStart
string
​
totalAmount
string
​
totalTransactions
integer
​
unmatchedAmount
string
​
unmatchedCount
integer