POST /v1/analytics/charges/search
const url = 'https://seu-endereco-da-api/v1/analytics/charges/search';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"period":"7","window":"current","pipelineId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","channelId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","environment":"sandbox"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”object
Responses
Seção intitulada “Responses”object
object
object
Cobrancas criadas na janela
object
Centavos
Mesma medida na janela imediatamente anterior
Centavos na janela imediatamente anterior
Cobrancas pagas na janela (Charge.paidAt)
object
Centavos
Mesma medida na janela imediatamente anterior
Centavos na janela imediatamente anterior
Criadas na janela e ainda pendentes
object
Centavos
Mesma medida na janela imediatamente anterior
Centavos na janela imediatamente anterior
Criadas na janela e hoje vencidas
object
Centavos
Mesma medida na janela imediatamente anterior
Centavos na janela imediatamente anterior
Estornadas ou contestadas na janela (Charge.refundedAt)
object
Centavos
Mesma medida na janela imediatamente anterior
Centavos na janela imediatamente anterior
Percentual das cobrancas criadas na janela que foram pagas
Media de minutos entre o primeiro envio (ou a criacao) e o pagamento
object
Origem, id do atendente, id do fluxo ou forma de pagamento; null quando nao informado
Centavos
Das emitidas na janela, quantas foram pagas
Centavos
object
Origem, id do atendente, id do fluxo ou forma de pagamento; null quando nao informado
Centavos
Das emitidas na janela, quantas foram pagas
Centavos
object
Origem, id do atendente, id do fluxo ou forma de pagamento; null quando nao informado
Centavos
Das emitidas na janela, quantas foram pagas
Centavos
So cobrancas pagas: a forma de pagamento so existe depois do pagamento
object
Origem, id do atendente, id do fluxo ou forma de pagamento; null quando nao informado
Centavos
Das emitidas na janela, quantas foram pagas
Centavos
object
Cobrancas que venceram na janela
object
Centavos
Das que venceram, as pagas depois do vencimento
object
Centavos
Das recuperadas, as pagas depois de um lembrete ou reenvio
object
Centavos
Percentual das vencidas que foram pagas
object
Centavos
Centavos
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 } ]}