kendralabs/google-analytics repository overview

⁠ Google Analytics flowground Connector

⁠Description

A generated flowground connector for the Google Analytics API (version v3).

Generated from: https://api.apis.guru/v2/specs/googleapis.com/analytics/v3/swagger.json⁠
Generated at: 2019-05-23T12:12:56+03:00

⁠API Description

Views and manages your Google Analytics data.

⁠Authorization

Supported authorization schemes:

• OAuth2

For OAuth 2.0 you need to specify OAuth Client credentials as environment variables in the connector repository:

• OAUTH_CLIENT_ID - your OAuth client id
• OAUTH_CLIENT_SECRET - your OAuth client secret

⁠Actions

⁠Returns Analytics data for a view (profile).

Tags: data

⁠Input Parameters

• dimensions - optional - A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
• end-date - required - End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.
• filters - optional - A comma-separated list of dimension or metric filters to be applied to Analytics data.
• ids - required - Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
• include-empty-rows - optional - The response will include empty rows if this parameter is set to true, the default is true
• max-results - optional - The maximum number of entries to include in this feed.
• metrics - required - A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.
• output - optional - The selected format for the response. Default format is JSON. Possible values: dataTable, json.
• samplingLevel - optional - The desired sampling level. Possible values: DEFAULT, FASTER, HIGHER_PRECISION.
• segment - optional - An Analytics segment to be applied to data.
• sort - optional - A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
• start-date - required - Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
• start-index - optional - An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

⁠Returns Analytics Multi-Channel Funnels data for a view (profile).

Tags: data

⁠Input Parameters

• dimensions - optional - A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
• end-date - required - End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
• filters - optional - A comma-separated list of dimension or metric filters to be applied to the Analytics data.
• ids - required - Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
• max-results - optional - The maximum number of entries to include in this feed.
• metrics - required - A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.
• samplingLevel - optional - The desired sampling level. Possible values: DEFAULT, FASTER, HIGHER_PRECISION.
• sort - optional - A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
• start-date - required - Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
• start-index - optional - An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

⁠Returns real time data for a view (profile).

Tags: data

⁠Input Parameters

• dimensions - optional - A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.
• filters - optional - A comma-separated list of dimension or metric filters to be applied to real time data.
• ids - required - Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
• max-results - optional - The maximum number of entries to include in this feed.
• metrics - required - A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.
• sort - optional - A comma-separated list of dimensions or metrics that determine the sort order for real time data.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.

Tags: management

⁠Input Parameters

• max-results - optional - The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.
• start-index - optional - An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Lists all accounts to which the user has access.

Tags: management

⁠Input Parameters

• max-results - optional - The maximum number of accounts to include in this response.
• start-index - optional - An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Lists account-user links for a given account.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to retrieve the user links for.
• max-results - optional - The maximum number of account-user links to include in this response.
• start-index - optional - An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Adds a new user to the given account.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to create the user link for.
• fields - optional - Selector specifying which fields to include in a partial response.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Removes a user from the given account.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to delete the user link for.
• linkId - required - Link ID to delete the user link for.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Updates permissions for an existing user on the given account.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to update the account-user link for.
• linkId - required - Link ID to update the account-user link for.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Lists all filters for an account

Tags: management

⁠Input Parameters

• accountId - required - Account ID to retrieve filters for.
• max-results - optional - The maximum number of filters to include in this response.
• start-index - optional - An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Create a new filter.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to create filter for.
• fields - optional - Selector specifying which fields to include in a partial response.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Delete a filter.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to delete the filter for.
• filterId - required - ID of the filter to be deleted.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Returns a filters to which the user has access.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to retrieve filters for.
• filterId - required - Filter ID to retrieve filters for.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Updates an existing filter. This method supports patch semantics.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to which the filter belongs.
• filterId - required - ID of the filter to be updated.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Updates an existing filter.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to which the filter belongs.
• filterId - required - ID of the filter to be updated.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Lists web properties to which the user has access.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
• max-results - optional - The maximum number of web properties to include in this response.
• start-index - optional - An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to create the web property for.
• fields - optional - Selector specifying which fields to include in a partial response.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Gets a web property to which the user has access.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to retrieve the web property for.
• webPropertyId - required - ID to retrieve the web property for.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Updates an existing web property. This method supports patch semantics.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to which the web property belongs
• webPropertyId - required - Web property ID
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Updates an existing web property.

Tags: management

⁠Input Parameters

• accountId - required - Account ID to which the web property belongs
• webPropertyId - required - Web property ID
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠List custom data sources to which the user has access.

Tags: management

⁠Input Parameters

• accountId - required - Account Id for the custom data sources to retrieve.
• max-results - optional - The maximum number of custom data sources to include in this response.
• start-index - optional - A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
• webPropertyId - required - Web property Id for the custom data sources to retrieve.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Delete data associated with a previous upload.

Tags: management

⁠Input Parameters

• accountId - required - Account Id for the uploads to be deleted.
• customDataSourceId - required - Custom data source Id for the uploads to be deleted.
• webPropertyId - required - Web property Id for the uploads to be deleted.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠List uploads to which the user has access.

Tags: management

⁠Input Parameters

• accountId - required - Account Id for the uploads to retrieve.
• customDataSourceId - required - Custom data source Id for uploads to retrieve.
• max-results - optional - The maximum number of uploads to include in this response.
• start-index - optional - A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
• webPropertyId - required - Web property Id for the uploads to retrieve.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Upload data for a custom data source.

Tags: management

⁠Input Parameters

• accountId - required - Account Id associated with the upload.
• customDataSourceId - required - Custom data source Id to which the data being uploaded belongs.
• webPropertyId - required - Web property UA-string associated with the upload.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠List uploads to which the user has access.

Tags: management

⁠Input Parameters

• accountId - required - Account Id for the upload to retrieve.
• customDataSourceId - required - Custom data source Id for upload to retrieve.
• uploadId - required - Upload Id to retrieve.
• webPropertyId - required - Web property Id for the upload to retrieve.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Lists custom dimensions to which the user has access.

Tags: management

⁠Input Parameters

• accountId - required - Account ID for the custom dimensions to retrieve.
• max-results - optional - The maximum number of custom dimensions to include in this response.
• start-index - optional - An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
• webPropertyId - required - Web property ID for the custom dimensions to retrieve.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Create a new custom dimension.

Tags: management

⁠Input Parameters

• accountId - required - Account ID for the custom dimension to create.
• webPropertyId - required - Web property ID for the custom dimension to create.
• key - optional - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Get a custom dimension to which the user has access.

Tags: management

⁠Input Parameters

• accountId - required - Account ID for the custom dimension to retrieve.
• customDimensionId - required - The ID of the custom dimension to retrieve.
• webPropertyId - required - Web property ID for the custom dimension to retrieve.
• oauth_token - optional - OAuth 2.0 token for the current user.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Updates an existing custom dimension. This method supports patch semantics.

Tags: management

⁠Input Parameters

• accountId - required - Account ID for the custom dimension to update.
• customDimensionId - required - Custom dimension ID for the custom dimension to update.
• ignoreCustomDataSourceLinks - optional - Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
• webPropertyId - required - Web property ID for the custom dimension to update.
• prettyPrint - optional - Returns response with indentations and line breaks.
• quotaUser - optional - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• userIp - optional - Deprecated. Please use quotaUser instead.

⁠Updates an existing custom dimension.

Tags: management

⁠Input Parameters

• accountId - required - Account