Google Analytics

Get a summary of Google Analytics reports for a specific campaign.

Available methods

    • GET /reports/{campaign_id}/google-analytics Get Google Analytics reports for a campaign
      GET /reports/{campaign_id}/google-analytics/{profile_id} Get a specific Google Analytics View report

      Get Google Analytics reports for a campaign

      GET /reports/{campaign_id}/google-analytics

      Get information about any Google Analytics reporting for a specific campaign.

      Path parameters

      campaign_id The unique id for the campaign.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      analytics Type: Array Title: Sent To Read only: false An array of objects, each representing a Google Analytics view for the campaign.
      Show properties
      analytics_profileId Type: String Title: Profile ID Read only: true The Google Analytics View ID.
      analytics_webPropertyId Type: String Title: Property ID Read only: true The Google Analytics Web Property ID.
      analytics_accountId Type: String Title: Property ID Read only: true The Google Analytics Account ID.
      analytics_profileName Type: String Title: Property ID Read only: true The Google Analytics Profile Name.
      analytics_title Type: String Title: Property ID Read only: true The Google Analytics Title.
      campaign_id Type: String Title: Campaign ID Read only: false The unique id for the campaign.
      visits Type: Integer Title: Visits Read only: false The number of visits generated by the campaign.
      page_views Type: Integer Title: Pages Read only: false The number of page views generated by the campaign.
      new_visits Type: Integer Title: New Visits Read only: false New visitors to your site generated by the campaign.
      bounces Type: Integer Title: Bounces Read only: false Visitors who ‘bounced’ (in the Google Analytics definition) from the site.
      time_on_site Type: Number Title: Time on Site Read only: false The total amount of time visitors from the campaign spent on the site.
      goal_conversions Type: Integer Title: Goal Conversions Read only: false The number of Google Analytics goal conversions.
      goal_value Type: Number Title: Goal Value Read only: false The value of Google Analytics goal conversions in dollars.
      revenue Type: Number Title: Revenue Read only: false Revenue generated by the campaign.
      transactions Type: Integer Title: Transactions Read only: false The number of transactions tracked by Google.
      ecomm_conversions Type: Integer Title: E-commerce Conversions Read only: false The number of e-commerce conversions tracked by Google.
      goals Type: Array Title: Goals Read only: false A summary of Goals as defined in Google Analytics.
      Show properties
      name Type: String Title: Goal Name Read only: false The name of a Google Analytics goal.
      conversions Type: Integer Title: Conversions Read only: false The number of conversions for a single Google Analytics goal.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      campaign_id Type: String Title: Campaign ID Read only: false The id for the campaign.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Get a specific Google Analytics View report

      GET /reports/{campaign_id}/google-analytics/{profile_id}

      Get information about a specific Google Analytics report for a campaign.

      Path parameters

      campaign_id The unique id for the campaign.
      profile_id The Google Analytics View ID.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      analytics_profileId Type: String Title: Profile ID Read only: true The Google Analytics View ID.
      analytics_webPropertyId Type: String Title: Property ID Read only: true The Google Analytics Web Property ID.
      analytics_accountId Type: String Title: Property ID Read only: true The Google Analytics Account ID.
      analytics_profileName Type: String Title: Property ID Read only: true The Google Analytics Profile Name.
      analytics_title Type: String Title: Property ID Read only: true The Google Analytics Title.
      campaign_id Type: String Title: Campaign ID Read only: false The unique id for the campaign.
      visits Type: Integer Title: Visits Read only: false The number of visits generated by the campaign.
      page_views Type: Integer Title: Pages Read only: false The number of page views generated by the campaign.
      new_visits Type: Integer Title: New Visits Read only: false New visitors to your site generated by the campaign.
      bounces Type: Integer Title: Bounces Read only: false Visitors who ‘bounced’ (in the Google Analytics definition) from the site.
      time_on_site Type: Number Title: Time on Site Read only: false The total amount of time visitors from the campaign spent on the site.
      goal_conversions Type: Integer Title: Goal Conversions Read only: false The number of Google Analytics goal conversions.
      goal_value Type: Number Title: Goal Value Read only: false The value of Google Analytics goal conversions in dollars.
      revenue Type: Number Title: Revenue Read only: false Revenue generated by the campaign.
      transactions Type: Integer Title: Transactions Read only: false The number of transactions tracked by Google.
      ecomm_conversions Type: Integer Title: E-commerce Conversions Read only: false The number of e-commerce conversions tracked by Google.
      goals Type: Array Title: Goals Read only: false A summary of Goals as defined in Google Analytics.
      Show properties
      name Type: String Title: Goal Name Read only: false The name of a Google Analytics goal.
      conversions Type: Integer Title: Conversions Read only: false The number of conversions for a single Google Analytics goal.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.