---
title: "Gerar relatórios de cashback"
method: GET
path: "/{alias}/metrics/cashback/{widget}"
tags: ["Métricas - Cashback"]
---

# Gerar relatórios de cashback

`GET /{alias}/metrics/cashback/{widget}`

## Request

- Base URL: `https://api.dooki.com.br/v2`
- URL: `https://api.dooki.com.br/v2/{alias}/metrics/cashback/{widget}`
- Auth: API key in header `User-Token` and API key in header `User-Secret-Key`

Gera relatórios de cashback com base no widget informado e nos filtros aplicados.

## Path parameters

- `alias` string, required
- `widget` 'orders-with-cashback' | 'cashback-generated' | 'order-percentage' | 'average-time-use', required

## Response `200`

Retorna os relatórios de cashbacks informados conforme os filtros

- object
  - `start_at` string, date-time
  - `end_at` string, date-time
  - `compare_start_at` string, date-time
  - `compare_end_at` string, date-time
  - `data` object
    - `orders_with_cashback` object
      - `data` object[]
        - `day` integer
        - `month` integer
        - `year` integer
        - `total_orders` integer
        - `total_value` number, float
      - `sum_orders` integer
      - `sum_value` number, float
      - `compare` object
        - `data` object[]
          - `day` integer
          - `month` integer
          - `year` integer
          - `total_orders` integer
          - `total_value` number, float
        - `sum_orders` integer
        - `sum_value` number, float
        - `percent` object
          - `sum_orders` number, float
          - `sum_value` number, float
    - `cashback_generated` object
      - `data` object
        - `total_cashback_generated` number, float
        - `total_cashback_used` number, float
      - `compare` object
        - `data` object
          - `total_cashback_generated` number, float
          - `total_cashback_used` number, float
        - `percent` object
          - `total_cashback_generated` number, float
    - `order_percentage` object
      - `data` object[]
        - `day` integer
        - `month` integer
        - `year` integer
        - `total_orders` integer
        - `orders_with_cashback` integer
        - `percentage` number, float
      - `sum_orders` integer
      - `sum_orders_with_cashback` integer
      - `percent_with_cashback` number, float
    - `average_time_to_use` object
      - `data` object
        - `average_days_to_use_cashback` number, float

## Other responses

- `400`: Dados fornecidos inválidos
- `422`: Verifique os campos obrigatórios e os formatos esperados

## Changes

- **2026-11-03** `bbafb577e11c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/yampi/apis/yampi-api/changes/:alias/metrics/cashback/:widget/get.md)

---

[API](https://skmtc.dev/yampi/apis/yampi-api.md) - [All operations](https://skmtc.dev/yampi/apis/yampi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yampi/apis/yampi-api/revisions/74739ec8876f?raw)