QuickBase JS SDK v2 - v2.2.2
    Preparing search index...

    Interface GetReportResponse

    interface GetReportResponse {
        description?: string;
        id?: string;
        name?: string;
        ownerId?: number;
        properties?: Record<string, unknown>;
        query?: {
            filter?: string;
            formulaFields?: {
                decimalPrecision?: number;
                fieldType?:
                    | "date"
                    | "email"
                    | "url"
                    | "rich-text"
                    | "text"
                    | "numeric"
                    | "currency"
                    | "percent"
                    | "rating"
                    | "timestamp"
                    | "timeofday"
                    | "duration"
                    | "checkbox"
                    | "phone"
                    | "user"
                    | "multiuser";
                formula?: string;
                id?: number;
                label?: string;
                [key: string]: unknown;
            }[];
            tableId?: string;
            [key: string]: unknown;
        };
        type?: string;
        usedCount?: number;
        usedLast?: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index

    Properties

    description? id? name? ownerId? properties? query? type? usedCount? usedLast?

    Properties

    description?: string

    The configured description of a report.

    id?: string

    The identifier of the report, unique to the table.

    name?: string

    The configured name of the report.

    ownerId?: number

    Optional, showed only for personal reports. The user ID of report owner.

    properties?: Record<string, unknown>

    A list of properties specific to the report type. To see a detailed description of the properties for each report type, See Report Types.

    query?: {
        filter?: string;
        formulaFields?: {
            decimalPrecision?: number;
            fieldType?:
                | "date"
                | "email"
                | "url"
                | "rich-text"
                | "text"
                | "numeric"
                | "currency"
                | "percent"
                | "rating"
                | "timestamp"
                | "timeofday"
                | "duration"
                | "checkbox"
                | "phone"
                | "user"
                | "multiuser";
            formula?: string;
            id?: number;
            label?: string;
            [key: string]: unknown;
        }[];
        tableId?: string;
        [key: string]: unknown;
    }

    The query definition as configured in Quickbase that gets executed when the report is run.

    Type Declaration

    • [key: string]: unknown
    • Optionalfilter?: string

      Filter used to query for data.

    • OptionalformulaFields?: {
          decimalPrecision?: number;
          fieldType?:
              | "date"
              | "email"
              | "url"
              | "rich-text"
              | "text"
              | "numeric"
              | "currency"
              | "percent"
              | "rating"
              | "timestamp"
              | "timeofday"
              | "duration"
              | "checkbox"
              | "phone"
              | "user"
              | "multiuser";
          formula?: string;
          id?: number;
          label?: string;
          [key: string]: unknown;
      }[]

      Calculated formula fields.

    • OptionaltableId?: string

      The table identifier for the report.

    type?: string

    The type of report in Quickbase (e.g., chart).

    usedCount?: number

    The number of times a report has been used.

    usedLast?: string

    The instant at which a report was last used.

    Settings

    Member Visibility

    On This Page

    Properties