> ## 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 performance > Devolve a performance do programa de afiliados da empresa autenticada no período: receita e comissão, afiliados ativos, os cinco que mais venderam, desempenho por produto e o quanto a receita se concentra nos três maiores. Use para decidir onde investir em parceria. ## OpenAPI ````yaml /openapi.yaml get /v1/reports/performance 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/performance: get: tags: - Crescimento summary: Consultar relatório de performance description: >- Devolve a performance do programa de afiliados da empresa autenticada no período: receita e comissão, afiliados ativos, os cinco que mais venderam, desempenho por produto e o quanto a receita se concentra nos três maiores. Use para decidir onde investir em parceria. operationId: getPerformanceReport 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 performance 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: affiliateRevenue: type: object properties: total: type: number description: >- Receita trazida por afiliados no período, em centavos. salesCount: type: number description: Vendas trazidas por afiliados. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - total - salesCount - changeVsPreviousPeriod additionalProperties: false description: Receita via afiliados. paidCommissions: type: object properties: total: type: number description: Comissões pagas a afiliados, em centavos. percentageOfRevenue: type: number description: Fatia da receita de afiliados que virou comissão. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - total - percentageOfRevenue - changeVsPreviousPeriod additionalProperties: false description: Comissões pagas. activeAffiliates: type: object properties: count: type: number description: Afiliados com venda no período. newThisMonth: type: number description: Afiliados que começaram a vender neste mês. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - count - newThisMonth - changeVsPreviousPeriod additionalProperties: false description: Afiliados ativos. averageTicket: type: object properties: value: type: number description: Ticket médio das vendas de afiliados, em centavos. aboveAverage: type: boolean description: Se o ticket de afiliados supera o ticket geral. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - value - aboveAverage - changeVsPreviousPeriod additionalProperties: false description: Ticket médio via afiliados. top5Affiliates: type: array items: type: object properties: name: type: string description: Nome do afiliado. initials: type: string description: Iniciais do afiliado, para avatar. sales: type: number description: Vendas do afiliado. approvalRate: type: number description: >- Taxa de aprovação das vendas do afiliado, em percentual. revenue: type: number description: Receita trazida pelo afiliado, em centavos. commission: type: number description: Comissão do afiliado, em centavos. required: - name - initials - sales - approvalRate - revenue - commission additionalProperties: false description: Os cinco afiliados que mais venderam. revenueAndCommission: type: object properties: changeOverPeriod: type: number description: Variação da receita do início ao fim do período. points: type: array items: type: object properties: date: type: string description: Data do ponto, em ISO 8601. revenue: type: number description: Receita no ponto, em centavos. commission: type: number description: Comissão no ponto, em centavos. required: - date - revenue - commission additionalProperties: false description: Série de receita e comissão. required: - changeOverPeriod - points additionalProperties: false description: Receita contra comissão ao longo do período. averageTicketByAffiliate: type: array items: type: object properties: name: type: string description: Nome do afiliado. averageTicket: type: number description: Ticket médio do afiliado, em centavos. required: - name - averageTicket additionalProperties: false description: Ticket médio por afiliado. performanceByProduct: type: array items: type: object properties: name: type: string description: Produto. sales: type: number description: Vendas do produto via afiliados. revenue: type: number description: Receita do produto via afiliados, em centavos. commission: type: number description: Comissão paga no produto, em centavos. newSales: type: number description: Vendas para clientes novos. recurringSales: type: number description: Vendas para clientes recorrentes. newRevenue: type: number description: Receita de clientes novos, em centavos. recurringRevenue: type: number description: Receita de clientes recorrentes, em centavos. required: - name - sales - revenue - commission - newSales - recurringSales - newRevenue - recurringRevenue additionalProperties: false description: Performance por produto. roiProgram: type: object properties: multiplier: type: number description: Quantas vezes a receita cobre a comissão paga. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - multiplier - changeVsPreviousPeriod additionalProperties: false description: Retorno do programa de afiliados. concentrationTop3: type: object properties: percentage: type: number description: >- Fatia da receita concentrada nos três maiores afiliados. revenue: type: number description: Receita dos três maiores afiliados, em centavos. required: - percentage - revenue additionalProperties: false description: Concentração nos três maiores afiliados. required: - affiliateRevenue - paidCommissions - activeAffiliates - averageTicket - top5Affiliates - revenueAndCommission - averageTicketByAffiliate - performanceByProduct - roiProgram - concentrationTop3 additionalProperties: false required: - success - data additionalProperties: false description: Relatório de performance do período. example: success: true data: affiliateRevenue: total: 1846300 salesCount: 37 changeVsPreviousPeriod: 18.4 paidCommissions: total: 738520 percentageOfRevenue: 40 changeVsPreviousPeriod: 18.4 activeAffiliates: count: 4 newThisMonth: 1 changeVsPreviousPeriod: 1 averageTicket: value: 49900 aboveAverage: true changeVsPreviousPeriod: 0 top5Affiliates: - name: Marketing Digital Ltda initials: MD sales: 21 approvalRate: 64.2 revenue: 1047900 commission: 419160 revenueAndCommission: changeOverPeriod: 18.4 points: - date: '2026-09-11T00:00:00.000Z' revenue: 149700 commission: 59880 averageTicketByAffiliate: - name: Marketing Digital Ltda averageTicket: 49900 performanceByProduct: - name: Curso de Tráfego Pago sales: 37 revenue: 1846300 commission: 738520 newSales: 31 recurringSales: 6 newRevenue: 1546900 recurringRevenue: 299400 roiProgram: multiplier: 2.5 changeVsPreviousPeriod: 0.2 concentrationTop3: percentage: 81.4 revenue: 1502900 '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 ````