> ## 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 statistics for events by status

> Provides ticket statistics for events filtered by status (e.g., published, pastdue).




## OpenAPI

````yaml get /statistics/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:
  /statistics/events:
    get:
      summary: Retrieve statistics for events by status
      description: >
        Provides ticket statistics for events filtered by status (e.g.,
        published, pastdue).
      parameters:
        - name: status
          in: query
          required: false
          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}$
        - 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 statistics for events matching the
            specified status.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StatisticsReport'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - privateOrganizerApiAuthFunction: []
components:
  schemas:
    StatisticsReport:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the event or tour.
        name:
          type: string
          description: Name of the event or tour.
        ticket_statistics:
          $ref: '#/components/schemas/TicketStatistics'
    TicketStatistics:
      type: object
      properties:
        available:
          type: object
          properties:
            count:
              type: integer
              description: Number of tickets available.
            percentage:
              type: number
              format: float
              description: Percentage of total tickets available.
        sold:
          type: object
          properties:
            count:
              type: integer
              description: Number of tickets sold.
            percentage:
              type: number
              format: float
              description: Percentage of total tickets sold.
        reserved:
          type: object
          properties:
            count:
              type: integer
              description: Number of tickets in reservation.
            percentage:
              type: number
              format: float
              description: Percentage of total tickets in reservation.
        unsold:
          type: object
          properties:
            count:
              type: integer
              description: Number of tickets unsold.
            percentage:
              type: number
              format: float
              description: Percentage of total tickets unsold.
        returned:
          type: object
          properties:
            count:
              type: integer
              description: Number of tickets returned.
            percentage:
              type: number
              format: float
              description: Percentage of total tickets returned.
        invitations:
          type: object
          properties:
            count:
              type: integer
              description: Number of tickets distributed as invitations.
            percentage:
              type: number
              format: float
              description: Percentage of total tickets distributed as invitations.
  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

````