/tickets/statistics

GET /tickets/statistics

Get ticket statistics

Retrieve comprehensive ticket statistics for the account

Optional Parameters

Click here to view an exhaustive list of all available parameters

startDate query string

Start date for statistics (ISO 8601 format)

endDate query string

End date for statistics (ISO 8601 format)

groupBy query string

Group statistics by field

includeArchived query boolean

Include archived tickets in statistics

Try it out

Output:

Responses

Description

Statistics retrieved successfully

{
  "total": 0,
  "byStatus": {
    "open": 0,
    "in_progress": 0,
    "waiting_customer": 0,
    "waiting_internal": 0,
    "resolved": 0,
    "closed": 0
  },
  "byPriority": {
    "urgent": 0,
    "high": 0,
    "medium": 0,
    "low": 0
  },
  "byTeam": {},
  "byUser": {},
  "byCategory": {},
  "slaCompliance": {
    "firstResponse": {
      "met": 0,
      "breached": 0,
      "compliancePercent": 0
    },
    "resolution": {
      "met": 0,
      "breached": 0,
      "compliancePercent": 0
    }
  },
  "slaStatus": {
    "on_time": 0,
    "at_risk": 0,
    "breached": 0,
    "paused": 0
  },
  "averageResponseTime": 0,
  "averageResolutionTime": 0,
  "ticketVolume": {
    "today": 0,
    "thisWeek": 0,
    "thisMonth": 0
  },
  "trends": {
    "dailyCreated": [
      {
        "date": "string",
        "count": 0
      }
    ],
    "dailyResolved": [
      {
        "date": "string",
        "count": 0
      }
    ]
  },
  "topCategories": [
    {
      "category": "string",
      "count": 0
    }
  ],
  "dateRange": {
    "startDate": "string",
    "endDate": "string"
  }
}

References

#/components/schemas/TicketStatistics

OpenAPI
TypeScript

type: object
properties:
  total:
    type: integer
    description: Total number of tickets
  byStatus:
    type: object
    properties:
      open:
        type: integer
      in_progress:
        type: integer
      waiting_customer:
        type: integer
      waiting_internal:
        type: integer
      resolved:
        type: integer
      closed:
        type: integer
    description: Ticket counts by status
  byPriority:
    type: object
    properties:
      urgent:
        type: integer
      high:
        type: integer
      medium:
        type: integer
      low:
        type: integer
    description: Ticket counts by priority
  byTeam:
    type: object
    additionalProperties:
      type: integer
    description: Ticket counts by team
  byUser:
    type: object
    additionalProperties:
      type: integer
    description: Ticket counts by assigned user
  byCategory:
    type: object
    additionalProperties:
      type: integer
    description: Ticket counts by category
  slaCompliance:
    type: object
    properties:
      firstResponse:
        type: object
        properties:
          met:
            type: integer
          breached:
            type: integer
          compliancePercent:
            type: number
      resolution:
        type: object
        properties:
          met:
            type: integer
          breached:
            type: integer
          compliancePercent:
            type: number
    description: SLA compliance metrics
  slaStatus:
    type: object
    properties:
      on_time:
        type: integer
      at_risk:
        type: integer
      breached:
        type: integer
      paused:
        type: integer
    description: Current SLA status distribution
  averageResponseTime:
    type: number
    description: Average first response time in minutes
  averageResolutionTime:
    type: number
    description: Average resolution time in minutes
  ticketVolume:
    type: object
    properties:
      today:
        type: integer
      thisWeek:
        type: integer
      thisMonth:
        type: integer
    description: Ticket volume metrics
  trends:
    type: object
    properties:
      dailyCreated:
        type: array
        items:
          type: object
          properties:
            date:
              type: string
              format: date
            count:
              type: integer
      dailyResolved:
        type: array
        items:
          type: object
          properties:
            date:
              type: string
              format: date
            count:
              type: integer
    description: Trend data over time
  topCategories:
    type: array
    items:
      type: object
      properties:
        category:
          type: string
        count:
          type: integer
    description: Top ticket categories
  dateRange:
    type: object
    properties:
      startDate:
        type: string
        format: date
      endDate:
        type: string
        format: date
    description: Date range for statistics

|
export interface TicketStatistics {
  /** Total number of tickets */
  total?: number;
  /** Ticket counts by status */
  byStatus?: {
    open?: number;
    in_progress?: number;
    waiting_customer?: number;
    waiting_internal?: number;
    resolved?: number;
    closed?: number;
  };
  /** Ticket counts by priority */
  byPriority?: {
    urgent?: number;
    high?: number;
    medium?: number;
    low?: number;
  };
  /** Ticket counts by team */
  byTeam?: Record<string, number>;
  /** Ticket counts by assigned user */
  byUser?: Record<string, number>;
  /** Ticket counts by category */
  byCategory?: Record<string, number>;
  /** SLA compliance metrics */
  slaCompliance?: {
    firstResponse?: {
      met?: number;
      breached?: number;
      compliancePercent?: number;
    };
    resolution?: {
      met?: number;
      breached?: number;
      compliancePercent?: number;
    };
  };
  /** Current SLA status distribution */
  slaStatus?: {
    on_time?: number;
    at_risk?: number;
    breached?: number;
    paused?: number;
  };
  /** Average first response time in minutes */
  averageResponseTime?: number;
  /** Average resolution time in minutes */
  averageResolutionTime?: number;
  /** Ticket volume metrics */
  ticketVolume?: { today?: number; thisWeek?: number; thisMonth?: number };
  /** Trend data over time */
  trends?: {
    dailyCreated?: { date?: Date; count?: number }[];
    dailyResolved?: { date?: Date; count?: number }[];
  };
  /** Top ticket categories */
  topCategories?: { category?: string; count?: number }[];
  /** Date range for statistics */
  dateRange?: { startDate?: Date; endDate?: Date };
}

Route Source Code

Check out the source code for this route entrypoint here: /tickets/statistics/route.ts

Or the swagger.yaml spec this documentation was generated from: /tickets/statistics/swagger.yaml