QuerySail: Google Analytics

Use this when the user asks what changed between two periods, why traffic or conversions went up or down, or which channels, sources, pages or countries gained or lost. Compares metrics for one property between a current period and the previous period (default), the same weekdays a year earlier, or custom dates, in one Google request. Returns each metric's totals with absolute and percent change and, with a dimension, the top gainers and losers ranked by change in one metric. With no dates the current period is the last 28 days ending yesterday. Filters apply to both periods. Changes are observed differences and do not identify causes. Read-only.

Use this to find the exact API names of dimensions and metrics a property can report on, including its custom dimensions, custom metrics and key events, before calling run_report. Filter by kind, a search term (matched against the API name, display name and category) or custom definitions only. Read-only.

Use this when the user asks which Google Analytics sites or apps they can access, or to find the exact property_id for one. Returns Google Analytics 4 properties with their property ID (like 'properties/123456789'), display name and Analytics account, and which connected Google accounts can see each. The same property is listed once even if several connected Google accounts can see it. Universal Analytics properties are not included. Read-only. Does not change anything in Google Analytics.

Use this when the user asks what is happening on their site or app right now: active users in the last 30 minutes, optionally by country, city, device, platform, page or screen ('unifiedScreenName') or event name. Default metric activeUsers; eventCount, screenPageViews and keyEvents are also available. Standard properties cover the last 30 minutes, GA4 360 properties 60. Realtime figures are preliminary and never cached. Read-only.

Use this to retrieve Google Analytics 4 data for one property: users, sessions, views, engagement, events, key events, revenue and any other metric, optionally broken down by dimensions such as date, channel, source/medium, landing page, page path, country, device or event name, and narrowed with filters (for example sessions from Organic Search to pages starting with '/blog/'). With no metrics it reports activeUsers, sessions and screenPageViews; with no dates it covers the last 28 days ending yesterday. Dates are in the property's time zone. Returns totals and up to 100 rows per call (default 20); page through with the returned cursor. Rates such as engagementRate are fractions. Google may withhold small values (thresholding) or sample large reports; the result says so. Figures are observed values and do not identify causes. Use list_fields to find custom dimension and metric names. Read-only.