FireDAC Components for Google Analytics

Build 23.0.8804

Events

Retrieves Event data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses EventLabel instead of the default EventCategory dimension:

SELECT EventLabel, TotalEvents, UniqueEvents, EventValue, SessionsWithEvent, AvgEventValue, EventsPerSessionWithEvent FROM Events
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. This query will return all Events with less than or equal to 200 total events:
SELECT EventLabel, TotalEvents FROM Events WHERE TotalEvents <= 200
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM Events WHERE StartDate = '39daysAgo' AND EndDate = 'Today'
The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT EventCategory, TotalEvents, UniqueEvents, EventValue, SessionsWithEvent, AvgEventValue, EventsPerSessionWithEvent FROM Events

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Date Date True The date of the session formatted as YYYYMMDD.
Year Integer True The year of the session. A four-digit year from 2005 to the current year.
Month Integer True The month of the session. A two digit integer from 01 to 12.
Week Integer True The week of the session. A two-digit number from 01 to 53. Each week starts on Sunday.
Day Integer True The day of the month. A two-digit number from 01 to 31.
Hour Integer True A two-digit hour of the day ranging from 00-23 in the timezone configured for the account. This value is also corrected for daylight savings time.
EventCategory String True True The category of the event.
EventAction String True The action of the event.
EventLabel String True The label of the event.
TotalEvents Integer False True The total number of events for the profile, across all categories.
UniqueEvents Integer False True The total number of unique events for the profile, across all categories.
EventValue Long False True The total value of events for the profile.
SessionsWithEvent Integer False True The total number of sessions with events.
AvgEventValue Double False True The average value of an event.
EventsPerSessionWithEvent Double False True The average number of events per session with event.
StartDate String Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).
EndDate String End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).
Dimensions String A comma-separated list of dimensions to retrieve in addition to the columns defined in the schema. Set to empty string to retrieve no dimensions.
Metrics String A comma-separated list of metrics to retrieve in addition to the columns defined in the schema.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String A comma-separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String A comma-separated list of samples space sizes counts when the response data is sampled.
Profile Integer The Profile Id or website URL to retrieve data from.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8804