---
title: "Promo code usage summary"
method: GET
path: "/shop/reports/promo-code-usage/summary"
tags: ["DiscountUsage"]
---

# Promo code usage summary

`GET /shop/reports/promo-code-usage/summary`

This endpoint summarises the total discount usage by promo code across all orders matching the given parameters.

## Query parameters

- `site_id` string, uuid, required
- `revenue_date_from` string, date
- `revenue_date_to` string, date
- `submitted_at_from` string, date
- `submitted_at_to` string, date

## Response `200`

The summary of Used Promo Codes was successfully retrieved

- object
  - `data` UsedPromoCodeSummary[], required
    - `discount_type_id` string, uuid, required — The ID of the used promo code.
    - `discount_type_code` string, required — The code for the used promo code.
    - `total_times_used` integer, required — The total number of times the promo code has been used across all orders.
    - `total_discount_across_orders` integer, required — The total discount across all orders from the used promo code.
    - `currency` string, required — The currency of the total discount across all orders from the used promo code. This is associated with the site.
    - `is_archived` boolean, required — Whether the used promo code has been archived.
    - `site_id` string, uuid, required — The ID of the site the used promo code is associated with.

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)