nodes/generated

Interface GoogleAnalyticsV2NodeParameters

Source
interface GoogleAnalyticsV2NodeParameters {
    additionalFields?:
        | {
            currencyCode?: string;
            dimensionFiltersUI?: {
                filterExpressions: {
                    expression?: {
                        inListFilter: {
                            caseSensitive?: boolean;
                            listName?: | "other"
                            | "date"
                            | "language"
                            | "browser"
                            | "campaignName"
                            | "city"
                            | "country"
                            | "deviceCategory"
                            | "itemName"
                            | "pageLocation"
                            | "sourceMedium";
                            name?: string;
                            values?: string;
                        }[];
                        numericFilter: {
                            listName?: | "other"
                            | "date"
                            | "language"
                            | "browser"
                            | "campaignName"
                            | "city"
                            | "country"
                            | "deviceCategory"
                            | "itemName"
                            | "pageLocation"
                            | "sourceMedium";
                            name?: string;
                            operation?: | "EQUAL"
                            | "GREATER_THAN"
                            | "GREATER_THAN_OR_EQUAL"
                            | "LESS_THAN"
                            | "LESS_THAN_OR_EQUAL";
                            value?: string;
                            valueType?: "doubleValue"
                            | "int64Value";
                        }[];
                        stringFilter: {
                            caseSensitive?: boolean;
                            listName?: | "other"
                            | "date"
                            | "language"
                            | "browser"
                            | "campaignName"
                            | "city"
                            | "country"
                            | "deviceCategory"
                            | "itemName"
                            | "pageLocation"
                            | "sourceMedium";
                            matchType?: | "BEGINS_WITH"
                            | "ENDS_WITH"
                            | "EXACT"
                            | "CONTAINS"
                            | "FULL_REGEXP"
                            | "PARTIAL_REGEXP";
                            name?: string;
                            value?: string;
                        }[];
                    };
                    filterExpressionType?: "andGroup"
                    | "orGroup";
                };
            };
            keepEmptyRows?: boolean;
            metricAggregations?: (
                "MAXIMUM"
                | "MINIMUM"
                | "TOTAL"
            )[];
            metricsFiltersUI?: {
                filterExpressions: {
                    expression?: {
                        betweenFilter: {
                            fromValue?: string;
                            listName?:
                                | "custom"
                                | "other"
                                | "active1DayUsers"
                                | "active28DayUsers"
                                | "active7DayUsers"
                                | "checkouts"
                                | "eventCount"
                                | "screenPageViews"
                                | "userEngagementDuration"
                                | "sessions"
                                | "sessionsPerUser"
                                | "totalUsers";
                            name?: string;
                            toValue?: string;
                            valueType?: "doubleValue"
                            | "int64Value";
                        }[];
                        numericFilter: {
                            listName?: | "custom"
                            | "other"
                            | "active1DayUsers"
                            | "active28DayUsers"
                            | "active7DayUsers"
                            | "checkouts"
                            | "eventCount"
                            | "screenPageViews"
                            | "userEngagementDuration"
                            | "sessions"
                            | "sessionsPerUser"
                            | "totalUsers";
                            name?: string;
                            operation?: | "EQUAL"
                            | "GREATER_THAN"
                            | "GREATER_THAN_OR_EQUAL"
                            | "LESS_THAN"
                            | "LESS_THAN_OR_EQUAL";
                            value?: string;
                            valueType?: "doubleValue"
                            | "int64Value";
                        }[];
                    };
                    filterExpressionType?: "andGroup"
                    | "orGroup";
                };
            };
            orderByUI?: {
                dimmensionOrderBy: {
                    desc?: boolean;
                    dimensionName?: string;
                    orderType?: | "ALPHANUMERIC"
                    | "CASE_INSENSITIVE_ALPHANUMERIC"
                    | "NUMERIC"
                    | "ORDER_TYPE_UNSPECIFIED";
                }[];
                metricOrderBy: {
                    desc?: boolean;
                    metricName?: string;
                }[];
            };
            returnPropertyQuota?: boolean;
        }
        | {
            dimensionFiltersUi?: {
                filterValues: {
                    expressions?: string;
                    listName?: | "other"
                    | "ga:browser"
                    | "ga:campaign"
                    | "ga:city"
                    | "ga:country"
                    | "ga:date"
                    | "ga:deviceCategory"
                    | "ga:productName"
                    | "ga:language"
                    | "ga:pagePath"
                    | "ga:sourceMedium";
                    name?: string;
                    operator?: | "BEGINS_WITH"
                    | "ENDS_WITH"
                    | "NUMERIC_EQUAL"
                    | "EXACT"
                    | "NUMERIC_GREATER_THAN"
                    | "NUMERIC_LESS_THAN"
                    | "PARTIAL"
                    | "REGEXP";
                }[];
            };
            hideTotals?: boolean;
            hideValueRanges?: boolean;
            includeEmptyRows?: boolean;
            useResourceQuotas?: boolean;
        }
        | {
            activityTypes?: (
                | "ECOMMERCE"
                | "EVENT"
                | "GOAL"
                | "PAGEVIEW"
                | "SCREENVIEW"
            )[];
        };
    dateRange?: | "custom"
    | "today"
    | "last7days"
    | "last30days"
    | "yesterday"
    | "lastCalendarWeek"
    | "lastCalendarMonth";
    dimensionsGA4?: {
        dimensionValues: {
            listName?: | "other"
            | "date"
            | "language"
            | "browser"
            | "campaignName"
            | "city"
            | "country"
            | "deviceCategory"
            | "itemName"
            | "pageLocation"
            | "sourceMedium";
            name?: string;
        }[];
    };
    dimensionsUA?: {
        dimensionValues: {
            listName?: | "other"
            | "ga:browser"
            | "ga:campaign"
            | "ga:city"
            | "ga:country"
            | "ga:date"
            | "ga:deviceCategory"
            | "ga:productName"
            | "ga:language"
            | "ga:pagePath"
            | "ga:sourceMedium";
            name?: string;
        }[];
    };
    endDate?: string;
    limit?: number;
    metricsGA4?: {
        metricValues: {
            expression?: string;
            invisible?: boolean;
            listName?: | "custom"
            | "other"
            | "active1DayUsers"
            | "active28DayUsers"
            | "active7DayUsers"
            | "checkouts"
            | "eventCount"
            | "screenPageViews"
            | "userEngagementDuration"
            | "sessions"
            | "sessionsPerUser"
            | "totalUsers";
            name?: string;
        }[];
    };
    metricsUA?: {
        metricValues: {
            expression?: string;
            formattingType?: | "CURRENCY"
            | "FLOAT"
            | "INTEGER"
            | "PERCENT"
            | "TIME";
            listName?: | "custom"
            | "other"
            | "ga:productCheckouts"
            | "ga:totalEvents"
            | "ga:pageviews"
            | "ga:sessionDuration"
            | "ga:sessions"
            | "ga:sessionsPerUser"
            | "ga:users";
            name?: string;
        }[];
    };
    operation?: "get"
    | "search";
    propertyId?: {
        mode: "id" | "list" | "url";
        value: string;
    };
    propertyType?: "ga4"
    | "universal";
    resource?: "report" | "userActivity";
    returnAll?: boolean;
    simple?: boolean;
    startDate?: string;
    userId?: string;
    viewId?:
        | string
        | { mode: "id"
        | "list"
        | "url"; value: string };
}

