Default request referring to version v3 of the Google Analytics API. This contains the host and root path used as a starting point for constructing service requests.

Manage Google Analytics Account users by email address

Create a new Google Analytics account along with its default property and view

View Google Analytics user permissions

View and manage your Google Analytics data

View your Google Analytics data

Edit Google Analytics management entities

An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report.

See: unSampledReports smart constructor.

Creates a value of UnSampledReports with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• usrNextLink
• usrItemsPerPage
• usrKind
• usrUsername
• usrItems
• usrTotalResults
• usrStartIndex
• usrPreviousLink

Link to next page for this unsampled report collection.

The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Collection type.

Email ID of the authenticated user

A list of unsampled reports.

The total number of results for the query, regardless of the number of resources in the result.

The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.

Link to previous page for this unsampled report collection.

Creates a value of GoalURLDestinationDetailsStepsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• guddsiURL
• guddsiName
• guddsiNumber

URL for this step.

Step name.

Step number.

Analytics data request query parameters.

See: gaDataQuery smart constructor.

Creates a value of GaDataQuery with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdqMetrics
• gdqSamplingLevel
• gdqFilters
• gdqIds
• gdqEndDate
• gdqSort
• gdqDimensions
• gdqStartIndex
• gdqMaxResults
• gdqSegment
• gdqStartDate

List of analytics metrics.

Desired sampling level

Comma-separated list of dimension or metric filters.

Unique table ID.

End date.

List of dimensions or metrics based on which Analytics data is sorted.

List of analytics dimensions.

Start index.

Maximum results per page.

Analytics advanced segment.

Start date.

Creates a value of GaDataDataTableRowsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gddtriC

JSON template for Analytics unsampled report resource.

See: unSampledReport smart constructor.

Creates a value of UnSampledReport with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uDownloadType
• uStatus
• uMetrics
• uDriveDownloadDetails
• uWebPropertyId
• uKind
• uCreated
• uFilters
• uProFileId
• uEndDate
• uSelfLink
• uAccountId
• uId
• uUpdated
• uTitle
• uDimensions
• uSegment
• uCloudStorageDownloadDetails
• uStartDate

The type of download you need to use for the report data file.

Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.

The metrics for the unsampled report.

Download details for a file stored in Google Drive.

Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.

Resource type for an Analytics unsampled report.

Time this unsampled report was created.

The filters for the unsampled report.

View (Profile) ID to which this unsampled report belongs.

The end date for the unsampled report.

Link for this unsampled report.

Account ID to which this unsampled report belongs.

Unsampled report ID.

Time this unsampled report was last modified.

Title of the unsampled report.

The dimensions for the unsampled report.

The segment for the unsampled report.

Download details for a file stored in Google Cloud Storage.

The start date for the unsampled report.

Creates a value of McfDataColumnHeadersItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mdchiColumnType
• mdchiName
• mdchiDataType

Column Type. Either DIMENSION or METRIC.

Column name.

Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

See: gaDataTotalsForAllResults smart constructor.

Creates a value of GaDataTotalsForAllResults with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdtfarAddtional

Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.

Parent link for this view (profile). Points to the web property to which this view (profile) belongs.

See: proFileParentLink smart constructor.

Creates a value of ProFileParentLink with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pfplHref
• pfplType

Link to the web property to which this view (profile) belongs.

Value is "analytics#webproperty".

Creates a value of GaDataDataTableRowsItemCItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gddtriciV

Permissions the user has for this entity.

See: entityUserLinkPermissions smart constructor.

Creates a value of EntityUserLinkPermissions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eulpLocal
• eulpEffective

Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.

Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.

Information for the view (profile), for which the real time data was requested.

See: realtimeDataProFileInfo smart constructor.

Creates a value of RealtimeDataProFileInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdpfiWebPropertyId
• rdpfiProFileId
• rdpfiProFileName
• rdpfiAccountId
• rdpfiInternalWebPropertyId
• rdpfiTableId

Web Property ID to which this view (profile) belongs.

