Google Analytics · Schema

Profile

JSON template for an Analytics view (profile).

AnalyticsDataGoogleMetricsReportingWeb AnalyticsMachine LearningAttribution

Properties

Name Type Description
accountId string Account ID to which this view (profile) belongs.
botFilteringEnabled boolean Indicates whether bot filtering is enabled for this view (profile).
childLink object Child link for this view (profile). Points to the list of goals for this view (profile).
created string Time this view (profile) was created.
currency string The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VN
defaultPage string Default page for this view (profile).
eCommerceTracking boolean Indicates whether ecommerce tracking is enabled for this view (profile).
enhancedECommerceTracking boolean Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
excludeQueryParameters string The query parameters that are excluded from this view (profile).
id string View (Profile) ID.
internalWebPropertyId string Internal ID for the web property to which this view (profile) belongs.
kind string Resource type for Analytics view (profile).
name string Name of this view (profile).
parentLink object Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
permissions object Permissions the user has for this view (profile).
selfLink string Link for this view (profile).
siteSearchCategoryParameters string Site search category parameters for this view (profile).
siteSearchQueryParameters string The site search query parameters for this view (profile).
starred boolean Indicates whether this view (profile) is starred or not.
stripSiteSearchCategoryParameters boolean Whether or not Analytics will strip search category parameters from the URLs in your reports.
stripSiteSearchQueryParameters boolean Whether or not Analytics will strip search query parameters from the URLs in your reports.
timezone string Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
type string View (Profile) type. Supported types: WEB or APP.
updated string Time this view (profile) was last modified.
webPropertyId string Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
websiteUrl string Website URL for this view (profile).
View JSON Schema on GitHub

JSON Schema

google-analytics-profile-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Profile",
  "title": "Profile",
  "description": "JSON template for an Analytics view (profile).",
  "properties": {
    "accountId": {
      "description": "Account ID to which this view (profile) belongs.",
      "type": "string"
    },
    "botFilteringEnabled": {
      "description": "Indicates whether bot filtering is enabled for this view (profile).",
      "type": "boolean"
    },
    "childLink": {
      "description": "Child link for this view (profile). Points to the list of goals for this view (profile).",
      "properties": {
        "href": {
          "description": "Link to the list of goals for this view (profile).",
          "type": "string"
        },
        "type": {
          "default": "analytics#goals",
          "description": "Value is \"analytics#goals\".",
          "type": "string"
        }
      },
      "type": "object"
    },
    "created": {
      "description": "Time this view (profile) was created.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "currency": {
      "description": "The currency type associated with this view (profile), defaults to USD. The supported values are:\nUSD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL",
      "type": "string"
    },
    "defaultPage": {
      "description": "Default page for this view (profile).",
      "type": "string"
    },
    "eCommerceTracking": {
      "description": "Indicates whether ecommerce tracking is enabled for this view (profile).",
      "type": "boolean"
    },
    "enhancedECommerceTracking": {
      "description": "Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.",
      "type": "boolean"
    },
    "excludeQueryParameters": {
      "description": "The query parameters that are excluded from this view (profile).",
      "type": "string"
    },
    "id": {
      "description": "View (Profile) ID.",
      "type": "string"
    },
    "internalWebPropertyId": {
      "description": "Internal ID for the web property to which this view (profile) belongs.",
      "readOnly": true,
      "type": "string"
    },
    "kind": {
      "default": "analytics#profile",
      "description": "Resource type for Analytics view (profile).",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "Name of this view (profile).",
      "type": "string"
    },
    "parentLink": {
      "description": "Parent link for this view (profile). Points to the web property to which this view (profile) belongs.",
      "properties": {
        "href": {
          "description": "Link to the web property to which this view (profile) belongs.",
          "type": "string"
        },
        "type": {
          "default": "analytics#webproperty",
          "description": "Value is \"analytics#webproperty\".",
          "type": "string"
        }
      },
      "type": "object"
    },
    "permissions": {
      "description": "Permissions the user has for this view (profile).",
      "properties": {
        "effective": {
          "description": "All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.",
          "items": {
            "type": "string"
          },
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object"
    },
    "selfLink": {
      "description": "Link for this view (profile).",
      "readOnly": true,
      "type": "string"
    },
    "siteSearchCategoryParameters": {
      "description": "Site search category parameters for this view (profile).",
      "type": "string"
    },
    "siteSearchQueryParameters": {
      "description": "The site search query parameters for this view (profile).",
      "type": "string"
    },
    "starred": {
      "description": "Indicates whether this view (profile) is starred or not.",
      "type": "boolean"
    },
    "stripSiteSearchCategoryParameters": {
      "description": "Whether or not Analytics will strip search category parameters from the URLs in your reports.",
      "type": "boolean"
    },
    "stripSiteSearchQueryParameters": {
      "description": "Whether or not Analytics will strip search query parameters from the URLs in your reports.",
      "type": "boolean"
    },
    "timezone": {
      "description": "Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.",
      "type": "string"
    },
    "type": {
      "description": "View (Profile) type. Supported types: WEB or APP.",
      "type": "string"
    },
    "updated": {
      "description": "Time this view (profile) was last modified.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "webPropertyId": {
      "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.",
      "readOnly": true,
      "type": "string"
    },
    "websiteUrl": {
      "description": "Website URL for this view (profile).",
      "type": "string"
    }
  },
  "type": "object"
}