Properties§

Source§

readonly additionalFields?:
    | {
        currencyCode?: string;
        dimensionFiltersUI?: {
            filterExpressions: {
                expression?: {
                    inListFilter: {
                        caseSensitive?: boolean;
                        listName?: | "other"
                        | "date"
                        | "language"
                        | "browser"
                        | "campaignName"
                        | "city"
                        | "country"
                        | "deviceCategory"
                        | "itemName"
                        | "pageLocation"
                        | "sourceMedium";
                        name?: string;
                        values?: string;
                    }[];
                    numericFilter: {
                        listName?: | "other"
                        | "date"
                        | "language"
                        | "browser"
                        | "campaignName"
                        | "city"
                        | "country"
                        | "deviceCategory"
                        | "itemName"
                        | "pageLocation"
                        | "sourceMedium";
                        name?: string;
                        operation?: | "EQUAL"
                        | "GREATER_THAN"
                        | "GREATER_THAN_OR_EQUAL"
                        | "LESS_THAN"
                        | "LESS_THAN_OR_EQUAL";
                        value?: string;
                        valueType?: "doubleValue"
                        | "int64Value";
                    }[];
                    stringFilter: {
                        caseSensitive?: boolean;
                        listName?: | "other"
                        | "date"
                        | "language"
                        | "browser"
                        | "campaignName"
                        | "city"
                        | "country"
                        | "deviceCategory"
                        | "itemName"
                        | "pageLocation"
                        | "sourceMedium";
                        matchType?: | "BEGINS_WITH"
                        | "ENDS_WITH"
                        | "EXACT"
                        | "CONTAINS"
                        | "FULL_REGEXP"
                        | "PARTIAL_REGEXP";
                        name?: string;
                        value?: string;
                    }[];
                };
                filterExpressionType?: "andGroup"
                | "orGroup";
            };
        };
        keepEmptyRows?: boolean;
        metricAggregations?: ("MAXIMUM" | "MINIMUM" | "TOTAL")[];
        metricsFiltersUI?: {
            filterExpressions: {
                expression?: {
                    betweenFilter: {
                        fromValue?: string;
                        listName?:
                            | "custom"
                            | "other"
                            | "active1DayUsers"
                            | "active28DayUsers"
                            | "active7DayUsers"
                            | "checkouts"
                            | "eventCount"
                            | "screenPageViews"
                            | "userEngagementDuration"
                            | "sessions"
                            | "sessionsPerUser"
                            | "totalUsers";
                        name?: string;
                        toValue?: string;
                        valueType?: "doubleValue"
                        | "int64Value";
                    }[];
                    numericFilter: {
                        listName?: | "custom"
                        | "other"
                        | "active1DayUsers"
                        | "active28DayUsers"
                        | "active7DayUsers"
                        | "checkouts"
                        | "eventCount"
                        | "screenPageViews"
                        | "userEngagementDuration"
                        | "sessions"
                        | "sessionsPerUser"
                        | "totalUsers";
                        name?: string;
                        operation?: | "EQUAL"
                        | "GREATER_THAN"
                        | "GREATER_THAN_OR_EQUAL"
                        | "LESS_THAN"
                        | "LESS_THAN_OR_EQUAL";
                        value?: string;
                        valueType?: "doubleValue"
                        | "int64Value";
                    }[];
                };
                filterExpressionType?: "andGroup"
                | "orGroup";
            };
        };
        orderByUI?: {
            dimmensionOrderBy: {
                desc?: boolean;
                dimensionName?: string;
                orderType?: | "ALPHANUMERIC"
                | "CASE_INSENSITIVE_ALPHANUMERIC"
                | "NUMERIC"
                | "ORDER_TYPE_UNSPECIFIED";
            }[];
            metricOrderBy: {
                desc?: boolean;
                metricName?: string;
            }[];
        };
        returnPropertyQuota?: boolean;
    }
    | {
        dimensionFiltersUi?: {
            filterValues: {
                expressions?: string;
                listName?: | "other"
                | "ga:browser"
                | "ga:campaign"
                | "ga:city"
                | "ga:country"
                | "ga:date"
                | "ga:deviceCategory"
                | "ga:productName"
                | "ga:language"
                | "ga:pagePath"
                | "ga:sourceMedium";
                name?: string;
                operator?: | "BEGINS_WITH"
                | "ENDS_WITH"
                | "NUMERIC_EQUAL"
                | "EXACT"
                | "NUMERIC_GREATER_THAN"
                | "NUMERIC_LESS_THAN"
                | "PARTIAL"
                | "REGEXP";
            }[];
        };
        hideTotals?: boolean;
        hideValueRanges?: boolean;
        includeEmptyRows?: boolean;
        useResourceQuotas?: boolean;
    }
    | {
        activityTypes?: (
            | "ECOMMERCE"
            | "EVENT"
            | "GOAL"
            | "PAGEVIEW"
            | "SCREENVIEW"
        )[];
    }

