> ## 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 vendas de afiliação > Devolve o que os afiliados dos produtos da empresa autenticada venderam no período: totais de venda e comissão e uma linha por afiliado. Use para fechar o pagamento de comissões do mês ou para descobrir quais parceiros realmente movem o produto. ## OpenAPI ````yaml /openapi.yaml get /v1/affiliations/sales-report 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/affiliations/sales-report: get: tags: - Crescimento summary: Consultar relatório de vendas de afiliação description: >- Devolve o que os afiliados dos produtos da empresa autenticada venderam no período: totais de venda e comissão e uma linha por afiliado. Use para fechar o pagamento de comissões do mês ou para descobrir quais parceiros realmente movem o produto. operationId: getAffiliationSalesReport parameters: - schema: type: string format: date-time in: query name: from required: false description: >- Início do período, em ISO 8601. Sem ele, o relatório não recorta início. - schema: type: string format: date-time in: query name: to required: false description: Fim do período, em ISO 8601. - schema: type: string minLength: 1 in: query name: productId required: false description: Restringe o relatório a um produto da empresa. - schema: type: integer exclusiveMinimum: true minimum: 0 in: query name: offerId required: false description: Restringe o relatório a uma oferta. - schema: type: string enum: - paid - pending - refund - chargeback - refused - canceled - expired in: query name: transactionStatus required: false description: Situação das vendas consideradas. Sem filtro, considera todas. - schema: type: string enum: - pix - credit_card - boleto - multiple_cards in: query name: paymentMethod required: false description: Filtra as vendas por meio de pagamento. responses: '200': description: Relatório de vendas de afiliação 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: totals: type: object properties: salesCount: type: integer description: Vendas atribuídas a afiliados no período. salesAmount: type: integer description: Valor bruto vendido por afiliados, em centavos. commissionAmount: type: integer description: Comissão apurada para os afiliados, em centavos. averageTicket: type: number description: Ticket médio das vendas de afiliados, em centavos. activeAffiliates: type: integer description: Afiliados com ao menos uma venda no período. required: - salesCount - salesAmount - commissionAmount - averageTicket - activeAffiliates additionalProperties: false description: Consolidado do período inteiro. byAffiliate: type: array items: type: object properties: affiliateCompanyId: type: string description: Empresa afiliada responsável pelas vendas. affiliateName: type: string nullable: true description: Nome da empresa afiliada. salesCount: type: integer description: Vendas atribuídas a este afiliado. salesAmount: type: integer description: >- Valor bruto vendido por este afiliado, em centavos. commissionAmount: type: integer description: >- Comissão apurada para este afiliado, em centavos. lastSaleAt: type: string format: date-time nullable: true description: Momento da venda mais recente deste afiliado. required: - affiliateCompanyId - affiliateName - salesCount - salesAmount - commissionAmount - lastSaleAt additionalProperties: false description: Uma linha por afiliado com venda no período. required: - totals - byAffiliate additionalProperties: false required: - success - data additionalProperties: false description: Relatório de vendas de afiliação do período. example: success: true data: totals: salesCount: 37 salesAmount: 1846300 commissionAmount: 738520 averageTicket: 49900 activeAffiliates: 4 byAffiliate: - affiliateCompanyId: clx9b3k7m0002qz0a5f6g7h8i affiliateName: Marketing Digital Ltda salesCount: 21 salesAmount: 1047900 commissionAmount: 419160 lastSaleAt: '2026-09-11T19:40:12.000Z' '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 ````