/tickets/{ticketId}/rule-executions

GET /tickets/{ticketId}/rule-executions

Get rule executions for ticket

Get all automation rule executions for a specific ticket

Required Parameters

ticketId path string

Optional Parameters

Click here to view an exhaustive list of all available parameters

page query integer

pageSize query integer

Try it out

Output:

Responses

Description

Rule executions retrieved successfully

{
  "data": [
    {
      "id": "string",
      "ruleId": "string",
      "ruleName": "string",
      "ticketId": "string",
      "trigger": "string",
      "conditionsMatched": false,
      "actionsPerformed": [
        {
          "type": "string",
          "status": "string",
          "priority": "string",
          "userId": "string",
          "teamId": "string"
        }
      ],
      "success": false,
      "errorMessage": "string",
      "executedAt": "string",
      "executionTime": 0
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "totalPages": 0
}

References

#/components/schemas/RuleAction #/components/schemas/RuleExecution

type: object
properties:
  type:
    type: string
    enum:
      - change_status
      - change_priority
      - assign_to_user
      - assign_to_team
    description: Action type
  status:
    type: string
    description: New status (for change_status action)
  priority:
    type: string
    description: New priority (for change_priority action)
  userId:
    type: string
    description: User ID to assign to (for assign_to_user action)
  teamId:
    type: string
    description: Team ID to assign to (for assign_to_team action)
required:
  - type

|
export interface RuleAction {
  /** Action type */
  type:
    | "change_status"
    | "change_priority"
    | "assign_to_user"
    | "assign_to_team";
  /** New status (for change_status action) */
  status?: string;
  /** New priority (for change_priority action) */
  priority?: string;
  /** User ID to assign to (for assign_to_user action) */
  userId?: string;
  /** Team ID to assign to (for assign_to_team action) */
  teamId?: string;
}

#/components/schemas/RuleExecution

OpenAPI
TypeScript

type: object
properties:
  id:
    type: string
  ruleId:
    type: string
  ruleName:
    type: string
  ticketId:
    type: string
  trigger:
    type: string
    enum:
      - ticket_created
      - ticket_updated
      - status_changed
      - priority_changed
      - assigned
      - comment_added
  conditionsMatched:
    type: boolean
    description: Whether conditions were met
  actionsPerformed:
    type: array
    items:
      $ref: "#/components/schemas/RuleAction"
    description: Actions that were executed
  success:
    type: boolean
    description: Overall execution success
  errorMessage:
    type: string
    nullable: true
    description: Error message if execution failed
  executedAt:
    type: string
    format: date-time
  executionTime:
    type: number
    description: Execution duration in milliseconds

|
export interface RuleExecution {
  id?: string;
  ruleId?: string;
  ruleName?: string;
  ticketId?: string;
  trigger?:
    | "ticket_created"
    | "ticket_updated"
    | "status_changed"
    | "priority_changed"
    | "assigned"
    | "comment_added";
  /** Whether conditions were met */
  conditionsMatched?: boolean;
  /** Actions that were executed */
  actionsPerformed?: RuleAction[];
  /** Overall execution success */
  success?: boolean;
  /** Error message if execution failed */
  errorMessage?: string;
  executedAt?: Date;
  /** Execution duration in milliseconds */
  executionTime?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /tickets/[ticketId]/rule-executions/route.ts

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