Oct 06, 2023 - Novas queries na Analytics API! ✅
Estamos felizes em anunciar os novos cálculos disponíveis para consulta na Analytics API , que trazem métricas para análise da performance dos pagamentos da sua loja, como a taxa de aprovação, o total financeiro e o volume de cobranças por status, método, provedor e motivos de perda.
Criamos três grupos de queries para facilitar a consulta através do Playground GraphQL e da API: Charges, Authorization Rate e Dashboard. Confira:
➡️ Charges - informações sobre as cobranças
No grupo Charges, disponibilizamos diversas queries com informações sobre as cobranças:
-
allCharges - Retorna todas as cobranças
-
charge - Retorna informações de uma cobrança pelo seu identificador único
-
chargesByDeclinedCode - Retorna as cobranças com status failed pelo declined code
-
totalCharges - Retorna o número de cobranças e o total financeiro de um período, provedor ou método de pagamento
➡️ Authorization Rate - informações sobre a taxa de aprovação
No grupo Authorization Rate disponibilizamos as informações de taxa de autorização, que corresponde ao percentual de cobranças aprovadas em relação ao total de cobranças processadas (somando pré-autorizadas, autorizadas e com falha). Confira as queries disponibilizadas:
-
totalAuthorizationRate - Retorna o percentual total de cobranças aprovadas
-
byInterval - Retorna o percentual de cobranças aprovadas (preauthorized / authorized) no intervalo selecionado
-
byProviderType - Retorna o percentual de cobranças aprovadas por provedor
-
byPaymentMethod - Retorna o percentual de cobranças aprovadas por método de pagamento
➡️ Dashboard - informações adicionais
O grupo de consultas Dashboard disponibiliza informações para o Painel de Dados da Malga, que também estão disponíveis para consulta pela Analytics API:
-
providersResume - Retorna a taxa de autorização, o total financeiro e volume de cobranças por provedor de pagamento
-
chargeCurrencies - Retorna as moedas em que a empresa processa pagamentos
Além dos novos grupos e consultas, disponibilizamos a listagem de valores para os argumentos: paymentMethod
, providerType
e status
;
Realizando uma request na Analytics API
Para acessar os dados, insira as suas credenciais de produção Malga (Api-Key
e client-Id
) no Headers do Playground, conforme a documentação;
Com a criação dos grupos de queries, agora é necessário enviar o nome do grupo (ex. Charges) na requisição, junto com o nome da query.
Link de acesso ao Playground Analytics API
Se tiver alguma dúvida em seu acesso ou na utilização da API, avise o nosso time de atendimento.
Até mais! 🚀
Was this page helpful?