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

    Interface PlatformAnalyticEventSummariesResponse

    interface PlatformAnalyticEventSummariesResponse {
        accountId: string;
        end: string;
        groupBy: "user" | "app";
        metadata?: { nextToken: string };
        results: {
            eventTypes: {
                billingCategory?: "user" | "integration";
                count?: number;
                eventType?: string;
            }[];
            id: string;
            name: string;
            totals: { all?: number; integration?: number; user?: number };
        }[];
        start: string;
        totals?: { all?: number; integration?: number; user?: number };
        where: { id: string; type: "user" | "app" }[];
    }
    Index

    Properties

    accountId end groupBy metadata? results start totals? where

    Properties

    accountId: string

    The ID of the account the events are associated with.

    end: string

    The end date and time of the requested summaries in ISO 8601 time format.

    groupBy: "user" | "app"

    How the events should be grouped.

    metadata?: { nextToken: string }

    Additional information about the results that may be helpful.

    Type Declaration

    • nextToken: string

      Supply this token in a subsequent request to fetch the next page of results.

    results: {
        eventTypes: {
            billingCategory?: "user" | "integration";
            count?: number;
            eventType?: string;
        }[];
        id: string;
        name: string;
        totals: { all?: number; integration?: number; user?: number };
    }[]

    An array of objects that contains Application/User information and an events object with summaries by event type.

    Type Declaration

    • eventTypes: { billingCategory?: "user" | "integration"; count?: number; eventType?: string }[]

      An array of events that contains specific information associated with an Application/User broken down by event type.

    • id: string

      Id of the Application/User.

    • name: string

      Name of the Application/User.

    • totals: { all?: number; integration?: number; user?: number }

      Totals by billing category for the event grouping.

    start: string

    The start date and time of the requested summaries in ISO 8601 time format.

    totals?: { all?: number; integration?: number; user?: number }

    Totals by billing category for all queried events.

    where: { id: string; type: "user" | "app" }[]

    Type Declaration

    • id: string

      Id of the item to filter by.

    • type: "user" | "app"

      The type of item to filter by.

    Settings

    Member Visibility

    On This Page

    Properties