View (Profile) ID.

View (Profile) name.

Account ID to which this view (profile) belongs.

Internal ID for the web property to which this view (profile) belongs.

Table ID for view (profile).

Creates a value of McfDataRowsItemItemConversionPathValueItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mdriicpviInteractionType
• mdriicpviNodeValue

Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.

Node value of an interaction on conversion path. Such as source, medium etc.

JSON template for an Analytics filter expression.

See: filterExpression smart constructor.

Creates a value of FilterExpression with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• feFieldIndex
• feField
• feKind
• feMatchType
• feCaseSensitive
• feExpressionValue

The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.

Field to filter. Possible values: - Content and Traffic - PAGE_REQUEST_URI, - PAGE_HOSTNAME, - PAGE_TITLE, - REFERRAL, - COST_DATA_URI (Campaign target URL), - HIT_TYPE, - INTERNAL_SEARCH_TERM, - INTERNAL_SEARCH_TYPE, - SOURCE_PROPERTY_TRACKING_ID, - Campaign or AdGroup - CAMPAIGN_SOURCE, - CAMPAIGN_MEDIUM, - CAMPAIGN_NAME, - CAMPAIGN_AD_GROUP, - CAMPAIGN_TERM, - CAMPAIGN_CONTENT, - CAMPAIGN_CODE, - CAMPAIGN_REFERRAL_PATH, - E-Commerce - TRANSACTION_COUNTRY, - TRANSACTION_REGION, - TRANSACTION_CITY, - TRANSACTION_AFFILIATION (Store or order location), - ITEM_NAME, - ITEM_CODE, - ITEM_VARIATION, - TRANSACTION_ID, - TRANSACTION_CURRENCY_CODE, - PRODUCT_ACTION_TYPE, - Audience/Users - BROWSER, - BROWSER_VERSION, - BROWSER_SIZE, - PLATFORM, - PLATFORM_VERSION, - LANGUAGE, - SCREEN_RESOLUTION, - SCREEN_COLORS, - JAVA_ENABLED (Boolean Field), - FLASH_VERSION, - GEO_SPEED (Connection speed), - VISITOR_TYPE, - GEO_ORGANIZATION (ISP organization), - GEO_DOMAIN, - GEO_IP_ADDRESS, - GEO_IP_VERSION, - Location - GEO_COUNTRY, - GEO_REGION, - GEO_CITY, - Event - EVENT_CATEGORY, - EVENT_ACTION, - EVENT_LABEL, - Other - CUSTOM_FIELD_1, - CUSTOM_FIELD_2, - USER_DEFINED_VALUE, - Application - APP_ID, - APP_INSTALLER_ID, - APP_NAME, - APP_VERSION, - SCREEN, - IS_APP (Boolean Field), - IS_FATAL_EXCEPTION (Boolean Field), - EXCEPTION_DESCRIPTION, - Mobile device - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), - DEVICE_CATEGORY, - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), - MOBILE_HAS_NFC_SUPPORT (Boolean Field), - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), - MOBILE_BRAND_NAME, - MOBILE_MODEL_NAME, - MOBILE_MARKETING_NAME, - MOBILE_POINTING_METHOD, - Social - SOCIAL_NETWORK, - SOCIAL_ACTION, - SOCIAL_ACTION_TARGET, - Custom dimension - CUSTOM_DIMENSION (See accompanying field index),

Kind value for filter expression

Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.

Determines if the filter is case sensitive.

Filter expression value

JSON template for a linked view (profile).

See: proFileRef smart constructor.

Creates a value of ProFileRef with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pfrWebPropertyId
• pfrKind
• pfrHref
• pfrAccountId
• pfrName
• pfrInternalWebPropertyId
• pfrId

Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.

Analytics view (profile) reference.

Link for this view (profile).

Account ID to which this view (profile) belongs.

Name of this view (profile).

Internal ID for the web property to which this view (profile) belongs.

View (Profile) ID.

An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.

See: accounts smart constructor.

