Type alias QuickBaseResponseGetReport

QuickBaseResponseGetReport: {
    description: string;
    id: string;
    name: string;
    ownerId: number;
    properties: any;
    query: {
        fields: number[];
        filter: string;
        formulaFields: {
            decimalPrecision: number;
            fieldType: "rich-text" | "text" | "numeric" | "currency" | "percent" | "rating" | "date" | "timestamp" | "timeofday" | "duration" | "checkbox" | "phone" | "email" | "user" | "multiuser" | "url";
            formula: string;
            id: number;
            label: string;
        }[];
        groupBy: {
            fieldId: number;
            grouping: "first-word" | "first-letter" | "equal-values" | "1000000" | "100000" | "10000" | "1000" | "100" | "10" | "1" | ".1" | ".01" | ".001";
        }[];
        sortBy: {
            fieldId: number;
            order: "ASC" | "DESC";
        }[];
        tableId: string;
    };
    type: "map" | "gedit" | "chart" | "summary" | "table" | "timeline" | "calendar";
    usedCount: number;
    usedLast: string;
}

Type declaration

  • 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: any

    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: {
        fields: number[];
        filter: string;
        formulaFields: {
            decimalPrecision: number;
            fieldType: "rich-text" | "text" | "numeric" | "currency" | "percent" | "rating" | "date" | "timestamp" | "timeofday" | "duration" | "checkbox" | "phone" | "email" | "user" | "multiuser" | "url";
            formula: string;
            id: number;
            label: string;
        }[];
        groupBy: {
            fieldId: number;
            grouping: "first-word" | "first-letter" | "equal-values" | "1000000" | "100000" | "10000" | "1000" | "100" | "10" | "1" | ".1" | ".01" | ".001";
        }[];
        sortBy: {
            fieldId: number;
            order: "ASC" | "DESC";
        }[];
        tableId: string;
    }

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

    • fields: number[]

      An array of field ids used in the report

    • filter: string

      Filter used to query for data.

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

      Calculated formula fields.

    • groupBy: {
          fieldId: number;
          grouping: "first-word" | "first-letter" | "equal-values" | "1000000" | "100000" | "10000" | "1000" | "100" | "10" | "1" | ".1" | ".01" | ".001";
      }[]

      An array of fields used in grouping the report

    • sortBy: {
          fieldId: number;
          order: "ASC" | "DESC";
      }[]

      An array of fields used in sorting the report

    • tableId: string

      The table identifier for the report.

  • type: "map" | "gedit" | "chart" | "summary" | "table" | "timeline" | "calendar"

    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.