YAyampi
Métricas - Cashback

Gerar relatórios de cashback

Changed on

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

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

Path parameters

aliasstring required

Alias da loja

widget'orders-with-cashback' | 'cashback-generated' | 'order-percentage' | 'average-time-use' required
Example:orders-with-cashback

Nome do widget de cashback

Response

Retorna os relatórios de cashbacks informados conforme os filtros

start_atstring date-time
end_atstring date-time
compare_start_atstring date-time
compare_end_atstring date-time

Example response

{
  "data": {
    "orders_with_cashback": {
      "data": [
        {
          "day": 24,
          "month": 10,
          "year": 2025,
          "total_orders": 3,
          "total_value": 25740
        }
      ],
      "sum_orders": 5,
      "sum_value": 26423.98,
      "compare": {
        "data": [
          {
            "day": 24,
            "month": 9,
            "year": 2025,
            "total_orders": 1,
            "total_value": 20740
          }
        ]
      }
    },
    "cashback_generated": {
      "data": {
        "total_cashback_generated": 21139.18,
        "total_cashback_used": 455.98
      }
    },
    "order_percentage": {
      "data": [
        {
          "day": 24,
          "month": 10,
          "year": 2025,
          "total_orders": 3,
          "orders_with_cashback": 3,
          "percentage": 100
        }
      ],
      "sum_orders": 5,
      "sum_orders_with_cashback": 5,
      "percent_with_cashback": 100
    },
    "average_time_to_use": {
      "data": {
        "average_days_to_use_cashback": 3
      }
    }
  }
}

Changes