getSummary( )

Retrieves a summary of total ticket sales.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function getSummary(options: GetSummaryOptions): Promise<GetSummaryResponse>

getSummary Parameters

NAME

TYPE

DESCRIPTION

options

Optional

GetSummaryOptions

An object representing the available options for retrieving a summary of total ticket sales.

Returns

Return Type:

Promise<

GetSummaryResponse

NAME

TYPE

DESCRIPTION

sales

Array<

TicketSales

Ticket sales grouped by currency.

Was this helpful?

getSummary example

Copy Code

1import { orders } from 'wix-events.v2';
2  
3 async function getSummary(options) {
4   try {
5     const result = await orders.getSummary(options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13