Default: {}

Source§

readonly dateRange?:
    | "custom"
    | "today"
    | "last7days"
    | "last30days"
    | "yesterday"
    | "lastCalendarWeek"
    | "lastCalendarMonth"

Default: "last7days"

Source§

readonly dimensionsGA4?: {
    dimensionValues: {
        listName?:
            | "other"
            | "date"
            | "language"
            | "browser"
            | "campaignName"
            | "city"
            | "country"
            | "deviceCategory"
            | "itemName"
            | "pageLocation"
            | "sourceMedium";
        name?: string;
    }[];
}

Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. Default: {"dimensionValues":[{"listName":"date"}]} Type options: {"multipleValues":true}

Source§

readonly dimensionsUA?: {
    dimensionValues: {
        listName?:
            | "other"
            | "ga:browser"
            | "ga:campaign"
            | "ga:city"
            | "ga:country"
            | "ga:date"
            | "ga:deviceCategory"
            | "ga:productName"
            | "ga:language"
            | "ga:pagePath"
            | "ga:sourceMedium";
        name?: string;
    }[];
}

Dimensions are attributes of your data. For example, the dimension ga:city indicates the city, for example, "Paris" or "New York", from which a session originates. Default: {"dimensionValues":[{"listName":"ga:date"}]} Type options: {"multipleValues":true}

