getSummary( )

Retrieves a summary of total ticket sales.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Orders
Read Basic Events Order Info
Manage Events
Learn more about app permissions.
Method Declaration
Copy
function getSummary(options: GetSummaryOptions): Promise<GetSummaryResponse>;
Method Parameters
optionsGetSummaryOptions

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

Returns
Return Type:Promise<GetSummaryResponse>
JavaScript
import { orders } from "@wix/events";

async function getSummary(options) {
  const response = await orders.getSummary(options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?