> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Consultar relatório de risco > Devolve os indicadores de risco da empresa autenticada no período: taxa de chargeback contra o limite seguro das bandeiras, valor em disputa, taxa de vitória, bloqueios do antifraude e distribuição por faixa de risco. Use para agir antes de a bandeira agir por você. ## OpenAPI ````yaml /openapi.yaml get /v1/reports/risk openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/reports/risk: get: tags: - Crescimento summary: Consultar relatório de risco description: >- Devolve os indicadores de risco da empresa autenticada no período: taxa de chargeback contra o limite seguro das bandeiras, valor em disputa, taxa de vitória, bloqueios do antifraude e distribuição por faixa de risco. Use para agir antes de a bandeira agir por você. operationId: getRiskReport parameters: - schema: type: string format: date-time in: query name: from required: false description: Início do período, em ISO 8601. Sem período, vale a janela padrão. - schema: type: string format: date-time in: query name: to required: false description: Fim do período, em ISO 8601. responses: '200': description: Relatório de risco do período. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: chargebackRate: type: object properties: rate: type: number description: Taxa de chargeback no período, em percentual. belowLimit: type: boolean description: >- Se a taxa está abaixo do limite seguro das bandeiras. safeLimit: type: number description: Limite seguro de chargeback, em percentual. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - rate - belowLimit - safeLimit - changeVsPreviousPeriod additionalProperties: false description: Taxa de chargeback. disputeValue: type: object properties: totalAmount: type: number description: Valor em disputa, em centavos. activeDisputes: type: number description: Disputas abertas. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - totalAmount - activeDisputes - changeVsPreviousPeriod additionalProperties: false description: Dinheiro parado em disputa. pendingDisputes: type: object properties: total: type: number description: Disputas aguardando resposta. averageDays: type: number description: Dias médios de espera. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - total - averageDays - changeVsPreviousPeriod additionalProperties: false description: Disputas pendentes. winRate: type: object properties: rate: type: number description: Percentual de disputas vencidas. won: type: number description: Disputas vencidas. total: type: number description: Disputas julgadas. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - rate - won - total - changeVsPreviousPeriod additionalProperties: false description: Taxa de vitória em disputas. monthlyChargebackRate: type: object properties: criticalLimit: type: number description: Limite crítico de chargeback, em percentual. points: type: array items: type: object properties: date: type: string description: Mês do ponto, em ISO 8601. rate: type: number description: Taxa de chargeback no mês, em percentual. required: - date - rate additionalProperties: false description: Série mensal da taxa de chargeback. required: - criticalLimit - points additionalProperties: false description: Chargeback mês a mês. chargebackByProduct: type: object properties: products: type: array items: type: object properties: productName: type: string description: Produto. chargebacks: type: number description: Chargebacks do produto. amount: type: number description: Valor em chargeback, em centavos. percentageOfTotal: type: number description: Fatia do total de chargebacks. required: - productName - chargebacks - amount - percentageOfTotal additionalProperties: false description: Chargebacks por produto. required: - products additionalProperties: false description: Quais produtos concentram chargeback. disputeResults: type: object properties: winRate: type: number description: Taxa de vitória da série, em percentual. points: type: array items: type: object properties: date: type: string description: Data do ponto, em ISO 8601. won: type: number description: Disputas vencidas no ponto. lost: type: number description: Disputas perdidas no ponto. required: - date - won - lost additionalProperties: false description: Série de resultados de disputa. required: - winRate - points additionalProperties: false description: Resultado das disputas ao longo do tempo. fraudCategories: type: object properties: categories: type: array items: type: object properties: category: type: string description: Categoria de fraude. count: type: number description: Ocorrências na categoria. required: - category - count additionalProperties: false description: Categorias de fraude. required: - categories additionalProperties: false description: Como a fraude se distribui. antifraudBlocks: type: object properties: total: type: number description: Transações bloqueadas pelo antifraude. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - total - changeVsPreviousPeriod additionalProperties: false description: Bloqueios do antifraude. blockReasonCategories: type: object properties: categories: type: array items: type: object properties: category: type: string description: Código da categoria de bloqueio. label: type: string description: Nome legível da categoria. count: type: number description: Bloqueios na categoria. percentage: type: number description: Fatia dos bloqueios. required: - category - label - count - percentage additionalProperties: false description: Motivos de bloqueio. required: - categories additionalProperties: false description: Por que o antifraude bloqueou. riskScoreDistribution: type: object properties: low: type: object properties: count: type: number description: Transações na faixa de risco. percentage: type: number description: Fatia das transações na faixa. required: - count - percentage additionalProperties: false description: Faixa de risco baixo. medium: type: object properties: count: type: number description: Transações na faixa de risco. percentage: type: number description: Fatia das transações na faixa. required: - count - percentage additionalProperties: false description: Faixa de risco médio. high: type: object properties: count: type: number description: Transações na faixa de risco. percentage: type: number description: Fatia das transações na faixa. required: - count - percentage additionalProperties: false description: Faixa de risco alto. required: - low - medium - high additionalProperties: false description: Distribuição das transações por faixa de risco. antifraudBlocksByBrand: type: object properties: brands: type: array items: type: object properties: brand: type: string description: Bandeira do cartão. blockedCount: type: number description: Transações bloqueadas na bandeira. blockRate: type: number description: Taxa de bloqueio na bandeira, em percentual. required: - brand - blockedCount - blockRate additionalProperties: false description: Bloqueios por bandeira. required: - brands additionalProperties: false description: Onde o antifraude mais barra. disputesByStatus: type: object properties: statuses: type: array items: type: object properties: status: type: string enum: - analyzing - documentation_sent - waiting_bank - won description: Estágio da disputa. label: type: string description: Nome legível do estágio. count: type: number description: Disputas no estágio. required: - status - label - count additionalProperties: false description: Disputas por estágio. required: - statuses additionalProperties: false description: Em que pé estão as disputas. required: - chargebackRate - disputeValue - pendingDisputes - winRate - monthlyChargebackRate - chargebackByProduct - disputeResults - fraudCategories - antifraudBlocks - blockReasonCategories - riskScoreDistribution - antifraudBlocksByBrand - disputesByStatus additionalProperties: false required: - success - data additionalProperties: false description: Relatório de risco do período. example: success: true data: chargebackRate: rate: 0.42 belowLimit: true safeLimit: 1 changeVsPreviousPeriod: -0.08 disputeValue: totalAmount: 149700 activeDisputes: 3 changeVsPreviousPeriod: -1 pendingDisputes: total: 2 averageDays: 6.5 changeVsPreviousPeriod: 0 winRate: rate: 66.7 won: 2 total: 3 changeVsPreviousPeriod: 16.7 monthlyChargebackRate: criticalLimit: 1 points: - date: '2026-09-01T00:00:00.000Z' rate: 0.42 chargebackByProduct: products: - productName: Curso de Tráfego Pago chargebacks: 2 amount: 99800 percentageOfTotal: 66.7 disputeResults: winRate: 66.7 points: - date: '2026-09-01T00:00:00.000Z' won: 2 lost: 1 fraudCategories: categories: - category: Cartão não reconhecido count: 2 antifraudBlocks: total: 14 changeVsPreviousPeriod: -3 blockReasonCategories: categories: - category: HIGH_RISK_SCORE label: Score de risco alto count: 9 percentage: 64.3 riskScoreDistribution: low: count: 182 percentage: 84.1 medium: count: 25 percentage: 11.6 high: count: 7 percentage: 3.2 antifraudBlocksByBrand: brands: - brand: visa blockedCount: 8 blockRate: 5.4 disputesByStatus: statuses: - status: analyzing label: Em análise count: 2 '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````