Creates a value of Accounts with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aNextLink
• aItemsPerPage
• aKind
• aUsername
• aItems
• aTotalResults
• aStartIndex
• aPreviousLink

Next link for this account collection.

The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Collection type.

Email ID of the authenticated user

A list of accounts.

The total number of results for the query, regardless of the number of results in the response.

The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.

Previous link for this account collection.

An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.

See: experiments smart constructor.

Creates a value of Experiments with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eNextLink
• eItemsPerPage
• eKind
• eUsername
• eItems
• eTotalResults
• eStartIndex
• ePreviousLink

Link to next page for this experiment collection.

The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Collection type.

Email ID of the authenticated user

A list of experiments.

The total number of results for the query, regardless of the number of resources in the result.

The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.

Link to previous page for this experiment collection.

Parent link for an experiment. Points to the view (profile) to which this experiment belongs.

See: experimentParentLink smart constructor.

Creates a value of ExperimentParentLink with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eplHref
• eplType

Link to the view (profile) to which this experiment belongs. This field is read-only.

Value is "analytics#profile". This field is read-only.

Download details for a file stored in Google Drive.

See: unSampledReportDriveDownloadDetails smart constructor.

Creates a value of UnSampledReportDriveDownloadDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• usrdddDocumentId

Id of the document/file containing the report data.

Information for the view (profile), for which the Analytics data was requested.

See: mcfDataProFileInfo smart constructor.

Creates a value of McfDataProFileInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mdpfiWebPropertyId
• mdpfiProFileId
• mdpfiProFileName
• mdpfiAccountId
• mdpfiInternalWebPropertyId
• mdpfiTableId

Web Property ID to which this view (profile) belongs.

View (Profile) ID.

View (Profile) name.

Account ID to which this view (profile) belongs.

Internal ID for the web property to which this view (profile) belongs.

Table ID for view (profile).

Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.

See: customDataSources smart constructor.

Creates a value of CustomDataSources with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cdsNextLink
• cdsItemsPerPage
• cdsKind
• cdsUsername
• cdsItems
• cdsTotalResults
• cdsStartIndex
• cdsPreviousLink

Link to next page for this custom data source collection.

The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Collection type.

Email ID of the authenticated user

Collection of custom data sources.

The total number of results for the query, regardless of the number of results in the response.

The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.

Link to previous page for this custom data source collection.

Child link for this web property. Points to the list of views (profiles) for this web property.

See: webPropertyChildLink smart constructor.

Creates a value of WebPropertyChildLink with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• wpclHref
• wpclType

Link to the list of views (profiles) for this web property.

Type of the parent link. Its value is "analytics#profiles".

The desired sampling level.

Multi-Channel Funnels data for a given view (profile).

See: mcfData smart constructor.

Creates a value of McfData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mdNextLink
• mdSampleSpace
• mdItemsPerPage
• mdProFileInfo
• mdKind
• mdSampleSize
• mdRows
• mdSelfLink
• mdQuery
• mdColumnHeaders
• mdId
• mdTotalResults
• mdContainsSampledData
• mdTotalsForAllResults
• mdPreviousLink

Link to next page for this Analytics data query.

Total size of the sample space from which the samples were selected.

The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Information for the view (profile), for which the Analytics data was requested.

Resource type.

The number of samples used to calculate the result.

Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

Link to this page.

Analytics data request query parameters.

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

Unique ID for this data response.

The total number of rows for the query, regardless of the number of rows in the response.

Determines if the Analytics data contains sampled data.

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

Link to previous page for this Analytics data query.

JSON template for a user reference.

See: userRef smart constructor.

Creates a value of UserRef with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• urEmail
• urKind
• urId

Email ID of this user.

User ID.

Details for the goal of the type VISIT_NUM_PAGES.

See: goalVisitNumPagesDetails smart constructor.

Creates a value of GoalVisitNumPagesDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gvnpdComparisonValue
• gvnpdComparisonType

Value used for this comparison.

Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.