{"note":"OpenAPI conversion -- returning structured metadata","name":"google-analytics","description":"Google Analytics API","version":"v3","base_url":"https://analytics.googleapis.com/analytics/v3","endpoints":88,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Google Analytics API\n@base https://analytics.googleapis.com/analytics/v3\n@version v3\n@auth OAuth2 | OAuth2\n@endpoints 88\n@hint download_for_search\n@toc data(3), management(81), metadata(1), provisioning(2), userDeletion(1)\n\n@group data\n@endpoint GET /data/ga\n@desc Returns Analytics data for a view (profile).\n@required {ids: str # Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID., start-date: str # 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., end-date: str # 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., metrics: str # A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.}\n@optional {dimensions: str # A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'., filters: str # A comma-separated list of dimension or metric filters to be applied to Analytics data., include-empty-rows: bool # The response will include empty rows if this parameter is set to true, the default is true, max-results: int # The maximum number of entries to include in this feed., output: str(dataTable/json) # The selected format for the response. Default format is JSON., samplingLevel: str(DEFAULT/FASTER/HIGHER_PRECISION) # The desired sampling level., segment: str # An Analytics segment to be applied to data., sort: str # A comma-separated list of dimensions or metrics that determine the sort order for Analytics data., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {columnHeaders: [map], containsSampledData: bool, dataLastRefreshed: str(int64), dataTable: map{cols: [map], rows: [map]}, id: str, itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, profileInfo: map{accountId: str, internalWebPropertyId: str, profileId: str, profileName: str, tableId: str, webPropertyId: str}, query: map{dimensions: str, end-date: str, filters: str, ids: str, max-results: int(int32), metrics: [str], samplingLevel: str, segment: str, sort: [str], start-date: str, start-index: int(int32)}, rows: [[str]], sampleSize: str(int64), sampleSpace: str(int64), selfLink: str, totalResults: int(int32), totalsForAllResults: map} # Successful response\n\n@endpoint GET /data/mcf\n@desc Returns Analytics Multi-Channel Funnels data for a view (profile).\n@required {ids: str # Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID., start-date: str # 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., end-date: str # 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., metrics: str # A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.}\n@optional {dimensions: str # A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'., filters: str # A comma-separated list of dimension or metric filters to be applied to the Analytics data., max-results: int # The maximum number of entries to include in this feed., samplingLevel: str(DEFAULT/FASTER/HIGHER_PRECISION) # The desired sampling level., sort: str # A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {columnHeaders: [map], containsSampledData: bool, id: str, itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, profileInfo: map{accountId: str, internalWebPropertyId: str, profileId: str, profileName: str, tableId: str, webPropertyId: str}, query: map{dimensions: str, end-date: str, filters: str, ids: str, max-results: int(int32), metrics: [str], samplingLevel: str, segment: str, sort: [str], start-date: str, start-index: int(int32)}, rows: [[map]], sampleSize: str(int64), sampleSpace: str(int64), selfLink: str, totalResults: int(int32), totalsForAllResults: map} # Successful response\n\n@endpoint GET /data/realtime\n@desc Returns real time data for a view (profile).\n@required {ids: str # Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID., metrics: str # A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.}\n@optional {dimensions: str # A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'., filters: str # A comma-separated list of dimension or metric filters to be applied to real time data., max-results: int # The maximum number of entries to include in this feed., sort: str # A comma-separated list of dimensions or metrics that determine the sort order for real time data.}\n@returns(200) {columnHeaders: [map], id: str, kind: str, profileInfo: map{accountId: str, internalWebPropertyId: str, profileId: str, profileName: str, tableId: str, webPropertyId: str}, query: map{dimensions: str, filters: str, ids: str, max-results: int(int32), metrics: [str], sort: [str]}, rows: [[str]], selfLink: str, totalResults: int(int32), totalsForAllResults: map} # Successful response\n\n@endgroup\n\n@group management\n@endpoint GET /management/accountSummaries\n@desc Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.\n@optional {max-results: int # The maximum number of account summaries to include in this response, where the largest acceptable value is 1000., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint GET /management/accounts\n@desc Lists all accounts to which the user has access.\n@optional {max-results: int # The maximum number of accounts to include in this response., start-index: int # An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/entityUserLinks\n@desc Lists account-user links for a given account.\n@required {accountId: str # Account ID to retrieve the user links for.}\n@optional {max-results: int # The maximum number of account-user links to include in this response., start-index: int # An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32)} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/entityUserLinks\n@desc Adds a new user to the given account.\n@required {accountId: str # Account ID to create the user link for.}\n@optional {entity: map{accountRef: map, profileRef: map, webPropertyRef: map} # Entity for this link. It can be an account, a web property, or a view (profile)., id: str # Entity user link ID, kind: str=analytics#entityUserLink # Resource type for entity user link., permissions: map{effective: [str], local: [str]} # Permissions the user has for this entity., selfLink: str # Self link for this resource., userRef: map{email: str, id: str, kind: str} # JSON template for a user reference.}\n@returns(200) {entity: map{accountRef: map{href: str, id: str, kind: str, name: str}, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, permissions: map{effective: [str], local: [str]}, selfLink: str, userRef: map{email: str, id: str, kind: str}} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/entityUserLinks/{linkId}\n@desc Removes a user from the given account.\n@required {accountId: str # Account ID to delete the user link for., linkId: str # Link ID to delete the user link for.}\n@returns(200) Successful response\n\n@endpoint PUT /management/accounts/{accountId}/entityUserLinks/{linkId}\n@desc Updates permissions for an existing user on the given account.\n@required {accountId: str # Account ID to update the account-user link for., linkId: str # Link ID to update the account-user link for.}\n@optional {entity: map{accountRef: map, profileRef: map, webPropertyRef: map} # Entity for this link. It can be an account, a web property, or a view (profile)., id: str # Entity user link ID, kind: str=analytics#entityUserLink # Resource type for entity user link., permissions: map{effective: [str], local: [str]} # Permissions the user has for this entity., selfLink: str # Self link for this resource., userRef: map{email: str, id: str, kind: str} # JSON template for a user reference.}\n@returns(200) {entity: map{accountRef: map{href: str, id: str, kind: str, name: str}, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, permissions: map{effective: [str], local: [str]}, selfLink: str, userRef: map{email: str, id: str, kind: str}} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/filters\n@desc Lists all filters for an account\n@required {accountId: str # Account ID to retrieve filters for.}\n@optional {max-results: int # The maximum number of filters to include in this response., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/filters\n@desc Create a new filter.\n@required {accountId: str # Account ID to create filter for.}\n@optional {accountId: str # Account ID to which this filter belongs., advancedDetails: map{caseSensitive: bool, extractA: str, extractB: str, fieldA: str, fieldAIndex: int(int32), fieldARequired: bool, fieldB: str, fieldBIndex: int(int32), fieldBRequired: bool, outputConstructor: str, outputToField: str, outputToFieldIndex: int(int32), overrideOutputField: bool} # Details for the filter of the type ADVANCED., created: str(date-time) # Time this filter was created., excludeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str} # JSON template for an Analytics filter expression., id: str # Filter ID., includeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str} # JSON template for an Analytics filter expression., kind: str=analytics#filter # Resource type for Analytics filter., lowercaseDetails: map{field: str, fieldIndex: int(int32)} # Details for the filter of the type LOWER., name: str # Name of this filter., parentLink: map{href: str, type: str} # Parent link for this filter. Points to the account to which this filter belongs., searchAndReplaceDetails: map{caseSensitive: bool, field: str, fieldIndex: int(int32), replaceString: str, searchString: str} # Details for the filter of the type SEARCH_AND_REPLACE., selfLink: str # Link for this filter., type: str # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED., updated: str(date-time) # Time this filter was last modified., uppercaseDetails: map{field: str, fieldIndex: int(int32)} # Details for the filter of the type UPPER.}\n@returns(200) {accountId: str, advancedDetails: map{caseSensitive: bool, extractA: str, extractB: str, fieldA: str, fieldAIndex: int(int32), fieldARequired: bool, fieldB: str, fieldBIndex: int(int32), fieldBRequired: bool, outputConstructor: str, outputToField: str, outputToFieldIndex: int(int32), overrideOutputField: bool}, created: str(date-time), excludeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, id: str, includeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, kind: str, lowercaseDetails: map{field: str, fieldIndex: int(int32)}, name: str, parentLink: map{href: str, type: str}, searchAndReplaceDetails: map{caseSensitive: bool, field: str, fieldIndex: int(int32), replaceString: str, searchString: str}, selfLink: str, type: str, updated: str(date-time), uppercaseDetails: map{field: str, fieldIndex: int(int32)}} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/filters/{filterId}\n@desc Delete a filter.\n@required {accountId: str # Account ID to delete the filter for., filterId: str # ID of the filter to be deleted.}\n@returns(200) {accountId: str, advancedDetails: map{caseSensitive: bool, extractA: str, extractB: str, fieldA: str, fieldAIndex: int(int32), fieldARequired: bool, fieldB: str, fieldBIndex: int(int32), fieldBRequired: bool, outputConstructor: str, outputToField: str, outputToFieldIndex: int(int32), overrideOutputField: bool}, created: str(date-time), excludeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, id: str, includeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, kind: str, lowercaseDetails: map{field: str, fieldIndex: int(int32)}, name: str, parentLink: map{href: str, type: str}, searchAndReplaceDetails: map{caseSensitive: bool, field: str, fieldIndex: int(int32), replaceString: str, searchString: str}, selfLink: str, type: str, updated: str(date-time), uppercaseDetails: map{field: str, fieldIndex: int(int32)}} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/filters/{filterId}\n@desc Returns filters to which the user has access.\n@required {accountId: str # Account ID to retrieve filters for., filterId: str # Filter ID to retrieve filters for.}\n@returns(200) {accountId: str, advancedDetails: map{caseSensitive: bool, extractA: str, extractB: str, fieldA: str, fieldAIndex: int(int32), fieldARequired: bool, fieldB: str, fieldBIndex: int(int32), fieldBRequired: bool, outputConstructor: str, outputToField: str, outputToFieldIndex: int(int32), overrideOutputField: bool}, created: str(date-time), excludeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, id: str, includeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, kind: str, lowercaseDetails: map{field: str, fieldIndex: int(int32)}, name: str, parentLink: map{href: str, type: str}, searchAndReplaceDetails: map{caseSensitive: bool, field: str, fieldIndex: int(int32), replaceString: str, searchString: str}, selfLink: str, type: str, updated: str(date-time), uppercaseDetails: map{field: str, fieldIndex: int(int32)}} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/filters/{filterId}\n@desc Updates an existing filter. This method supports patch semantics.\n@required {accountId: str # Account ID to which the filter belongs., filterId: str # ID of the filter to be updated.}\n@optional {accountId: str # Account ID to which this filter belongs., advancedDetails: map{caseSensitive: bool, extractA: str, extractB: str, fieldA: str, fieldAIndex: int(int32), fieldARequired: bool, fieldB: str, fieldBIndex: int(int32), fieldBRequired: bool, outputConstructor: str, outputToField: str, outputToFieldIndex: int(int32), overrideOutputField: bool} # Details for the filter of the type ADVANCED., created: str(date-time) # Time this filter was created., excludeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str} # JSON template for an Analytics filter expression., id: str # Filter ID., includeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str} # JSON template for an Analytics filter expression., kind: str=analytics#filter # Resource type for Analytics filter., lowercaseDetails: map{field: str, fieldIndex: int(int32)} # Details for the filter of the type LOWER., name: str # Name of this filter., parentLink: map{href: str, type: str} # Parent link for this filter. Points to the account to which this filter belongs., searchAndReplaceDetails: map{caseSensitive: bool, field: str, fieldIndex: int(int32), replaceString: str, searchString: str} # Details for the filter of the type SEARCH_AND_REPLACE., selfLink: str # Link for this filter., type: str # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED., updated: str(date-time) # Time this filter was last modified., uppercaseDetails: map{field: str, fieldIndex: int(int32)} # Details for the filter of the type UPPER.}\n@returns(200) {accountId: str, advancedDetails: map{caseSensitive: bool, extractA: str, extractB: str, fieldA: str, fieldAIndex: int(int32), fieldARequired: bool, fieldB: str, fieldBIndex: int(int32), fieldBRequired: bool, outputConstructor: str, outputToField: str, outputToFieldIndex: int(int32), overrideOutputField: bool}, created: str(date-time), excludeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, id: str, includeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, kind: str, lowercaseDetails: map{field: str, fieldIndex: int(int32)}, name: str, parentLink: map{href: str, type: str}, searchAndReplaceDetails: map{caseSensitive: bool, field: str, fieldIndex: int(int32), replaceString: str, searchString: str}, selfLink: str, type: str, updated: str(date-time), uppercaseDetails: map{field: str, fieldIndex: int(int32)}} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/filters/{filterId}\n@desc Updates an existing filter.\n@required {accountId: str # Account ID to which the filter belongs., filterId: str # ID of the filter to be updated.}\n@optional {accountId: str # Account ID to which this filter belongs., advancedDetails: map{caseSensitive: bool, extractA: str, extractB: str, fieldA: str, fieldAIndex: int(int32), fieldARequired: bool, fieldB: str, fieldBIndex: int(int32), fieldBRequired: bool, outputConstructor: str, outputToField: str, outputToFieldIndex: int(int32), overrideOutputField: bool} # Details for the filter of the type ADVANCED., created: str(date-time) # Time this filter was created., excludeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str} # JSON template for an Analytics filter expression., id: str # Filter ID., includeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str} # JSON template for an Analytics filter expression., kind: str=analytics#filter # Resource type for Analytics filter., lowercaseDetails: map{field: str, fieldIndex: int(int32)} # Details for the filter of the type LOWER., name: str # Name of this filter., parentLink: map{href: str, type: str} # Parent link for this filter. Points to the account to which this filter belongs., searchAndReplaceDetails: map{caseSensitive: bool, field: str, fieldIndex: int(int32), replaceString: str, searchString: str} # Details for the filter of the type SEARCH_AND_REPLACE., selfLink: str # Link for this filter., type: str # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED., updated: str(date-time) # Time this filter was last modified., uppercaseDetails: map{field: str, fieldIndex: int(int32)} # Details for the filter of the type UPPER.}\n@returns(200) {accountId: str, advancedDetails: map{caseSensitive: bool, extractA: str, extractB: str, fieldA: str, fieldAIndex: int(int32), fieldARequired: bool, fieldB: str, fieldBIndex: int(int32), fieldBRequired: bool, outputConstructor: str, outputToField: str, outputToFieldIndex: int(int32), overrideOutputField: bool}, created: str(date-time), excludeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, id: str, includeDetails: map{caseSensitive: bool, expressionValue: str, field: str, fieldIndex: int(int32), kind: str, matchType: str}, kind: str, lowercaseDetails: map{field: str, fieldIndex: int(int32)}, name: str, parentLink: map{href: str, type: str}, searchAndReplaceDetails: map{caseSensitive: bool, field: str, fieldIndex: int(int32), replaceString: str, searchString: str}, selfLink: str, type: str, updated: str(date-time), uppercaseDetails: map{field: str, fieldIndex: int(int32)}} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties\n@desc Lists web properties to which the user has access.\n@required {accountId: str # 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.}\n@optional {max-results: int # The maximum number of web properties to include in this response., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties\n@desc 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.\n@required {accountId: str # Account ID to create the web property for.}\n@optional {accountId: str # Account ID to which this web property belongs., childLink: map{href: str, type: str} # Child link for this web property. Points to the list of views (profiles) for this web property., created: str(date-time) # Time this web property was created., dataRetentionResetOnNewActivity: bool # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifier automatically after the rentention period. This property cannot be set on insert., dataRetentionTtl: str # The length of time for which user and event data is retained. This property cannot be set on insert., defaultProfileId: str(int64) # Default view (profile) ID., id: str # Web property ID of the form UA-XXXXX-YY., industryVertical: str # The industry vertical/category selected for this web property., internalWebPropertyId: str # Internal ID for this web property., kind: str=analytics#webproperty # Resource type for Analytics WebProperty., level: str # Level for this web property. Possible values are STANDARD or PREMIUM., name: str # Name of this web property., parentLink: map{href: str, type: str} # Parent link for this web property. Points to the account to which this web property belongs., permissions: map{effective: [str]} # Permissions the user has for this web property., profileCount: int(int32) # View (Profile) count for this web property., selfLink: str # Link for this web property., starred: bool # Indicates whether this web property is starred or not., updated: str(date-time) # Time this web property was last modified., websiteUrl: str # Website url for this web property.}\n@returns(200) {accountId: str, childLink: map{href: str, type: str}, created: str(date-time), dataRetentionResetOnNewActivity: bool, dataRetentionTtl: str, defaultProfileId: str(int64), id: str, industryVertical: str, internalWebPropertyId: str, kind: str, level: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, profileCount: int(int32), selfLink: str, starred: bool, updated: str(date-time), websiteUrl: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}\n@desc Gets a web property to which the user has access.\n@required {accountId: str # Account ID to retrieve the web property for., webPropertyId: str # ID to retrieve the web property for.}\n@returns(200) {accountId: str, childLink: map{href: str, type: str}, created: str(date-time), dataRetentionResetOnNewActivity: bool, dataRetentionTtl: str, defaultProfileId: str(int64), id: str, industryVertical: str, internalWebPropertyId: str, kind: str, level: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, profileCount: int(int32), selfLink: str, starred: bool, updated: str(date-time), websiteUrl: str} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/webproperties/{webPropertyId}\n@desc Updates an existing web property. This method supports patch semantics.\n@required {accountId: str # Account ID to which the web property belongs, webPropertyId: str # Web property ID}\n@optional {accountId: str # Account ID to which this web property belongs., childLink: map{href: str, type: str} # Child link for this web property. Points to the list of views (profiles) for this web property., created: str(date-time) # Time this web property was created., dataRetentionResetOnNewActivity: bool # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifier automatically after the rentention period. This property cannot be set on insert., dataRetentionTtl: str # The length of time for which user and event data is retained. This property cannot be set on insert., defaultProfileId: str(int64) # Default view (profile) ID., id: str # Web property ID of the form UA-XXXXX-YY., industryVertical: str # The industry vertical/category selected for this web property., internalWebPropertyId: str # Internal ID for this web property., kind: str=analytics#webproperty # Resource type for Analytics WebProperty., level: str # Level for this web property. Possible values are STANDARD or PREMIUM., name: str # Name of this web property., parentLink: map{href: str, type: str} # Parent link for this web property. Points to the account to which this web property belongs., permissions: map{effective: [str]} # Permissions the user has for this web property., profileCount: int(int32) # View (Profile) count for this web property., selfLink: str # Link for this web property., starred: bool # Indicates whether this web property is starred or not., updated: str(date-time) # Time this web property was last modified., websiteUrl: str # Website url for this web property.}\n@returns(200) {accountId: str, childLink: map{href: str, type: str}, created: str(date-time), dataRetentionResetOnNewActivity: bool, dataRetentionTtl: str, defaultProfileId: str(int64), id: str, industryVertical: str, internalWebPropertyId: str, kind: str, level: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, profileCount: int(int32), selfLink: str, starred: bool, updated: str(date-time), websiteUrl: str} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}\n@desc Updates an existing web property.\n@required {accountId: str # Account ID to which the web property belongs, webPropertyId: str # Web property ID}\n@optional {accountId: str # Account ID to which this web property belongs., childLink: map{href: str, type: str} # Child link for this web property. Points to the list of views (profiles) for this web property., created: str(date-time) # Time this web property was created., dataRetentionResetOnNewActivity: bool # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifier automatically after the rentention period. This property cannot be set on insert., dataRetentionTtl: str # The length of time for which user and event data is retained. This property cannot be set on insert., defaultProfileId: str(int64) # Default view (profile) ID., id: str # Web property ID of the form UA-XXXXX-YY., industryVertical: str # The industry vertical/category selected for this web property., internalWebPropertyId: str # Internal ID for this web property., kind: str=analytics#webproperty # Resource type for Analytics WebProperty., level: str # Level for this web property. Possible values are STANDARD or PREMIUM., name: str # Name of this web property., parentLink: map{href: str, type: str} # Parent link for this web property. Points to the account to which this web property belongs., permissions: map{effective: [str]} # Permissions the user has for this web property., profileCount: int(int32) # View (Profile) count for this web property., selfLink: str # Link for this web property., starred: bool # Indicates whether this web property is starred or not., updated: str(date-time) # Time this web property was last modified., websiteUrl: str # Website url for this web property.}\n@returns(200) {accountId: str, childLink: map{href: str, type: str}, created: str(date-time), dataRetentionResetOnNewActivity: bool, dataRetentionTtl: str, defaultProfileId: str(int64), id: str, industryVertical: str, internalWebPropertyId: str, kind: str, level: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, profileCount: int(int32), selfLink: str, starred: bool, updated: str(date-time), websiteUrl: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources\n@desc List custom data sources to which the user has access.\n@required {accountId: str # Account Id for the custom data sources to retrieve., webPropertyId: str # Web property Id for the custom data sources to retrieve.}\n@optional {max-results: int # The maximum number of custom data sources to include in this response., start-index: int # 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.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData\n@desc Delete data associated with a previous upload.\n@required {accountId: str # Account Id for the uploads to be deleted., webPropertyId: str # Web property Id for the uploads to be deleted., customDataSourceId: str # Custom data source Id for the uploads to be deleted.}\n@optional {customDataImportUids: [str] # A list of upload UIDs.}\n@returns(200) Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads\n@desc List uploads to which the user has access.\n@required {accountId: str # Account Id for the uploads to retrieve., webPropertyId: str # Web property Id for the uploads to retrieve., customDataSourceId: str # Custom data source Id for uploads to retrieve.}\n@optional {max-results: int # The maximum number of uploads to include in this response., start-index: int # A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32)} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads\n@desc Upload data for a custom data source.\n@required {accountId: str # Account Id associated with the upload., webPropertyId: str # Web property UA-string associated with the upload., customDataSourceId: str # Custom data source Id to which the data being uploaded belongs.}\n@returns(200) {accountId: str(int64), customDataSourceId: str, errors: [str], id: str, kind: str, status: str, uploadTime: str(date-time)} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}\n@desc List uploads to which the user has access.\n@required {accountId: str # Account Id for the upload to retrieve., webPropertyId: str # Web property Id for the upload to retrieve., customDataSourceId: str # Custom data source Id for upload to retrieve., uploadId: str # Upload Id to retrieve.}\n@returns(200) {accountId: str(int64), customDataSourceId: str, errors: [str], id: str, kind: str, status: str, uploadTime: str(date-time)} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions\n@desc Lists custom dimensions to which the user has access.\n@required {accountId: str # Account ID for the custom dimensions to retrieve., webPropertyId: str # Web property ID for the custom dimensions to retrieve.}\n@optional {max-results: int # The maximum number of custom dimensions to include in this response., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions\n@desc Create a new custom dimension.\n@required {accountId: str # Account ID for the custom dimension to create., webPropertyId: str # Web property ID for the custom dimension to create.}\n@optional {accountId: str # Account ID., active: bool # Boolean indicating whether the custom dimension is active., created: str(date-time) # Time the custom dimension was created., id: str # Custom dimension ID., index: int(int32) # Index of the custom dimension., kind: str=analytics#customDimension # Kind value for a custom dimension. Set to \"analytics#customDimension\". It is a read-only field., name: str # Name of the custom dimension., parentLink: map{href: str, type: str} # Parent link for the custom dimension. Points to the property to which the custom dimension belongs., scope: str # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT., selfLink: str # Link for the custom dimension, updated: str(date-time) # Time the custom dimension was last modified., webPropertyId: str # Property ID.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), id: str, index: int(int32), kind: str, name: str, parentLink: map{href: str, type: str}, scope: str, selfLink: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}\n@desc Get a custom dimension to which the user has access.\n@required {accountId: str # Account ID for the custom dimension to retrieve., webPropertyId: str # Web property ID for the custom dimension to retrieve., customDimensionId: str # The ID of the custom dimension to retrieve.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), id: str, index: int(int32), kind: str, name: str, parentLink: map{href: str, type: str}, scope: str, selfLink: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}\n@desc Updates an existing custom dimension. This method supports patch semantics.\n@required {accountId: str # Account ID for the custom dimension to update., webPropertyId: str # Web property ID for the custom dimension to update., customDimensionId: str # Custom dimension ID for the custom dimension to update.}\n@optional {ignoreCustomDataSourceLinks: bool # Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set., accountId: str # Account ID., active: bool # Boolean indicating whether the custom dimension is active., created: str(date-time) # Time the custom dimension was created., id: str # Custom dimension ID., index: int(int32) # Index of the custom dimension., kind: str=analytics#customDimension # Kind value for a custom dimension. Set to \"analytics#customDimension\". It is a read-only field., name: str # Name of the custom dimension., parentLink: map{href: str, type: str} # Parent link for the custom dimension. Points to the property to which the custom dimension belongs., scope: str # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT., selfLink: str # Link for the custom dimension, updated: str(date-time) # Time the custom dimension was last modified., webPropertyId: str # Property ID.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), id: str, index: int(int32), kind: str, name: str, parentLink: map{href: str, type: str}, scope: str, selfLink: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}\n@desc Updates an existing custom dimension.\n@required {accountId: str # Account ID for the custom dimension to update., webPropertyId: str # Web property ID for the custom dimension to update., customDimensionId: str # Custom dimension ID for the custom dimension to update.}\n@optional {ignoreCustomDataSourceLinks: bool # Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set., accountId: str # Account ID., active: bool # Boolean indicating whether the custom dimension is active., created: str(date-time) # Time the custom dimension was created., id: str # Custom dimension ID., index: int(int32) # Index of the custom dimension., kind: str=analytics#customDimension # Kind value for a custom dimension. Set to \"analytics#customDimension\". It is a read-only field., name: str # Name of the custom dimension., parentLink: map{href: str, type: str} # Parent link for the custom dimension. Points to the property to which the custom dimension belongs., scope: str # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT., selfLink: str # Link for the custom dimension, updated: str(date-time) # Time the custom dimension was last modified., webPropertyId: str # Property ID.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), id: str, index: int(int32), kind: str, name: str, parentLink: map{href: str, type: str}, scope: str, selfLink: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics\n@desc Lists custom metrics to which the user has access.\n@required {accountId: str # Account ID for the custom metrics to retrieve., webPropertyId: str # Web property ID for the custom metrics to retrieve.}\n@optional {max-results: int # The maximum number of custom metrics to include in this response., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics\n@desc Create a new custom metric.\n@required {accountId: str # Account ID for the custom metric to create., webPropertyId: str # Web property ID for the custom dimension to create.}\n@optional {accountId: str # Account ID., active: bool # Boolean indicating whether the custom metric is active., created: str(date-time) # Time the custom metric was created., id: str # Custom metric ID., index: int(int32) # Index of the custom metric., kind: str=analytics#customMetric # Kind value for a custom metric. Set to \"analytics#customMetric\". It is a read-only field., max_value: str # Max value of custom metric., min_value: str # Min value of custom metric., name: str # Name of the custom metric., parentLink: map{href: str, type: str} # Parent link for the custom metric. Points to the property to which the custom metric belongs., scope: str # Scope of the custom metric: HIT or PRODUCT., selfLink: str # Link for the custom metric, type: str # Data type of custom metric., updated: str(date-time) # Time the custom metric was last modified., webPropertyId: str # Property ID.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), id: str, index: int(int32), kind: str, max_value: str, min_value: str, name: str, parentLink: map{href: str, type: str}, scope: str, selfLink: str, type: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}\n@desc Get a custom metric to which the user has access.\n@required {accountId: str # Account ID for the custom metric to retrieve., webPropertyId: str # Web property ID for the custom metric to retrieve., customMetricId: str # The ID of the custom metric to retrieve.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), id: str, index: int(int32), kind: str, max_value: str, min_value: str, name: str, parentLink: map{href: str, type: str}, scope: str, selfLink: str, type: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}\n@desc Updates an existing custom metric. This method supports patch semantics.\n@required {accountId: str # Account ID for the custom metric to update., webPropertyId: str # Web property ID for the custom metric to update., customMetricId: str # Custom metric ID for the custom metric to update.}\n@optional {ignoreCustomDataSourceLinks: bool # Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set., accountId: str # Account ID., active: bool # Boolean indicating whether the custom metric is active., created: str(date-time) # Time the custom metric was created., id: str # Custom metric ID., index: int(int32) # Index of the custom metric., kind: str=analytics#customMetric # Kind value for a custom metric. Set to \"analytics#customMetric\". It is a read-only field., max_value: str # Max value of custom metric., min_value: str # Min value of custom metric., name: str # Name of the custom metric., parentLink: map{href: str, type: str} # Parent link for the custom metric. Points to the property to which the custom metric belongs., scope: str # Scope of the custom metric: HIT or PRODUCT., selfLink: str # Link for the custom metric, type: str # Data type of custom metric., updated: str(date-time) # Time the custom metric was last modified., webPropertyId: str # Property ID.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), id: str, index: int(int32), kind: str, max_value: str, min_value: str, name: str, parentLink: map{href: str, type: str}, scope: str, selfLink: str, type: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}\n@desc Updates an existing custom metric.\n@required {accountId: str # Account ID for the custom metric to update., webPropertyId: str # Web property ID for the custom metric to update., customMetricId: str # Custom metric ID for the custom metric to update.}\n@optional {ignoreCustomDataSourceLinks: bool # Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set., accountId: str # Account ID., active: bool # Boolean indicating whether the custom metric is active., created: str(date-time) # Time the custom metric was created., id: str # Custom metric ID., index: int(int32) # Index of the custom metric., kind: str=analytics#customMetric # Kind value for a custom metric. Set to \"analytics#customMetric\". It is a read-only field., max_value: str # Max value of custom metric., min_value: str # Min value of custom metric., name: str # Name of the custom metric., parentLink: map{href: str, type: str} # Parent link for the custom metric. Points to the property to which the custom metric belongs., scope: str # Scope of the custom metric: HIT or PRODUCT., selfLink: str # Link for the custom metric, type: str # Data type of custom metric., updated: str(date-time) # Time the custom metric was last modified., webPropertyId: str # Property ID.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), id: str, index: int(int32), kind: str, max_value: str, min_value: str, name: str, parentLink: map{href: str, type: str}, scope: str, selfLink: str, type: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks\n@desc Lists webProperty-Google Ads links for a given web property.\n@required {accountId: str # ID of the account which the given web property belongs to., webPropertyId: str # Web property ID to retrieve the Google Ads links for.}\n@optional {max-results: int # The maximum number of webProperty-Google Ads links to include in this response., start-index: int # An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32)} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks\n@desc Creates a webProperty-Google Ads link.\n@required {accountId: str # ID of the Google Analytics account to create the link for., webPropertyId: str # Web property ID to create the link for.}\n@optional {adWordsAccounts: [map{autoTaggingEnabled: bool, customerId: str, kind: str}] # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty., entity: map{webPropertyRef: map} # Web property being linked., id: str # Entity Google Ads link ID, kind: str=analytics#entityAdWordsLink # Resource type for entity Google Ads link., name: str # Name of the link. This field is required when creating a Google Ads link., profileIds: [str] # IDs of linked Views (Profiles) represented as strings., selfLink: str # URL link for this Google Analytics - Google Ads link.}\n@returns(200) {adWordsAccounts: [map], entity: map{webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, name: str, profileIds: [str], selfLink: str} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}\n@desc Deletes a web property-Google Ads link.\n@required {accountId: str # ID of the account which the given web property belongs to., webPropertyId: str # Web property ID to delete the Google Ads link for., webPropertyAdWordsLinkId: str # Web property Google Ads link ID.}\n@returns(200) Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}\n@desc Returns a web property-Google Ads link to which the user has access.\n@required {accountId: str # ID of the account which the given web property belongs to., webPropertyId: str # Web property ID to retrieve the Google Ads link for., webPropertyAdWordsLinkId: str # Web property-Google Ads link ID.}\n@returns(200) {adWordsAccounts: [map], entity: map{webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, name: str, profileIds: [str], selfLink: str} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}\n@desc Updates an existing webProperty-Google Ads link. This method supports patch semantics.\n@required {accountId: str # ID of the account which the given web property belongs to., webPropertyId: str # Web property ID to retrieve the Google Ads link for., webPropertyAdWordsLinkId: str # Web property-Google Ads link ID.}\n@optional {adWordsAccounts: [map{autoTaggingEnabled: bool, customerId: str, kind: str}] # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty., entity: map{webPropertyRef: map} # Web property being linked., id: str # Entity Google Ads link ID, kind: str=analytics#entityAdWordsLink # Resource type for entity Google Ads link., name: str # Name of the link. This field is required when creating a Google Ads link., profileIds: [str] # IDs of linked Views (Profiles) represented as strings., selfLink: str # URL link for this Google Analytics - Google Ads link.}\n@returns(200) {adWordsAccounts: [map], entity: map{webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, name: str, profileIds: [str], selfLink: str} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}\n@desc Updates an existing webProperty-Google Ads link.\n@required {accountId: str # ID of the account which the given web property belongs to., webPropertyId: str # Web property ID to retrieve the Google Ads link for., webPropertyAdWordsLinkId: str # Web property-Google Ads link ID.}\n@optional {adWordsAccounts: [map{autoTaggingEnabled: bool, customerId: str, kind: str}] # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty., entity: map{webPropertyRef: map} # Web property being linked., id: str # Entity Google Ads link ID, kind: str=analytics#entityAdWordsLink # Resource type for entity Google Ads link., name: str # Name of the link. This field is required when creating a Google Ads link., profileIds: [str] # IDs of linked Views (Profiles) represented as strings., selfLink: str # URL link for this Google Analytics - Google Ads link.}\n@returns(200) {adWordsAccounts: [map], entity: map{webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, name: str, profileIds: [str], selfLink: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks\n@desc Lists webProperty-user links for a given web property.\n@required {accountId: str # Account ID which the given web property belongs to., webPropertyId: str # Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.}\n@optional {max-results: int # The maximum number of webProperty-user Links to include in this response., start-index: int # An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32)} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks\n@desc Adds a new user to the given web property.\n@required {accountId: str # Account ID to create the user link for., webPropertyId: str # Web Property ID to create the user link for.}\n@optional {entity: map{accountRef: map, profileRef: map, webPropertyRef: map} # Entity for this link. It can be an account, a web property, or a view (profile)., id: str # Entity user link ID, kind: str=analytics#entityUserLink # Resource type for entity user link., permissions: map{effective: [str], local: [str]} # Permissions the user has for this entity., selfLink: str # Self link for this resource., userRef: map{email: str, id: str, kind: str} # JSON template for a user reference.}\n@returns(200) {entity: map{accountRef: map{href: str, id: str, kind: str, name: str}, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, permissions: map{effective: [str], local: [str]}, selfLink: str, userRef: map{email: str, id: str, kind: str}} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}\n@desc Removes a user from the given web property.\n@required {accountId: str # Account ID to delete the user link for., webPropertyId: str # Web Property ID to delete the user link for., linkId: str # Link ID to delete the user link for.}\n@returns(200) Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}\n@desc Updates permissions for an existing user on the given web property.\n@required {accountId: str # Account ID to update the account-user link for., webPropertyId: str # Web property ID to update the account-user link for., linkId: str # Link ID to update the account-user link for.}\n@optional {entity: map{accountRef: map, profileRef: map, webPropertyRef: map} # Entity for this link. It can be an account, a web property, or a view (profile)., id: str # Entity user link ID, kind: str=analytics#entityUserLink # Resource type for entity user link., permissions: map{effective: [str], local: [str]} # Permissions the user has for this entity., selfLink: str # Self link for this resource., userRef: map{email: str, id: str, kind: str} # JSON template for a user reference.}\n@returns(200) {entity: map{accountRef: map{href: str, id: str, kind: str, name: str}, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, permissions: map{effective: [str], local: [str]}, selfLink: str, userRef: map{email: str, id: str, kind: str}} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles\n@desc Lists views (profiles) to which the user has access.\n@required {accountId: str # Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access., webPropertyId: str # Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.}\n@optional {max-results: int # The maximum number of views (profiles) to include in this response., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles\n@desc Create a new view (profile).\n@required {accountId: str # Account ID to create the view (profile) for., webPropertyId: str # Web property ID to create the view (profile) for.}\n@optional {accountId: str # Account ID to which this view (profile) belongs., botFilteringEnabled: bool # Indicates whether bot filtering is enabled for this view (profile)., childLink: map{href: str, type: str} # Child link for this view (profile). Points to the list of goals for this view (profile)., created: str(date-time) # Time this view (profile) was created., currency: str # 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, 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, defaultPage: str # Default page for this view (profile)., eCommerceTracking: bool # Indicates whether ecommerce tracking is enabled for this view (profile)., enhancedECommerceTracking: bool # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled., excludeQueryParameters: str # The query parameters that are excluded from this view (profile)., id: str # View (Profile) ID., internalWebPropertyId: str # Internal ID for the web property to which this view (profile) belongs., kind: str=analytics#profile # Resource type for Analytics view (profile)., name: str # Name of this view (profile)., parentLink: map{href: str, type: str} # Parent link for this view (profile). Points to the web property to which this view (profile) belongs., permissions: map{effective: [str]} # Permissions the user has for this view (profile)., selfLink: str # Link for this view (profile)., siteSearchCategoryParameters: str # Site search category parameters for this view (profile)., siteSearchQueryParameters: str # The site search query parameters for this view (profile)., starred: bool # Indicates whether this view (profile) is starred or not., stripSiteSearchCategoryParameters: bool # Whether or not Analytics will strip search category parameters from the URLs in your reports., stripSiteSearchQueryParameters: bool # Whether or not Analytics will strip search query parameters from the URLs in your reports., timezone: str # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database., type: str # View (Profile) type. Supported types: WEB or APP., updated: str(date-time) # Time this view (profile) was last modified., webPropertyId: str # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs., websiteUrl: str # Website URL for this view (profile).}\n@returns(200) {accountId: str, botFilteringEnabled: bool, childLink: map{href: str, type: str}, created: str(date-time), currency: str, defaultPage: str, eCommerceTracking: bool, enhancedECommerceTracking: bool, excludeQueryParameters: str, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, selfLink: str, siteSearchCategoryParameters: str, siteSearchQueryParameters: str, starred: bool, stripSiteSearchCategoryParameters: bool, stripSiteSearchQueryParameters: bool, timezone: str, type: str, updated: str(date-time), webPropertyId: str, websiteUrl: str} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}\n@desc Deletes a view (profile).\n@required {accountId: str # Account ID to delete the view (profile) for., webPropertyId: str # Web property ID to delete the view (profile) for., profileId: str # ID of the view (profile) to be deleted.}\n@returns(200) Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}\n@desc Gets a view (profile) to which the user has access.\n@required {accountId: str # Account ID to retrieve the view (profile) for., webPropertyId: str # Web property ID to retrieve the view (profile) for., profileId: str # View (Profile) ID to retrieve the view (profile) for.}\n@returns(200) {accountId: str, botFilteringEnabled: bool, childLink: map{href: str, type: str}, created: str(date-time), currency: str, defaultPage: str, eCommerceTracking: bool, enhancedECommerceTracking: bool, excludeQueryParameters: str, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, selfLink: str, siteSearchCategoryParameters: str, siteSearchQueryParameters: str, starred: bool, stripSiteSearchCategoryParameters: bool, stripSiteSearchQueryParameters: bool, timezone: str, type: str, updated: str(date-time), webPropertyId: str, websiteUrl: str} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}\n@desc Updates an existing view (profile). This method supports patch semantics.\n@required {accountId: str # Account ID to which the view (profile) belongs, webPropertyId: str # Web property ID to which the view (profile) belongs, profileId: str # ID of the view (profile) to be updated.}\n@optional {accountId: str # Account ID to which this view (profile) belongs., botFilteringEnabled: bool # Indicates whether bot filtering is enabled for this view (profile)., childLink: map{href: str, type: str} # Child link for this view (profile). Points to the list of goals for this view (profile)., created: str(date-time) # Time this view (profile) was created., currency: str # 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, 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, defaultPage: str # Default page for this view (profile)., eCommerceTracking: bool # Indicates whether ecommerce tracking is enabled for this view (profile)., enhancedECommerceTracking: bool # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled., excludeQueryParameters: str # The query parameters that are excluded from this view (profile)., id: str # View (Profile) ID., internalWebPropertyId: str # Internal ID for the web property to which this view (profile) belongs., kind: str=analytics#profile # Resource type for Analytics view (profile)., name: str # Name of this view (profile)., parentLink: map{href: str, type: str} # Parent link for this view (profile). Points to the web property to which this view (profile) belongs., permissions: map{effective: [str]} # Permissions the user has for this view (profile)., selfLink: str # Link for this view (profile)., siteSearchCategoryParameters: str # Site search category parameters for this view (profile)., siteSearchQueryParameters: str # The site search query parameters for this view (profile)., starred: bool # Indicates whether this view (profile) is starred or not., stripSiteSearchCategoryParameters: bool # Whether or not Analytics will strip search category parameters from the URLs in your reports., stripSiteSearchQueryParameters: bool # Whether or not Analytics will strip search query parameters from the URLs in your reports., timezone: str # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database., type: str # View (Profile) type. Supported types: WEB or APP., updated: str(date-time) # Time this view (profile) was last modified., webPropertyId: str # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs., websiteUrl: str # Website URL for this view (profile).}\n@returns(200) {accountId: str, botFilteringEnabled: bool, childLink: map{href: str, type: str}, created: str(date-time), currency: str, defaultPage: str, eCommerceTracking: bool, enhancedECommerceTracking: bool, excludeQueryParameters: str, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, selfLink: str, siteSearchCategoryParameters: str, siteSearchQueryParameters: str, starred: bool, stripSiteSearchCategoryParameters: bool, stripSiteSearchQueryParameters: bool, timezone: str, type: str, updated: str(date-time), webPropertyId: str, websiteUrl: str} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}\n@desc Updates an existing view (profile).\n@required {accountId: str # Account ID to which the view (profile) belongs, webPropertyId: str # Web property ID to which the view (profile) belongs, profileId: str # ID of the view (profile) to be updated.}\n@optional {accountId: str # Account ID to which this view (profile) belongs., botFilteringEnabled: bool # Indicates whether bot filtering is enabled for this view (profile)., childLink: map{href: str, type: str} # Child link for this view (profile). Points to the list of goals for this view (profile)., created: str(date-time) # Time this view (profile) was created., currency: str # 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, 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, defaultPage: str # Default page for this view (profile)., eCommerceTracking: bool # Indicates whether ecommerce tracking is enabled for this view (profile)., enhancedECommerceTracking: bool # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled., excludeQueryParameters: str # The query parameters that are excluded from this view (profile)., id: str # View (Profile) ID., internalWebPropertyId: str # Internal ID for the web property to which this view (profile) belongs., kind: str=analytics#profile # Resource type for Analytics view (profile)., name: str # Name of this view (profile)., parentLink: map{href: str, type: str} # Parent link for this view (profile). Points to the web property to which this view (profile) belongs., permissions: map{effective: [str]} # Permissions the user has for this view (profile)., selfLink: str # Link for this view (profile)., siteSearchCategoryParameters: str # Site search category parameters for this view (profile)., siteSearchQueryParameters: str # The site search query parameters for this view (profile)., starred: bool # Indicates whether this view (profile) is starred or not., stripSiteSearchCategoryParameters: bool # Whether or not Analytics will strip search category parameters from the URLs in your reports., stripSiteSearchQueryParameters: bool # Whether or not Analytics will strip search query parameters from the URLs in your reports., timezone: str # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database., type: str # View (Profile) type. Supported types: WEB or APP., updated: str(date-time) # Time this view (profile) was last modified., webPropertyId: str # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs., websiteUrl: str # Website URL for this view (profile).}\n@returns(200) {accountId: str, botFilteringEnabled: bool, childLink: map{href: str, type: str}, created: str(date-time), currency: str, defaultPage: str, eCommerceTracking: bool, enhancedECommerceTracking: bool, excludeQueryParameters: str, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, selfLink: str, siteSearchCategoryParameters: str, siteSearchQueryParameters: str, starred: bool, stripSiteSearchCategoryParameters: bool, stripSiteSearchQueryParameters: bool, timezone: str, type: str, updated: str(date-time), webPropertyId: str, websiteUrl: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks\n@desc Lists profile-user links for a given view (profile).\n@required {accountId: str # Account ID which the given view (profile) belongs to., webPropertyId: str # Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to., profileId: str # View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.}\n@optional {max-results: int # The maximum number of profile-user links to include in this response., start-index: int # An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32)} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks\n@desc Adds a new user to the given view (profile).\n@required {accountId: str # Account ID to create the user link for., webPropertyId: str # Web Property ID to create the user link for., profileId: str # View (Profile) ID to create the user link for.}\n@optional {entity: map{accountRef: map, profileRef: map, webPropertyRef: map} # Entity for this link. It can be an account, a web property, or a view (profile)., id: str # Entity user link ID, kind: str=analytics#entityUserLink # Resource type for entity user link., permissions: map{effective: [str], local: [str]} # Permissions the user has for this entity., selfLink: str # Self link for this resource., userRef: map{email: str, id: str, kind: str} # JSON template for a user reference.}\n@returns(200) {entity: map{accountRef: map{href: str, id: str, kind: str, name: str}, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, permissions: map{effective: [str], local: [str]}, selfLink: str, userRef: map{email: str, id: str, kind: str}} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}\n@desc Removes a user from the given view (profile).\n@required {accountId: str # Account ID to delete the user link for., webPropertyId: str # Web Property ID to delete the user link for., profileId: str # View (Profile) ID to delete the user link for., linkId: str # Link ID to delete the user link for.}\n@returns(200) Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}\n@desc Updates permissions for an existing user on the given view (profile).\n@required {accountId: str # Account ID to update the user link for., webPropertyId: str # Web Property ID to update the user link for., profileId: str # View (Profile ID) to update the user link for., linkId: str # Link ID to update the user link for.}\n@optional {entity: map{accountRef: map, profileRef: map, webPropertyRef: map} # Entity for this link. It can be an account, a web property, or a view (profile)., id: str # Entity user link ID, kind: str=analytics#entityUserLink # Resource type for entity user link., permissions: map{effective: [str], local: [str]} # Permissions the user has for this entity., selfLink: str # Self link for this resource., userRef: map{email: str, id: str, kind: str} # JSON template for a user reference.}\n@returns(200) {entity: map{accountRef: map{href: str, id: str, kind: str, name: str}, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, webPropertyRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str}}, id: str, kind: str, permissions: map{effective: [str], local: [str]}, selfLink: str, userRef: map{email: str, id: str, kind: str}} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments\n@desc Lists experiments to which the user has access.\n@required {accountId: str # Account ID to retrieve experiments for., webPropertyId: str # Web property ID to retrieve experiments for., profileId: str # View (Profile) ID to retrieve experiments for.}\n@optional {max-results: int # The maximum number of experiments to include in this response., start-index: int # An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments\n@desc Create a new experiment.\n@required {accountId: str # Account ID to create the experiment for., webPropertyId: str # Web property ID to create the experiment for., profileId: str # View (Profile) ID to create the experiment for.}\n@optional {accountId: str # Account ID to which this experiment belongs. This field is read-only., created: str(date-time) # Time the experiment was created. This field is read-only., description: str # Notes about this experiment., editableInGaUi: bool # If true, the end user will be able to edit the experiment via the Google Analytics user interface., endTime: str(date-time) # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only., equalWeighting: bool # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED., id: str # Experiment ID. Required for patch and update. Disallowed for create., internalWebPropertyId: str # Internal ID for the web property to which this experiment belongs. This field is read-only., kind: str=analytics#experiment # Resource type for an Analytics experiment. This field is read-only., minimumExperimentLengthInDays: int(int32) # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED., name: str # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment., objectiveMetric: str # The metric that the experiment is optimizing. Valid values: \"ga:goal(n)Completions\", \"ga:adsenseAdsClicks\", \"ga:adsenseAdsViewed\", \"ga:adsenseRevenue\", \"ga:bounces\", \"ga:pageviews\", \"ga:sessionDuration\", \"ga:transactions\", \"ga:transactionRevenue\". This field is required if status is \"RUNNING\" and servingFramework is one of \"REDIRECT\" or \"API\"., optimizationType: str # Whether the objectiveMetric should be minimized or maximized. Possible values: \"MAXIMUM\", \"MINIMUM\". Optional--defaults to \"MAXIMUM\". Cannot be specified without objectiveMetric. Cannot be modified when status is \"RUNNING\" or \"ENDED\"., parentLink: map{href: str, type: str} # Parent link for an experiment. Points to the view (profile) to which this experiment belongs., profileId: str # View (Profile) ID to which this experiment belongs. This field is read-only., reasonExperimentEnded: str # Why the experiment ended. Possible values: \"STOPPED_BY_USER\", \"WINNER_FOUND\", \"EXPERIMENT_EXPIRED\", \"ENDED_WITH_NO_WINNER\", \"GOAL_OBJECTIVE_CHANGED\". \"ENDED_WITH_NO_WINNER\" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only., rewriteVariationUrlsAsOriginal: bool # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED., selfLink: str # Link for this experiment. This field is read-only., servingFramework: str # The framework used to serve the experiment variations and evaluate the results. One of:   - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results., snippet: str # The snippet of code to include on the control page(s). This field is read-only., startTime: str(date-time) # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only., status: str # Experiment status. Possible values: \"DRAFT\", \"READY_TO_RUN\", \"RUNNING\", \"ENDED\". Experiments can be created in the \"DRAFT\", \"READY_TO_RUN\" or \"RUNNING\" state. This field is required when creating an experiment., trafficCoverage: num(double) # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED., updated: str(date-time) # Time the experiment was last modified. This field is read-only., variations: [map{name: str, status: str, url: str, weight: num(double), won: bool}] # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING., webPropertyId: str # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only., winnerConfidenceLevel: num(double) # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED., winnerFound: bool # Boolean specifying whether a winner has been found for this experiment. This field is read-only.}\n@returns(200) {accountId: str, created: str(date-time), description: str, editableInGaUi: bool, endTime: str(date-time), equalWeighting: bool, id: str, internalWebPropertyId: str, kind: str, minimumExperimentLengthInDays: int(int32), name: str, objectiveMetric: str, optimizationType: str, parentLink: map{href: str, type: str}, profileId: str, reasonExperimentEnded: str, rewriteVariationUrlsAsOriginal: bool, selfLink: str, servingFramework: str, snippet: str, startTime: str(date-time), status: str, trafficCoverage: num(double), updated: str(date-time), variations: [map], webPropertyId: str, winnerConfidenceLevel: num(double), winnerFound: bool} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}\n@desc Delete an experiment.\n@required {accountId: str # Account ID to which the experiment belongs, webPropertyId: str # Web property ID to which the experiment belongs, profileId: str # View (Profile) ID to which the experiment belongs, experimentId: str # ID of the experiment to delete}\n@returns(200) Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}\n@desc Returns an experiment to which the user has access.\n@required {accountId: str # Account ID to retrieve the experiment for., webPropertyId: str # Web property ID to retrieve the experiment for., profileId: str # View (Profile) ID to retrieve the experiment for., experimentId: str # Experiment ID to retrieve the experiment for.}\n@returns(200) {accountId: str, created: str(date-time), description: str, editableInGaUi: bool, endTime: str(date-time), equalWeighting: bool, id: str, internalWebPropertyId: str, kind: str, minimumExperimentLengthInDays: int(int32), name: str, objectiveMetric: str, optimizationType: str, parentLink: map{href: str, type: str}, profileId: str, reasonExperimentEnded: str, rewriteVariationUrlsAsOriginal: bool, selfLink: str, servingFramework: str, snippet: str, startTime: str(date-time), status: str, trafficCoverage: num(double), updated: str(date-time), variations: [map], webPropertyId: str, winnerConfidenceLevel: num(double), winnerFound: bool} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}\n@desc Update an existing experiment. This method supports patch semantics.\n@required {accountId: str # Account ID of the experiment to update., webPropertyId: str # Web property ID of the experiment to update., profileId: str # View (Profile) ID of the experiment to update., experimentId: str # Experiment ID of the experiment to update.}\n@optional {accountId: str # Account ID to which this experiment belongs. This field is read-only., created: str(date-time) # Time the experiment was created. This field is read-only., description: str # Notes about this experiment., editableInGaUi: bool # If true, the end user will be able to edit the experiment via the Google Analytics user interface., endTime: str(date-time) # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only., equalWeighting: bool # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED., id: str # Experiment ID. Required for patch and update. Disallowed for create., internalWebPropertyId: str # Internal ID for the web property to which this experiment belongs. This field is read-only., kind: str=analytics#experiment # Resource type for an Analytics experiment. This field is read-only., minimumExperimentLengthInDays: int(int32) # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED., name: str # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment., objectiveMetric: str # The metric that the experiment is optimizing. Valid values: \"ga:goal(n)Completions\", \"ga:adsenseAdsClicks\", \"ga:adsenseAdsViewed\", \"ga:adsenseRevenue\", \"ga:bounces\", \"ga:pageviews\", \"ga:sessionDuration\", \"ga:transactions\", \"ga:transactionRevenue\". This field is required if status is \"RUNNING\" and servingFramework is one of \"REDIRECT\" or \"API\"., optimizationType: str # Whether the objectiveMetric should be minimized or maximized. Possible values: \"MAXIMUM\", \"MINIMUM\". Optional--defaults to \"MAXIMUM\". Cannot be specified without objectiveMetric. Cannot be modified when status is \"RUNNING\" or \"ENDED\"., parentLink: map{href: str, type: str} # Parent link for an experiment. Points to the view (profile) to which this experiment belongs., profileId: str # View (Profile) ID to which this experiment belongs. This field is read-only., reasonExperimentEnded: str # Why the experiment ended. Possible values: \"STOPPED_BY_USER\", \"WINNER_FOUND\", \"EXPERIMENT_EXPIRED\", \"ENDED_WITH_NO_WINNER\", \"GOAL_OBJECTIVE_CHANGED\". \"ENDED_WITH_NO_WINNER\" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only., rewriteVariationUrlsAsOriginal: bool # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED., selfLink: str # Link for this experiment. This field is read-only., servingFramework: str # The framework used to serve the experiment variations and evaluate the results. One of:   - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results., snippet: str # The snippet of code to include on the control page(s). This field is read-only., startTime: str(date-time) # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only., status: str # Experiment status. Possible values: \"DRAFT\", \"READY_TO_RUN\", \"RUNNING\", \"ENDED\". Experiments can be created in the \"DRAFT\", \"READY_TO_RUN\" or \"RUNNING\" state. This field is required when creating an experiment., trafficCoverage: num(double) # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED., updated: str(date-time) # Time the experiment was last modified. This field is read-only., variations: [map{name: str, status: str, url: str, weight: num(double), won: bool}] # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING., webPropertyId: str # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only., winnerConfidenceLevel: num(double) # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED., winnerFound: bool # Boolean specifying whether a winner has been found for this experiment. This field is read-only.}\n@returns(200) {accountId: str, created: str(date-time), description: str, editableInGaUi: bool, endTime: str(date-time), equalWeighting: bool, id: str, internalWebPropertyId: str, kind: str, minimumExperimentLengthInDays: int(int32), name: str, objectiveMetric: str, optimizationType: str, parentLink: map{href: str, type: str}, profileId: str, reasonExperimentEnded: str, rewriteVariationUrlsAsOriginal: bool, selfLink: str, servingFramework: str, snippet: str, startTime: str(date-time), status: str, trafficCoverage: num(double), updated: str(date-time), variations: [map], webPropertyId: str, winnerConfidenceLevel: num(double), winnerFound: bool} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}\n@desc Update an existing experiment.\n@required {accountId: str # Account ID of the experiment to update., webPropertyId: str # Web property ID of the experiment to update., profileId: str # View (Profile) ID of the experiment to update., experimentId: str # Experiment ID of the experiment to update.}\n@optional {accountId: str # Account ID to which this experiment belongs. This field is read-only., created: str(date-time) # Time the experiment was created. This field is read-only., description: str # Notes about this experiment., editableInGaUi: bool # If true, the end user will be able to edit the experiment via the Google Analytics user interface., endTime: str(date-time) # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only., equalWeighting: bool # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED., id: str # Experiment ID. Required for patch and update. Disallowed for create., internalWebPropertyId: str # Internal ID for the web property to which this experiment belongs. This field is read-only., kind: str=analytics#experiment # Resource type for an Analytics experiment. This field is read-only., minimumExperimentLengthInDays: int(int32) # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED., name: str # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment., objectiveMetric: str # The metric that the experiment is optimizing. Valid values: \"ga:goal(n)Completions\", \"ga:adsenseAdsClicks\", \"ga:adsenseAdsViewed\", \"ga:adsenseRevenue\", \"ga:bounces\", \"ga:pageviews\", \"ga:sessionDuration\", \"ga:transactions\", \"ga:transactionRevenue\". This field is required if status is \"RUNNING\" and servingFramework is one of \"REDIRECT\" or \"API\"., optimizationType: str # Whether the objectiveMetric should be minimized or maximized. Possible values: \"MAXIMUM\", \"MINIMUM\". Optional--defaults to \"MAXIMUM\". Cannot be specified without objectiveMetric. Cannot be modified when status is \"RUNNING\" or \"ENDED\"., parentLink: map{href: str, type: str} # Parent link for an experiment. Points to the view (profile) to which this experiment belongs., profileId: str # View (Profile) ID to which this experiment belongs. This field is read-only., reasonExperimentEnded: str # Why the experiment ended. Possible values: \"STOPPED_BY_USER\", \"WINNER_FOUND\", \"EXPERIMENT_EXPIRED\", \"ENDED_WITH_NO_WINNER\", \"GOAL_OBJECTIVE_CHANGED\". \"ENDED_WITH_NO_WINNER\" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only., rewriteVariationUrlsAsOriginal: bool # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED., selfLink: str # Link for this experiment. This field is read-only., servingFramework: str # The framework used to serve the experiment variations and evaluate the results. One of:   - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results., snippet: str # The snippet of code to include on the control page(s). This field is read-only., startTime: str(date-time) # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only., status: str # Experiment status. Possible values: \"DRAFT\", \"READY_TO_RUN\", \"RUNNING\", \"ENDED\". Experiments can be created in the \"DRAFT\", \"READY_TO_RUN\" or \"RUNNING\" state. This field is required when creating an experiment., trafficCoverage: num(double) # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED., updated: str(date-time) # Time the experiment was last modified. This field is read-only., variations: [map{name: str, status: str, url: str, weight: num(double), won: bool}] # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING., webPropertyId: str # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only., winnerConfidenceLevel: num(double) # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED., winnerFound: bool # Boolean specifying whether a winner has been found for this experiment. This field is read-only.}\n@returns(200) {accountId: str, created: str(date-time), description: str, editableInGaUi: bool, endTime: str(date-time), equalWeighting: bool, id: str, internalWebPropertyId: str, kind: str, minimumExperimentLengthInDays: int(int32), name: str, objectiveMetric: str, optimizationType: str, parentLink: map{href: str, type: str}, profileId: str, reasonExperimentEnded: str, rewriteVariationUrlsAsOriginal: bool, selfLink: str, servingFramework: str, snippet: str, startTime: str(date-time), status: str, trafficCoverage: num(double), updated: str(date-time), variations: [map], webPropertyId: str, winnerConfidenceLevel: num(double), winnerFound: bool} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals\n@desc Lists goals to which the user has access.\n@required {accountId: str # Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to., webPropertyId: str # Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to., profileId: str # View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.}\n@optional {max-results: int # The maximum number of goals to include in this response., start-index: int # An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals\n@desc Create a new goal.\n@required {accountId: str # Account ID to create the goal for., webPropertyId: str # Web property ID to create the goal for., profileId: str # View (Profile) ID to create the goal for.}\n@optional {accountId: str # Account ID to which this goal belongs., active: bool # Determines whether this goal is active., created: str(date-time) # Time this goal was created., eventDetails: map{eventConditions: [map], useEventValue: bool} # Details for the goal of the type EVENT., id: str # Goal ID., internalWebPropertyId: str # Internal ID for the web property to which this goal belongs., kind: str=analytics#goal # Resource type for an Analytics goal., name: str # Goal name., parentLink: map{href: str, type: str} # Parent link for a goal. Points to the view (profile) to which this goal belongs., profileId: str # View (Profile) ID to which this goal belongs., selfLink: str # Link for this goal., type: str # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT., updated: str(date-time) # Time this goal was last modified., urlDestinationDetails: map{caseSensitive: bool, firstStepRequired: bool, matchType: str, steps: [map], url: str} # Details for the goal of the type URL_DESTINATION., value: num(float) # Goal value., visitNumPagesDetails: map{comparisonType: str, comparisonValue: str(int64)} # Details for the goal of the type VISIT_NUM_PAGES., visitTimeOnSiteDetails: map{comparisonType: str, comparisonValue: str(int64)} # Details for the goal of the type VISIT_TIME_ON_SITE., webPropertyId: str # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), eventDetails: map{eventConditions: [map], useEventValue: bool}, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, profileId: str, selfLink: str, type: str, updated: str(date-time), urlDestinationDetails: map{caseSensitive: bool, firstStepRequired: bool, matchType: str, steps: [map], url: str}, value: num(float), visitNumPagesDetails: map{comparisonType: str, comparisonValue: str(int64)}, visitTimeOnSiteDetails: map{comparisonType: str, comparisonValue: str(int64)}, webPropertyId: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}\n@desc Gets a goal to which the user has access.\n@required {accountId: str # Account ID to retrieve the goal for., webPropertyId: str # Web property ID to retrieve the goal for., profileId: str # View (Profile) ID to retrieve the goal for., goalId: str # Goal ID to retrieve the goal for.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), eventDetails: map{eventConditions: [map], useEventValue: bool}, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, profileId: str, selfLink: str, type: str, updated: str(date-time), urlDestinationDetails: map{caseSensitive: bool, firstStepRequired: bool, matchType: str, steps: [map], url: str}, value: num(float), visitNumPagesDetails: map{comparisonType: str, comparisonValue: str(int64)}, visitTimeOnSiteDetails: map{comparisonType: str, comparisonValue: str(int64)}, webPropertyId: str} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}\n@desc Updates an existing goal. This method supports patch semantics.\n@required {accountId: str # Account ID to update the goal., webPropertyId: str # Web property ID to update the goal., profileId: str # View (Profile) ID to update the goal., goalId: str # Index of the goal to be updated.}\n@optional {accountId: str # Account ID to which this goal belongs., active: bool # Determines whether this goal is active., created: str(date-time) # Time this goal was created., eventDetails: map{eventConditions: [map], useEventValue: bool} # Details for the goal of the type EVENT., id: str # Goal ID., internalWebPropertyId: str # Internal ID for the web property to which this goal belongs., kind: str=analytics#goal # Resource type for an Analytics goal., name: str # Goal name., parentLink: map{href: str, type: str} # Parent link for a goal. Points to the view (profile) to which this goal belongs., profileId: str # View (Profile) ID to which this goal belongs., selfLink: str # Link for this goal., type: str # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT., updated: str(date-time) # Time this goal was last modified., urlDestinationDetails: map{caseSensitive: bool, firstStepRequired: bool, matchType: str, steps: [map], url: str} # Details for the goal of the type URL_DESTINATION., value: num(float) # Goal value., visitNumPagesDetails: map{comparisonType: str, comparisonValue: str(int64)} # Details for the goal of the type VISIT_NUM_PAGES., visitTimeOnSiteDetails: map{comparisonType: str, comparisonValue: str(int64)} # Details for the goal of the type VISIT_TIME_ON_SITE., webPropertyId: str # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), eventDetails: map{eventConditions: [map], useEventValue: bool}, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, profileId: str, selfLink: str, type: str, updated: str(date-time), urlDestinationDetails: map{caseSensitive: bool, firstStepRequired: bool, matchType: str, steps: [map], url: str}, value: num(float), visitNumPagesDetails: map{comparisonType: str, comparisonValue: str(int64)}, visitTimeOnSiteDetails: map{comparisonType: str, comparisonValue: str(int64)}, webPropertyId: str} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}\n@desc Updates an existing goal.\n@required {accountId: str # Account ID to update the goal., webPropertyId: str # Web property ID to update the goal., profileId: str # View (Profile) ID to update the goal., goalId: str # Index of the goal to be updated.}\n@optional {accountId: str # Account ID to which this goal belongs., active: bool # Determines whether this goal is active., created: str(date-time) # Time this goal was created., eventDetails: map{eventConditions: [map], useEventValue: bool} # Details for the goal of the type EVENT., id: str # Goal ID., internalWebPropertyId: str # Internal ID for the web property to which this goal belongs., kind: str=analytics#goal # Resource type for an Analytics goal., name: str # Goal name., parentLink: map{href: str, type: str} # Parent link for a goal. Points to the view (profile) to which this goal belongs., profileId: str # View (Profile) ID to which this goal belongs., selfLink: str # Link for this goal., type: str # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT., updated: str(date-time) # Time this goal was last modified., urlDestinationDetails: map{caseSensitive: bool, firstStepRequired: bool, matchType: str, steps: [map], url: str} # Details for the goal of the type URL_DESTINATION., value: num(float) # Goal value., visitNumPagesDetails: map{comparisonType: str, comparisonValue: str(int64)} # Details for the goal of the type VISIT_NUM_PAGES., visitTimeOnSiteDetails: map{comparisonType: str, comparisonValue: str(int64)} # Details for the goal of the type VISIT_TIME_ON_SITE., webPropertyId: str # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.}\n@returns(200) {accountId: str, active: bool, created: str(date-time), eventDetails: map{eventConditions: [map], useEventValue: bool}, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, profileId: str, selfLink: str, type: str, updated: str(date-time), urlDestinationDetails: map{caseSensitive: bool, firstStepRequired: bool, matchType: str, steps: [map], url: str}, value: num(float), visitNumPagesDetails: map{comparisonType: str, comparisonValue: str(int64)}, visitTimeOnSiteDetails: map{comparisonType: str, comparisonValue: str(int64)}, webPropertyId: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks\n@desc Lists all profile filter links for a profile.\n@required {accountId: str # Account ID to retrieve profile filter links for., webPropertyId: str # Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to., profileId: str # Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.}\n@optional {max-results: int # The maximum number of profile filter links to include in this response., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks\n@desc Create a new profile filter link.\n@required {accountId: str # Account ID to create profile filter link for., webPropertyId: str # Web property Id to create profile filter link for., profileId: str # Profile ID to create filter link for.}\n@optional {filterRef: map{accountId: str, href: str, id: str, kind: str, name: str} # JSON template for a profile filter link., id: str # Profile filter link ID., kind: str=analytics#profileFilterLink # Resource type for Analytics filter., profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str} # JSON template for a linked view (profile)., rank: int(int32) # The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1., selfLink: str # Link for this profile filter link.}\n@returns(200) {filterRef: map{accountId: str, href: str, id: str, kind: str, name: str}, id: str, kind: str, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, rank: int(int32), selfLink: str} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}\n@desc Delete a profile filter link.\n@required {accountId: str # Account ID to which the profile filter link belongs., webPropertyId: str # Web property Id to which the profile filter link belongs., profileId: str # Profile ID to which the filter link belongs., linkId: str # ID of the profile filter link to delete.}\n@returns(200) Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}\n@desc Returns a single profile filter link.\n@required {accountId: str # Account ID to retrieve profile filter link for., webPropertyId: str # Web property Id to retrieve profile filter link for., profileId: str # Profile ID to retrieve filter link for., linkId: str # ID of the profile filter link.}\n@returns(200) {filterRef: map{accountId: str, href: str, id: str, kind: str, name: str}, id: str, kind: str, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, rank: int(int32), selfLink: str} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}\n@desc Update an existing profile filter link. This method supports patch semantics.\n@required {accountId: str # Account ID to which profile filter link belongs., webPropertyId: str # Web property Id to which profile filter link belongs, profileId: str # Profile ID to which filter link belongs, linkId: str # ID of the profile filter link to be updated.}\n@optional {filterRef: map{accountId: str, href: str, id: str, kind: str, name: str} # JSON template for a profile filter link., id: str # Profile filter link ID., kind: str=analytics#profileFilterLink # Resource type for Analytics filter., profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str} # JSON template for a linked view (profile)., rank: int(int32) # The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1., selfLink: str # Link for this profile filter link.}\n@returns(200) {filterRef: map{accountId: str, href: str, id: str, kind: str, name: str}, id: str, kind: str, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, rank: int(int32), selfLink: str} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}\n@desc Update an existing profile filter link.\n@required {accountId: str # Account ID to which profile filter link belongs., webPropertyId: str # Web property Id to which profile filter link belongs, profileId: str # Profile ID to which filter link belongs, linkId: str # ID of the profile filter link to be updated.}\n@optional {filterRef: map{accountId: str, href: str, id: str, kind: str, name: str} # JSON template for a profile filter link., id: str # Profile filter link ID., kind: str=analytics#profileFilterLink # Resource type for Analytics filter., profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str} # JSON template for a linked view (profile)., rank: int(int32) # The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1., selfLink: str # Link for this profile filter link.}\n@returns(200) {filterRef: map{accountId: str, href: str, id: str, kind: str, name: str}, id: str, kind: str, profileRef: map{accountId: str, href: str, id: str, internalWebPropertyId: str, kind: str, name: str, webPropertyId: str}, rank: int(int32), selfLink: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports\n@desc Lists unsampled reports to which the user has access.\n@required {accountId: str # Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported., webPropertyId: str # Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported., profileId: str # View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.}\n@optional {max-results: int # The maximum number of unsampled reports to include in this response., start-index: int # An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports\n@desc Create a new unsampled report.\n@required {accountId: str # Account ID to create the unsampled report for., webPropertyId: str # Web property ID to create the unsampled report for., profileId: str # View (Profile) ID to create the unsampled report for.}\n@optional {accountId: str # Account ID to which this unsampled report belongs., cloudStorageDownloadDetails: map{bucketId: str, objectId: str} # Download details for a file stored in Google Cloud Storage., created: str(date-time) # Time this unsampled report was created., dimensions: str # The dimensions for the unsampled report., downloadType: str # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field., driveDownloadDetails: map{documentId: str} # Download details for a file stored in Google Drive., end-date: str # The end date for the unsampled report., filters: str # The filters for the unsampled report., id: str # Unsampled report ID., kind: str=analytics#unsampledReport # Resource type for an Analytics unsampled report., metrics: str # The metrics for the unsampled report., profileId: str # View (Profile) ID to which this unsampled report belongs., segment: str # The segment for the unsampled report., selfLink: str # Link for this unsampled report., start-date: str # The start date for the unsampled report., status: str # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED., title: str # Title of the unsampled report., updated: str(date-time) # Time this unsampled report was last modified., webPropertyId: str # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.}\n@returns(200) {accountId: str, cloudStorageDownloadDetails: map{bucketId: str, objectId: str}, created: str(date-time), dimensions: str, downloadType: str, driveDownloadDetails: map{documentId: str}, end-date: str, filters: str, id: str, kind: str, metrics: str, profileId: str, segment: str, selfLink: str, start-date: str, status: str, title: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}\n@desc Deletes an unsampled report.\n@required {accountId: str # Account ID to delete the unsampled report for., webPropertyId: str # Web property ID to delete the unsampled reports for., profileId: str # View (Profile) ID to delete the unsampled report for., unsampledReportId: str # ID of the unsampled report to be deleted.}\n@returns(200) Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}\n@desc Returns a single unsampled report.\n@required {accountId: str # Account ID to retrieve unsampled report for., webPropertyId: str # Web property ID to retrieve unsampled reports for., profileId: str # View (Profile) ID to retrieve unsampled report for., unsampledReportId: str # ID of the unsampled report to retrieve.}\n@returns(200) {accountId: str, cloudStorageDownloadDetails: map{bucketId: str, objectId: str}, created: str(date-time), dimensions: str, downloadType: str, driveDownloadDetails: map{documentId: str}, end-date: str, filters: str, id: str, kind: str, metrics: str, profileId: str, segment: str, selfLink: str, start-date: str, status: str, title: str, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences\n@desc Lists remarketing audiences to which the user has access.\n@required {accountId: str # The account ID of the remarketing audiences to retrieve., webPropertyId: str # The web property ID of the remarketing audiences to retrieve.}\n@optional {max-results: int # The maximum number of remarketing audiences to include in this response., start-index: int # An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter., type: str}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endpoint POST /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences\n@desc Creates a new remarketing audience.\n@required {accountId: str # The account ID for which to create the remarketing audience., webPropertyId: str # Web property ID for which to create the remarketing audience.}\n@optional {accountId: str # Account ID to which this remarketing audience belongs., audienceDefinition: map{includeConditions: map} # The simple audience definition that will cause a user to be added to an audience., audienceType: str # The type of audience, either SIMPLE or STATE_BASED., created: str(date-time) # Time this remarketing audience was created., description: str # The description of this remarketing audience., id: str # Remarketing Audience ID., internalWebPropertyId: str # Internal ID for the web property to which this remarketing audience belongs., kind: str=analytics#remarketingAudience # Collection type., linkedAdAccounts: [map{accountId: str, eligibleForSearch: bool, id: str, internalWebPropertyId: str, kind: str, linkedAccountId: str, remarketingAudienceId: str, status: str, type: str, webPropertyId: str}] # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently., linkedViews: [str] # The views (profiles) that this remarketing audience is linked to., name: str # The name of this remarketing audience., stateBasedAudienceDefinition: map{excludeConditions: map, includeConditions: map} # A state based audience definition that will cause a user to be added or removed from an audience., updated: str(date-time) # Time this remarketing audience was last modified., webPropertyId: str # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.}\n@returns(200) {accountId: str, audienceDefinition: map{includeConditions: map{daysToLookBack: int(int32), isSmartList: bool, kind: str, membershipDurationDays: int(int32), segment: str}}, audienceType: str, created: str(date-time), description: str, id: str, internalWebPropertyId: str, kind: str, linkedAdAccounts: [map], linkedViews: [str], name: str, stateBasedAudienceDefinition: map{excludeConditions: map{exclusionDuration: str, segment: str}, includeConditions: map{daysToLookBack: int(int32), isSmartList: bool, kind: str, membershipDurationDays: int(int32), segment: str}}, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint DELETE /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}\n@desc Delete a remarketing audience.\n@required {accountId: str # Account ID to which the remarketing audience belongs., webPropertyId: str # Web property ID to which the remarketing audience belongs., remarketingAudienceId: str # The ID of the remarketing audience to delete.}\n@returns(200) Successful response\n\n@endpoint GET /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}\n@desc Gets a remarketing audience to which the user has access.\n@required {accountId: str # The account ID of the remarketing audience to retrieve., webPropertyId: str # The web property ID of the remarketing audience to retrieve., remarketingAudienceId: str # The ID of the remarketing audience to retrieve.}\n@returns(200) {accountId: str, audienceDefinition: map{includeConditions: map{daysToLookBack: int(int32), isSmartList: bool, kind: str, membershipDurationDays: int(int32), segment: str}}, audienceType: str, created: str(date-time), description: str, id: str, internalWebPropertyId: str, kind: str, linkedAdAccounts: [map], linkedViews: [str], name: str, stateBasedAudienceDefinition: map{excludeConditions: map{exclusionDuration: str, segment: str}, includeConditions: map{daysToLookBack: int(int32), isSmartList: bool, kind: str, membershipDurationDays: int(int32), segment: str}}, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint PATCH /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}\n@desc Updates an existing remarketing audience. This method supports patch semantics.\n@required {accountId: str # The account ID of the remarketing audience to update., webPropertyId: str # The web property ID of the remarketing audience to update., remarketingAudienceId: str # The ID of the remarketing audience to update.}\n@optional {accountId: str # Account ID to which this remarketing audience belongs., audienceDefinition: map{includeConditions: map} # The simple audience definition that will cause a user to be added to an audience., audienceType: str # The type of audience, either SIMPLE or STATE_BASED., created: str(date-time) # Time this remarketing audience was created., description: str # The description of this remarketing audience., id: str # Remarketing Audience ID., internalWebPropertyId: str # Internal ID for the web property to which this remarketing audience belongs., kind: str=analytics#remarketingAudience # Collection type., linkedAdAccounts: [map{accountId: str, eligibleForSearch: bool, id: str, internalWebPropertyId: str, kind: str, linkedAccountId: str, remarketingAudienceId: str, status: str, type: str, webPropertyId: str}] # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently., linkedViews: [str] # The views (profiles) that this remarketing audience is linked to., name: str # The name of this remarketing audience., stateBasedAudienceDefinition: map{excludeConditions: map, includeConditions: map} # A state based audience definition that will cause a user to be added or removed from an audience., updated: str(date-time) # Time this remarketing audience was last modified., webPropertyId: str # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.}\n@returns(200) {accountId: str, audienceDefinition: map{includeConditions: map{daysToLookBack: int(int32), isSmartList: bool, kind: str, membershipDurationDays: int(int32), segment: str}}, audienceType: str, created: str(date-time), description: str, id: str, internalWebPropertyId: str, kind: str, linkedAdAccounts: [map], linkedViews: [str], name: str, stateBasedAudienceDefinition: map{excludeConditions: map{exclusionDuration: str, segment: str}, includeConditions: map{daysToLookBack: int(int32), isSmartList: bool, kind: str, membershipDurationDays: int(int32), segment: str}}, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint PUT /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}\n@desc Updates an existing remarketing audience.\n@required {accountId: str # The account ID of the remarketing audience to update., webPropertyId: str # The web property ID of the remarketing audience to update., remarketingAudienceId: str # The ID of the remarketing audience to update.}\n@optional {accountId: str # Account ID to which this remarketing audience belongs., audienceDefinition: map{includeConditions: map} # The simple audience definition that will cause a user to be added to an audience., audienceType: str # The type of audience, either SIMPLE or STATE_BASED., created: str(date-time) # Time this remarketing audience was created., description: str # The description of this remarketing audience., id: str # Remarketing Audience ID., internalWebPropertyId: str # Internal ID for the web property to which this remarketing audience belongs., kind: str=analytics#remarketingAudience # Collection type., linkedAdAccounts: [map{accountId: str, eligibleForSearch: bool, id: str, internalWebPropertyId: str, kind: str, linkedAccountId: str, remarketingAudienceId: str, status: str, type: str, webPropertyId: str}] # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently., linkedViews: [str] # The views (profiles) that this remarketing audience is linked to., name: str # The name of this remarketing audience., stateBasedAudienceDefinition: map{excludeConditions: map, includeConditions: map} # A state based audience definition that will cause a user to be added or removed from an audience., updated: str(date-time) # Time this remarketing audience was last modified., webPropertyId: str # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.}\n@returns(200) {accountId: str, audienceDefinition: map{includeConditions: map{daysToLookBack: int(int32), isSmartList: bool, kind: str, membershipDurationDays: int(int32), segment: str}}, audienceType: str, created: str(date-time), description: str, id: str, internalWebPropertyId: str, kind: str, linkedAdAccounts: [map], linkedViews: [str], name: str, stateBasedAudienceDefinition: map{excludeConditions: map{exclusionDuration: str, segment: str}, includeConditions: map{daysToLookBack: int(int32), isSmartList: bool, kind: str, membershipDurationDays: int(int32), segment: str}}, updated: str(date-time), webPropertyId: str} # Successful response\n\n@endpoint POST /management/clientId:hashClientId\n@desc Hashes the given Client ID.\n@optional {clientId: str, kind: str=analytics#hashClientIdRequest, webPropertyId: str}\n@returns(200) {clientId: str, hashedClientId: str, kind: str, webPropertyId: str} # Successful response\n\n@endpoint GET /management/segments\n@desc Lists segments to which the user has access.\n@optional {max-results: int # The maximum number of segments to include in this response., start-index: int # An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.}\n@returns(200) {items: [map], itemsPerPage: int(int32), kind: str, nextLink: str, previousLink: str, startIndex: int(int32), totalResults: int(int32), username: str} # Successful response\n\n@endgroup\n\n@group metadata\n@endpoint GET /metadata/{reportType}/columns\n@desc Lists all columns for a report type\n@required {reportType: str # Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API}\n@returns(200) {attributeNames: [str], etag: str, items: [map], kind: str, totalResults: int(int32)} # Successful response\n\n@endgroup\n\n@group provisioning\n@endpoint POST /provisioning/createAccountTicket\n@desc Creates an account ticket.\n@optional {account: map{childLink: map, created: str(date-time), id: str, kind: str, name: str, permissions: map, selfLink: str, starred: bool, updated: str(date-time)} # JSON template for Analytics account entry., id: str # Account ticket ID used to access the account ticket., kind: str=analytics#accountTicket # Resource type for account ticket., profile: map{accountId: str, botFilteringEnabled: bool, childLink: map, created: str(date-time), currency: str, defaultPage: str, eCommerceTracking: bool, enhancedECommerceTracking: bool, excludeQueryParameters: str, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map, permissions: map, selfLink: str, siteSearchCategoryParameters: str, siteSearchQueryParameters: str, starred: bool, stripSiteSearchCategoryParameters: bool, stripSiteSearchQueryParameters: bool, timezone: str, type: str, updated: str(date-time), webPropertyId: str, websiteUrl: str} # JSON template for an Analytics view (profile)., redirectUri: str # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL., webproperty: map{accountId: str, childLink: map, created: str(date-time), dataRetentionResetOnNewActivity: bool, dataRetentionTtl: str, defaultProfileId: str(int64), id: str, industryVertical: str, internalWebPropertyId: str, kind: str, level: str, name: str, parentLink: map, permissions: map, profileCount: int(int32), selfLink: str, starred: bool, updated: str(date-time), websiteUrl: str} # JSON template for an Analytics web property.}\n@returns(200) {account: map{childLink: map{href: str, type: str}, created: str(date-time), id: str, kind: str, name: str, permissions: map{effective: [str]}, selfLink: str, starred: bool, updated: str(date-time)}, id: str, kind: str, profile: map{accountId: str, botFilteringEnabled: bool, childLink: map{href: str, type: str}, created: str(date-time), currency: str, defaultPage: str, eCommerceTracking: bool, enhancedECommerceTracking: bool, excludeQueryParameters: str, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, selfLink: str, siteSearchCategoryParameters: str, siteSearchQueryParameters: str, starred: bool, stripSiteSearchCategoryParameters: bool, stripSiteSearchQueryParameters: bool, timezone: str, type: str, updated: str(date-time), webPropertyId: str, websiteUrl: str}, redirectUri: str, webproperty: map{accountId: str, childLink: map{href: str, type: str}, created: str(date-time), dataRetentionResetOnNewActivity: bool, dataRetentionTtl: str, defaultProfileId: str(int64), id: str, industryVertical: str, internalWebPropertyId: str, kind: str, level: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, profileCount: int(int32), selfLink: str, starred: bool, updated: str(date-time), websiteUrl: str}} # Successful response\n\n@endpoint POST /provisioning/createAccountTree\n@desc Provision account.\n@optional {accountName: str, kind: str=analytics#accountTreeRequest # Resource type for account ticket., profileName: str, timezone: str, webpropertyName: str, websiteUrl: str}\n@returns(200) {account: map{childLink: map{href: str, type: str}, created: str(date-time), id: str, kind: str, name: str, permissions: map{effective: [str]}, selfLink: str, starred: bool, updated: str(date-time)}, kind: str, profile: map{accountId: str, botFilteringEnabled: bool, childLink: map{href: str, type: str}, created: str(date-time), currency: str, defaultPage: str, eCommerceTracking: bool, enhancedECommerceTracking: bool, excludeQueryParameters: str, id: str, internalWebPropertyId: str, kind: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, selfLink: str, siteSearchCategoryParameters: str, siteSearchQueryParameters: str, starred: bool, stripSiteSearchCategoryParameters: bool, stripSiteSearchQueryParameters: bool, timezone: str, type: str, updated: str(date-time), webPropertyId: str, websiteUrl: str}, webproperty: map{accountId: str, childLink: map{href: str, type: str}, created: str(date-time), dataRetentionResetOnNewActivity: bool, dataRetentionTtl: str, defaultProfileId: str(int64), id: str, industryVertical: str, internalWebPropertyId: str, kind: str, level: str, name: str, parentLink: map{href: str, type: str}, permissions: map{effective: [str]}, profileCount: int(int32), selfLink: str, starred: bool, updated: str(date-time), websiteUrl: str}} # Successful response\n\n@endgroup\n\n@group userDeletion\n@endpoint POST /userDeletion/userDeletionRequests:upsert\n@desc Insert or update a user deletion requests.\n@optional {deletionRequestTime: str(date-time) # This marks the point in time for which all user data before should be deleted, firebaseProjectId: str # Firebase Project Id, id: map{type: str, userId: str} # User ID., kind: str=analytics#userDeletionRequest # Value is \"analytics#userDeletionRequest\"., propertyId: str # Property ID, webPropertyId: str # Web property ID of the form UA-XXXXX-YY.}\n@returns(200) {deletionRequestTime: str(date-time), firebaseProjectId: str, id: map{type: str, userId: str}, kind: str, propertyId: str, webPropertyId: str} # Successful response\n\n@endgroup\n\n@end\n"}