---
title: "Get FeverZone sales summary report"
method: GET
path: "/feverzone/sales-summary/search/{search_id}"
tags: ["FeverZone"]
---

# Get FeverZone sales summary report

`GET /feverzone/sales-summary/search/{search_id}`

## Request

- Base URL: `https://data-reporting-api.prod.feverup.com/v1`
- URL: `https://data-reporting-api.prod.feverup.com/v1/feverzone/sales-summary/search/{search_id}`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth/token`
- TypeScript: <https://skmtc.dev/feverup/apis/fever-reporting-api/docs/feverzone/sales-summary/search/:search_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get an existing FeverZone sales summary report from `search_id`, allowing to pass a specific `page` number. In case the search is still processing, it will return a `202` status code and you should retry it again until it is ready. Otherwise, it will return a `200` code and the report outputNotice that the `partition_info` metadata is only returned when `page=0`, being `null` for the rest of the pages

## Path parameters

- `search_id` string, uuid, required

## Query parameters

- `page` integer

## Headers

- `user-id-to-impersonate` integer: User id from the user that you want to impersonate

## Response `200`

Search was obtained successfully

- SearchSalesSummarySalesSummaryParams
  - `partition_info` PartitionInfo[]: Partition information
    - `partition_num` integer, required: Partition number
    - `endpoint` string, required: Endpoint to fetch data for partition
    - `size` integer, required: Partition size in bytes
    - `rows` integer, required: Number of rows contained in partition. One row represents a single transaction result (e.g. order, plan etc.).
  - `params` SalesSummaryParams
    - `currency` 'AED' | 'ARS' | 'AUD' | 'AZN' | 'BGN' | 'BHD' | 'BMD' | 'BRL' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'JPY' | 'KRW' | 'MAD' | 'MXN' | 'MYR' | 'NOK' | 'NZD' | 'PEN' | 'PHP' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'USD' | 'UYU' | 'ZAR'
    - `plan_ids` integer[]: List of ids of the plans to filter by.
    - `event_start_date_local_from` string: Local start date for the event start date filter. The timezone corresponds to the venue timezone where the event takes place. If hour and minute are not specified, 00:00 is added by default
    - `event_start_date_local_to` string: Local end date for the event start date filter. The timezone corresponds to the venue timezone where the event takes place. If hour and minute are not specified, 00:00 is added by default
    - `purchase_date_local_from` string: Local start date for the purchase date filter. The timezone corresponds to the venue timezone where the event takes place. If hour and minute are not specified, 00:00 is added by default
    - `purchase_date_local_to` string: Local end date for the purchase date filter. The timezone corresponds to the venue timezone where the event takes place. If hour and minute are not specified, 00:00 is added by default
  - `data` SalesSummary[], required: Data rows
    - `tickets_sold` integer, required: Number of tickets sold
    - `addons_sold` integer, required: Number of addons sold
    - `ticket_invitations` integer, required: Number of ticket invitations
    - `addon_invitations` integer, required: Number of addons invitations
    - `ticket_guestlist` integer, required: Number of guestlist tickets, apart from the invitations
    - `addon_guestlist` integer, required: Number of guestlist addons, apart from the invitations
    - `total_gross_revenue` number, required: Total gross revenue
    - `ticket_gross_revenue` number, required: Ticket gross revenue
    - `addon_gross_revenue` number, required: Addons gross revenue
    - `surcharge` number, required: Surcharge
    - `ticket_surcharge` number, required: Tickets surcharge
    - `addon_surcharge` number, required: Addons surcharge
    - `discount` number, required: Discount
    - `user_payment` number, required: User payment
    - `currency` 'AED' | 'ARS' | 'AUD' | 'AZN' | 'BGN' | 'BHD' | 'BMD' | 'BRL' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'JPY' | 'KRW' | 'MAD' | 'MXN' | 'MYR' | 'NOK' | 'NZD' | 'PEN' | 'PHP' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'USD' | 'UYU' | 'ZAR'
    - `orders` integer, required: Number of orders

## Other responses

- `202`: Request is still running asynchronously.
- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `408`: Request Timeout
- `410`: Search expired
- `422`: Validation Error
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/feverup/apis/fever-reporting-api.md) - [All operations](https://skmtc.dev/feverup/apis/fever-reporting-api/llms.txt) - [OpenAPI document](https://skmtc.dev/feverup/apis/fever-reporting-api/revisions/a2e1afe5c12d?raw)