Source§

readonly endDate?: string

Default: "2025-08-31T00:00:00.000+00:00"

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":1000}

Source§

readonly metricsGA4?: {
    metricValues: {
        expression?: string;
        invisible?: boolean;
        listName?:
            | "custom"
            | "other"
            | "active1DayUsers"
            | "active28DayUsers"
            | "active7DayUsers"
            | "checkouts"
            | "eventCount"
            | "screenPageViews"
            | "userEngagementDuration"
            | "sessions"
            | "sessionsPerUser"
            | "totalUsers";
        name?: string;
    }[];
}

The quantitative measurements of a report. For example, the metric eventCount is the total number of events. Requests are allowed up to 10 metrics. Default: {"metricValues":[{"listName":"totalUsers"}]} Type options: {"multipleValues":true}

Source§

readonly metricsUA?: {
    metricValues: {
        expression?: string;
        formattingType?:
            | "CURRENCY"
            | "FLOAT"
            | "INTEGER"
            | "PERCENT"
            | "TIME";
        listName?: | "custom"
        | "other"
        | "ga:productCheckouts"
        | "ga:totalEvents"
        | "ga:pageviews"
        | "ga:sessionDuration"
        | "ga:sessions"
        | "ga:sessionsPerUser"
        | "ga:users";
        name?: string;
    }[];
}

Metrics in the request Default: {"metricValues":[{"listName":"ga:users"}]} Type options: {"multipleValues":true}

Source§

readonly operation?: "get" | "search"

Default: "get"

Source§

readonly propertyId?: { mode: "id" | "list" | "url"; value: string }

The Property of Google Analytics Default: {"mode":"list","value":""}

Source§

readonly propertyType?: "ga4" | "universal"

Google Analytics 4 is the latest version. Universal Analytics is an older version that is not fully functional after the end of June 2023. Default: "ga4"

Source§

readonly resource?: "report" | "userActivity"

Default: "report"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

Source§

readonly startDate?: string

Default: "2025-08-24T00:00:00.000+00:00"

Source§

readonly userId?: string

ID of a user

Source§

readonly viewId?: string | { mode: "id" | "list" | "url"; value: string }

The View of Google Analytics Default: {"mode":"list","value":""}