GoogleApi.AnalyticsData.V1alpha.Api.V1alpha (google_api_analytics_data v0.7.0) View Source

API calls for all endpoints tagged V1alpha.

Link to this section Summary

Functions

Returns multiple pivot reports in a batch. All reports must be for the same Entity.

Returns multiple reports in a batch. All reports must be for the same Entity.

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.

Link to this section Functions

Link to this function

analyticsdata_batch_run_pivot_reports(connection, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsdata_batch_run_pivot_reports(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AnalyticsData.V1alpha.Model.BatchRunPivotReportsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns multiple pivot reports in a batch. All reports must be for the same Entity.

Parameters

  • connection (type: GoogleApi.AnalyticsData.V1alpha.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AnalyticsData.V1alpha.Model.BatchRunPivotReportsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsData.V1alpha.Model.BatchRunPivotReportsResponse{}} on success
  • {:error, info} on failure
Link to this function

analyticsdata_batch_run_reports(connection, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsdata_batch_run_reports(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AnalyticsData.V1alpha.Model.BatchRunReportsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns multiple reports in a batch. All reports must be for the same Entity.

Parameters

  • connection (type: GoogleApi.AnalyticsData.V1alpha.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AnalyticsData.V1alpha.Model.BatchRunReportsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsData.V1alpha.Model.BatchRunReportsResponse{}} on success
  • {:error, info} on failure
Link to this function

analyticsdata_run_pivot_report(connection, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsdata_run_pivot_report(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AnalyticsData.V1alpha.Model.RunPivotReportResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

Parameters

  • connection (type: GoogleApi.AnalyticsData.V1alpha.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AnalyticsData.V1alpha.Model.RunPivotReportRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsData.V1alpha.Model.RunPivotReportResponse{}} on success
  • {:error, info} on failure
Link to this function

analyticsdata_run_report(connection, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsdata_run_report(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AnalyticsData.V1alpha.Model.RunReportResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.

Parameters

  • connection (type: GoogleApi.AnalyticsData.V1alpha.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AnalyticsData.V1alpha.Model.RunReportRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsData.V1alpha.Model.RunReportResponse{}} on success
  • {:error, info} on failure