Mayson Monorepo Documentation
    Preparing search index...

    Interface ScheduledQueryRun

    If you have scheduled a Sigma query, you'll receive a sigma.scheduled_query_run.created webhook each time the query runs. The webhook contains a ScheduledQueryRun object, which you can use to retrieve the query results.

    interface ScheduledQueryRun {
        id: string;
        object: "scheduled_query_run";
        created: number;
        data_load_time: number;
        error?: Stripe.Sigma.ScheduledQueryRun.Error;
        file: Stripe.File;
        livemode: boolean;
        result_available_until: number;
        sql: string;
        status: string;
        title: string;
    }
    Index

    Properties

    id object created data_load_time error? file livemode result_available_until sql status title

    Properties

    id: string

    Unique identifier for the object.

    object: "scheduled_query_run"

    String representing the object's type. Objects of the same type share the same value.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    data_load_time: number

    When the query was run, Sigma contained a snapshot of your Stripe data at this time.

    error?: Stripe.Sigma.ScheduledQueryRun.Error
    file: Stripe.File

    The file object representing the results of the query.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    result_available_until: number

    Time at which the result expires and is no longer available for download.

    sql: string

    SQL for the query.

    status: string

    The query's execution status, which will be completed for successful runs, and canceled, failed, or timed_out otherwise.

    title: string

    Title of the query.

    Settings

    Member Visibility

    On This Page

    Properties