> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.tixyapp.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve sales report for events by status > Returns detailed sales report for events based on the specified status in the path. This endpoint requires authentication and provides an overview of the event's sales performance, including the number of tickets sold, net and gross income, fees, and other relevant sales metrics. ## OpenAPI ````yaml get /sales/events openapi: 3.0.1 info: title: TIXY Private Organizer API version: 1.0.0 description: > The TIXY Private Organizer API provides endpoints for event organizers to manage their events and handle secure interactions with clients. It includes CORS preflight support, event retrieval by unique ID or slug, and integrates with AWS Lambda for custom backend processing. servers: - url: https://private-api.tixyapp.com security: [] paths: /sales/events: get: summary: Retrieve sales report for events by status description: > Returns detailed sales report for events based on the specified status in the path. This endpoint requires authentication and provides an overview of the event's sales performance, including the number of tickets sold, net and gross income, fees, and other relevant sales metrics. parameters: - name: status in: query required: false example: published description: > The status of the events to retrieve sales report for. If not specified, it defaults to `all`. Valid values are: - `all`: Fetch sales report for all events. - `published`: Fetch sales report for events currently published. - `pastdue`: Fetch sales report for events whose dates have passed. schema: type: string enum: - all - published - pastdue - name: from in: query required: false description: > The from date in the range of dates for the request. Must be a 24-character hexadecimal string. **Note:** dates should be in the format `YYYY-MM-DD`. If not provided, defaults to the earliest date available. schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ example: '2024-12-31' - name: to in: query required: false description: > The end date in the range of dates for the request. Must be a 24-character hexadecimal string. **Note:** dates should be in the format `YYYY-MM-DD`. If not provided, defaults to the current date. schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ responses: '200': description: > Successful response containing sales report for the specified events. content: application/json: schema: type: array items: $ref: '#/components/schemas/EventSalesReport' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' security: - privateOrganizerApiAuthFunction: [] components: schemas: EventSalesReport: type: object properties: id: type: string description: Unique identifier for the event. name: type: string description: Name of the event. slug: type: string description: Unique identifier for the event. vatRate: type: string description: VAT rate for the event. income: type: object description: Default service charge structure paid by ticket buyers. properties: nettIncome: type: number format: float description: Net income. grossIncome: type: number format: float description: Gross income. vatAmount: type: number format: float description: VAT amount. commission: type: object properties: amount: type: number format: float description: Commission amount. percentage: type: number format: float description: Gross income percentage. returns: type: object properties: nettReturns: type: number format: float description: Net returns. grossReturns: type: number format: float description: Gross returns. returnedTicketsCount: type: number format: float description: Returned tickets count. returnedTicketsPercentage: type: number format: float description: Returned tickets percentage. ticketSales: type: array description: Details about ticket sales including pricing, revenue, and fees. items: type: object properties: poolName: type: string description: Name of the ticket pool. combinedName: type: string description: Combined name of the ticket and pool. ticketName: type: string description: Name of the ticket (optional field). ticketPrice: type: number format: float description: Price of a single ticket. ticketSoldAmount: type: integer description: Number of tickets sold. grossSales: type: number format: float description: Total gross sales revenue for this ticket. tixyFee: type: number format: float description: Platform fee for this ticket. withdraw: type: number format: float description: Amount withdrawable after fees. required: - id - name - slug - income - commission - returns responses: BadRequest: description: | Bad Request. The `id` parameter is invalid or malformed. content: application/json: schema: type: object properties: message: type: string description: Error message explaining the issue. code: type: string description: Error code indicating the error. Unauthorized: description: > Unauthorized. The request is not authenticated, or the provided credentials are invalid. content: application/json: schema: type: object properties: message: type: string description: Error message explaining the unauthorized request. code: type: string description: Error code indicating the reason for the unauthorized status. Forbidden: description: > Forbidden. The request is authenticated but does not have the necessary permissions to access the resource. content: application/json: schema: type: object properties: message: type: string description: Error message explaining the forbidden request. code: type: string description: Error code indicating the reason for the forbidden status. InternalServerError: description: > Internal Server Error. An unexpected error occurred while processing the request. content: application/json: schema: type: object properties: message: type: string description: Error message explaining the server issue. code: type: string description: Error code indicating the server error. securitySchemes: privateOrganizerApiAuthFunction: type: http scheme: bearer description: > Custom Bearer token authentication for accessing private organizer endpoints. x-amazon-apigateway-authtype: custom x-amazon-apigateway-authorizer: authorizerUri: uri: Fn::Sub: >- arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${organizerApiAuthFunction.Arn}/invocations authorizerResultTtlInSeconds: 300 identitySource: method.request.header.Authorization ````