> ## 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 a specific event

> Fetches detailed sales report for a specific event identified by its unique identifier (`eventId`)  or SEO-friendly slug (`eventSlug`). This endpoint requires authentication and provides information  such as the number of tickets sold, net and gross income, fees, and other relevant sales metrics  for the specified event.




## OpenAPI

````yaml get /sales/event
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/event:
    get:
      summary: Retrieve sales report for a specific event
      description: >
        Fetches detailed sales report for a specific event identified by its
        unique identifier (`eventId`)  or SEO-friendly slug (`eventSlug`). This
        endpoint requires authentication and provides information  such as the
        number of tickets sold, net and gross income, fees, and other relevant
        sales metrics  for the specified event.
      parameters:
        - name: eventId
          in: query
          required: false
          description: >
            The unique identifier for the event. Must be a 24-character
            hexadecimal string. **Note:** If you provide this parameter, do not
            provide `eventSlug`.
          schema:
            type: string
            pattern: ^[a-f0-9]{24}$
        - name: eventSlug
          in: query
          required: false
          description: >
            The SEO-friendly slug for the event. Accepts alphanumeric
            characters, hyphens, underscores, and periods. **Note:** If you
            provide this parameter, do not provide `eventId`.
          schema:
            type: string
            pattern: ^[a-zA-Z0-9-_\\.]+$
        - 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}$
        - 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 event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSalesReport'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '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.
    NotFound:
      description: |
        Not Found. No resource was found for the specified `id`.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error message explaining that the resource was not found.
              code:
                type: string
                description: Error code indicating the resource was not found.
    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

````