Type Alias RunDetailResponseObject

type RunDetailResponseObject = {
    archived?: boolean;
    context?:
        | "test_run"
        | "editor"
        | "detail"
        | "api_sync"
        | "api_async"
        | "webhook"
        | "lookup";
    createdAt?: string;
    error?: unknown[]
    | null;
    executedById?: string;
    id?: string;
    isArchived?: boolean;
    isTestRun?: boolean;
    metrics?:
        | {
            blocks?: {
                apiCalls?: number;
                connectorId?: string;
                endpointId?: string;
                rxBytes: number;
                snippetId?: string;
                txBytes: number;
                type: "snippetBlock"
                | "endpointBlock";
            }[];
            network?: { rxBytes?: number; txBytes?: number };
            totalApiCalls?: number;
        }
        | null;
    ownerId?: string;
    scheduledStartTime?: string
    | null;
    spaceId?: string;
    startTime?: string | null;
    status?:
        | "failed"
        | "finished"
        | "finished with warnings"
        | "must stop"
        | "not started"
        | "running"
        | "starting"
        | "stopped"
        | "exceeded limit"
        | "queued";
    stopTime?: string
    | null;
    testRun?: boolean;
    title?: string;
    updatedAt?: string;
}
Index
archived? context? createdAt? error? executedById? id? isArchived? isTestRun? metrics? ownerId? scheduledStartTime? spaceId? startTime? status? stopTime? testRun? title? updatedAt?
archived?: boolean

Indicates if this automation run is archived.

context?:
    | "test_run"
    | "editor"
    | "detail"
    | "api_sync"
    | "api_async"
    | "webhook"
    | "lookup"

The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items).

createdAt?: string
error?: unknown[] | null

List of errors that occurred during the automation run.

executedById?: string

The unique identifier of the user who executed the automation run.

id?: string

The unique identifier of the run.

isArchived?: boolean

Indicates if this automation run is archived.

isTestRun?: boolean

Indicates if this automation run is a test run.

metrics?:
    | {
        blocks?: {
            apiCalls?: number;
            connectorId?: string;
            endpointId?: string;
            rxBytes: number;
            snippetId?: string;
            txBytes: number;
            type: "snippetBlock"
            | "endpointBlock";
        }[];
        network?: { rxBytes?: number; txBytes?: number };
        totalApiCalls?: number;
    }
    | null

Type Declaration

  • {
        blocks?: {
            apiCalls?: number;
            connectorId?: string;
            endpointId?: string;
            rxBytes: number;
            snippetId?: string;
            txBytes: number;
            type: "snippetBlock" | "endpointBlock";
        }[];
        network?: { rxBytes?: number; txBytes?: number };
        totalApiCalls?: number;
    }
    • Optionalblocks?: {
          apiCalls?: number;
          connectorId?: string;
          endpointId?: string;
          rxBytes: number;
          snippetId?: string;
          txBytes: number;
          type: "snippetBlock" | "endpointBlock";
      }[]

      List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks

    • Optionalnetwork?: { rxBytes?: number; txBytes?: number }
      • OptionalrxBytes?: number

        The number of received bytes.

      • OptionaltxBytes?: number

        The number of sent bytes.

    • OptionaltotalApiCalls?: number

      The number of API calls made.

  • null
ownerId?: string

The unique identifier of the owner of the automation run.

scheduledStartTime?: string | null

The date and time at which the automation run is scheduled to start.

spaceId?: string

The unique identifier of the space in which the automation run is created.

startTime?: string | null

The date and time at which the automation run started.

status?:
    | "failed"
    | "finished"
    | "finished with warnings"
    | "must stop"
    | "not started"
    | "running"
    | "starting"
    | "stopped"
    | "exceeded limit"
    | "queued"

The current status of the automation run.

stopTime?: string | null

The date and time at which the automation run stopped.

testRun?: boolean

Indicates if this automation run is a test run.

title?: string

The title of the automation run.

updatedAt?: string

Settings
Member Visibility

On This Page
Properties