---
title: "Summary"
method: GET
path: "/api/admin/mailing/summary"
tags: ["mailing"]
---

# Summary

`GET /api/admin/mailing/summary`

## Request

- Base URL: `https://api.getcheapgames.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getcheapgames.com/api/admin/mailing/summary`
- Auth: none declared

How big the list is, how it moved in the last thirty days, where it signed
up and what it was sent; and the free games, whichever list is asked for
(they are the site's, not a list's).

## Query parameters

- `list` 'giveaways' | 'sales' | 'news'

## Headers

- `authorization` string

## Response `200`

Successful Response

- SummaryOut
  - `list` string, required
  - `listId` 'giveaways' | 'sales' | 'news', required
  - `name` string, required
  - `counts` Counts, required
    - `subscribed` integer, required
    - `pending` integer, required
    - `unsubscribed` integer, required
    - `total` integer, required
  - `joined30d` integer, required
  - `left30d` integer, required
  - `breakdown` Breakdown, required
    - `label` string, required
    - `rows` BreakdownRow[], required
      - `key` string, required
      - `count` integer, required
  - `sends` Sends, required
    - `total` integer, required
    - `lastAt` string, date-time, nullable, required
    - `last30d` integer, required
  - `giveaways` GiveawaysSummary, required
    - `open` integer, required
    - `last30d` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getcheapgames/apis/getcheapgames-api.md) · [All operations](https://skmtc.dev/getcheapgames/apis/getcheapgames-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getcheapgames/apis/getcheapgames-api/revisions/57333a690301?raw)