Pular para o conteúdo

POST /v1/analytics/charges/search

POST
/v1/analytics/charges/search
curl --request POST \
--url https://seu-endereco-da-api/v1/analytics/charges/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "period": "7", "window": "current", "pipelineId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "channelId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "environment": "sandbox" }'

Permissão que a Chave de acesso precisa: Relatórios de vendas (analytics:sales).

Media typeapplication/json
object
period
string
Allowed values: 7 30 90
window
string
Allowed values: current previous
pipelineId
string format: uuid
channelId
string format: uuid
environment
string
Allowed values: sandbox production
Media typeapplication/json
object
window
required
object
firstDay
required
string
lastDay
required
string
seriesBreakAt
required
string
nullable
cards
required
object
emitted
required

Cobrancas criadas na janela

object
count
required
number
cents
required

Centavos

number
previousCount
required

Mesma medida na janela imediatamente anterior

number
previousCents
required

Centavos na janela imediatamente anterior

number
received
required

Cobrancas pagas na janela (Charge.paidAt)

object
count
required
number
cents
required

Centavos

number
previousCount
required

Mesma medida na janela imediatamente anterior

number
previousCents
required

Centavos na janela imediatamente anterior

number
open
required

Criadas na janela e ainda pendentes

object
count
required
number
cents
required

Centavos

number
previousCount
required

Mesma medida na janela imediatamente anterior

number
previousCents
required

Centavos na janela imediatamente anterior

number
overdue
required

Criadas na janela e hoje vencidas

object
count
required
number
cents
required

Centavos

number
previousCount
required

Mesma medida na janela imediatamente anterior

number
previousCents
required

Centavos na janela imediatamente anterior

number
refunded
required

Estornadas ou contestadas na janela (Charge.refundedAt)

object
count
required
number
cents
required

Centavos

number
previousCount
required

Mesma medida na janela imediatamente anterior

number
previousCents
required

Centavos na janela imediatamente anterior

number
paymentRate
required

Percentual das cobrancas criadas na janela que foram pagas

number
previousPaymentRate
required
number
averageMinutesToPay
required

Media de minutos entre o primeiro envio (ou a criacao) e o pagamento

number
nullable
byOrigin
required
Array<object>
object
key
required

Origem, id do atendente, id do fluxo ou forma de pagamento; null quando nao informado

string
nullable
label
required
string
emittedCount
required
number
emittedCents
required

Centavos

number
receivedCount
required

Das emitidas na janela, quantas foram pagas

number
receivedCents
required

Centavos

number
byAttendant
required
Array<object>
object
key
required

Origem, id do atendente, id do fluxo ou forma de pagamento; null quando nao informado

string
nullable
label
required
string
emittedCount
required
number
emittedCents
required

Centavos

number
receivedCount
required

Das emitidas na janela, quantas foram pagas

number
receivedCents
required

Centavos

number
byFlow
required
Array<object>
object
key
required

Origem, id do atendente, id do fluxo ou forma de pagamento; null quando nao informado

string
nullable
label
required
string
emittedCount
required
number
emittedCents
required

Centavos

number
receivedCount
required

Das emitidas na janela, quantas foram pagas

number
receivedCents
required

Centavos

number
byMethod
required

So cobrancas pagas: a forma de pagamento so existe depois do pagamento

Array<object>
object
key
required

Origem, id do atendente, id do fluxo ou forma de pagamento; null quando nao informado

string
nullable
label
required
string
emittedCount
required
number
emittedCents
required

Centavos

number
receivedCount
required

Das emitidas na janela, quantas foram pagas

number
receivedCents
required

Centavos

number
recovery
required
object
overdue
required

Cobrancas que venceram na janela

object
count
required
number
cents
required

Centavos

number
recovered
required

Das que venceram, as pagas depois do vencimento

object
count
required
number
cents
required

Centavos

number
recoveredAfterReminder
required

Das recuperadas, as pagas depois de um lembrete ou reenvio

object
count
required
number
cents
required

Centavos

number
recoveryRate
required

Percentual das vencidas que foram pagas

number
series
required
Array<object>
object
label
required
string
emittedCents
required

Centavos

number
receivedCents
required

Centavos

number

Example generated

{
"window": {
"firstDay": "example",
"lastDay": "example"
},
"seriesBreakAt": "example",
"cards": {
"emitted": {
"count": 1,
"cents": 1,
"previousCount": 1,
"previousCents": 1
},
"received": {
"count": 1,
"cents": 1,
"previousCount": 1,
"previousCents": 1
},
"open": {
"count": 1,
"cents": 1,
"previousCount": 1,
"previousCents": 1
},
"overdue": {
"count": 1,
"cents": 1,
"previousCount": 1,
"previousCents": 1
},
"refunded": {
"count": 1,
"cents": 1,
"previousCount": 1,
"previousCents": 1
}
},
"paymentRate": 1,
"previousPaymentRate": 1,
"averageMinutesToPay": 1,
"byOrigin": [
{
"key": "example",
"label": "example",
"emittedCount": 1,
"emittedCents": 1,
"receivedCount": 1,
"receivedCents": 1
}
],
"byAttendant": [
{
"key": "example",
"label": "example",
"emittedCount": 1,
"emittedCents": 1,
"receivedCount": 1,
"receivedCents": 1
}
],
"byFlow": [
{
"key": "example",
"label": "example",
"emittedCount": 1,
"emittedCents": 1,
"receivedCount": 1,
"receivedCents": 1
}
],
"byMethod": [
{
"key": "example",
"label": "example",
"emittedCount": 1,
"emittedCents": 1,
"receivedCount": 1,
"receivedCents": 1
}
],
"recovery": {
"overdue": {
"count": 1,
"cents": 1
},
"recovered": {
"count": 1,
"cents": 1
},
"recoveredAfterReminder": {
"count": 1,
"cents": 1
},
"recoveryRate": 1
},
"series": [
{
"label": "example",
"emittedCents": 1,
"receivedCents": 1
}
]
}