Google Analytics API
  1. management
Google Analytics API
  • data
    • /data/ga
    • /data/mcf
    • /data/realtime
  • management
    • /management/accountSummaries
      GET
    • /management/accounts
      GET
    • /management/accounts/{accountId}/entityUserLinks
      GET
    • /management/accounts/{accountId}/entityUserLinks
      POST
    • /management/accounts/{accountId}/entityUserLinks/{linkId}
      DELETE
    • /management/accounts/{accountId}/entityUserLinks/{linkId}
      PUT
    • /management/accounts/{accountId}/filters
      GET
    • /management/accounts/{accountId}/filters
      POST
    • /management/accounts/{accountId}/filters/{filterId}
      DELETE
    • /management/accounts/{accountId}/filters/{filterId}
      GET
    • /management/accounts/{accountId}/filters/{filterId}
      PATCH
    • /management/accounts/{accountId}/filters/{filterId}
      PUT
    • /management/accounts/{accountId}/webproperties
      GET
    • /management/accounts/{accountId}/webproperties
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}
      PATCH
    • /management/accounts/{accountId}/webproperties/{webPropertyId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}
      PATCH
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}
      PATCH
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}
      DELETE
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}
      PATCH
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}
      DELETE
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}
      DELETE
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}
      PATCH
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}
      DELETE
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}
      DELETE
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}
      PATCH
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}
      PATCH
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}
      DELETE
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}
      PATCH
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}
      PUT
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}
      DELETE
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences
      POST
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}
      DELETE
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}
      GET
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}
      PATCH
    • /management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}
      PUT
    • /management/clientId:hashClientId
      POST
    • /management/segments
      GET
  • metadata
    • /metadata/{reportType}/columns
  • provisioning
    • /provisioning/createAccountTicket
    • /provisioning/createAccountTree
  • userDeletion
    • /userDeletion/userDeletionRequests:upsert
  1. management

/management/accounts/{accountId}/webproperties/{webPropertyId}

PATCH
/management/accounts/{accountId}/webproperties/{webPropertyId}
management
Updates an existing web property. This method supports patch semantics.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://analytics.googleapis.com/analytics/v3/management/accounts//webproperties/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": "string",
    "childLink": {
        "href": "string",
        "type": "analytics#profiles"
    },
    "dataRetentionResetOnNewActivity": true,
    "dataRetentionTtl": "string",
    "defaultProfileId": "string",
    "id": "string",
    "industryVertical": "string",
    "name": "string",
    "parentLink": {
        "href": "string",
        "type": "analytics#account"
    },
    "permissions": {},
    "starred": true,
    "websiteUrl": "string"
}'
Response Response Example
{
    "accountId": "string",
    "childLink": {
        "href": "string",
        "type": "analytics#profiles"
    },
    "created": "2019-08-24T14:15:22Z",
    "dataRetentionResetOnNewActivity": true,
    "dataRetentionTtl": "string",
    "defaultProfileId": "string",
    "id": "string",
    "industryVertical": "string",
    "internalWebPropertyId": "string",
    "kind": "analytics#webproperty",
    "level": "string",
    "name": "string",
    "parentLink": {
        "href": "string",
        "type": "analytics#account"
    },
    "permissions": {
        "effective": [
            "string"
        ]
    },
    "profileCount": 0,
    "selfLink": "string",
    "starred": true,
    "updated": "2019-08-24T14:15:22Z",
    "websiteUrl": "string"
}

Request

Path Params
accountId
string 
required
Account ID to which the web property belongs
webPropertyId
string 
required
Web property ID
Body Params application/json
JSON template for an Analytics web property.
accountId
string 
optional
Account ID to which this web property belongs.
childLink
object 
optional
Child link for this web property. Points to the list of views (profiles) for this web property.
href
string 
optional
Link to the list of views (profiles) for this web property.
type
string 
optional
Type of the parent link. Its value is "analytics#profiles".
Default:
analytics#profiles
dataRetentionResetOnNewActivity
boolean 
optional
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
string 
optional
The length of time for which user and event data is retained.
This property cannot be set on insert.
defaultProfileId
string <int64>
optional
Default view (profile) ID.
id
string 
optional
Web property ID of the form UA-XXXXX-YY.
industryVertical
string 
optional
The industry vertical/category selected for this web property.
name
string 
optional
Name of this web property.
parentLink
object 
optional
Parent link for this web property. Points to the account to which this web property belongs.
href
string 
optional
Link to the account for this web property.
type
string 
optional
Type of the parent link. Its value is "analytics#account".
Default:
analytics#account
permissions
object 
optional
Permissions the user has for this web property.
starred
boolean 
optional
Indicates whether this web property is starred or not.
websiteUrl
string 
optional
Website url for this web property.
Examples

Responses

🟢200Successful response
application/json
Body
JSON template for an Analytics web property.
accountId
string 
optional
Account ID to which this web property belongs.
childLink
object 
optional
Child link for this web property. Points to the list of views (profiles) for this web property.
href
string 
optional
Link to the list of views (profiles) for this web property.
type
string 
optional
Type of the parent link. Its value is "analytics#profiles".
Default:
analytics#profiles
created
string <date-time>
read-onlyoptional
Time this web property was created.
dataRetentionResetOnNewActivity
boolean 
optional
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
string 
optional
The length of time for which user and event data is retained.
This property cannot be set on insert.
defaultProfileId
string <int64>
optional
Default view (profile) ID.
id
string 
optional
Web property ID of the form UA-XXXXX-YY.
industryVertical
string 
optional
The industry vertical/category selected for this web property.
internalWebPropertyId
string 
read-onlyoptional
Internal ID for this web property.
kind
string 
read-onlyoptional
Resource type for Analytics WebProperty.
Default:
analytics#webproperty
level
string 
read-onlyoptional
Level for this web property. Possible values are STANDARD or PREMIUM.
name
string 
optional
Name of this web property.
parentLink
object 
optional
Parent link for this web property. Points to the account to which this web property belongs.
href
string 
optional
Link to the account for this web property.
type
string 
optional
Type of the parent link. Its value is "analytics#account".
Default:
analytics#account
permissions
object 
optional
Permissions the user has for this web property.
effective
array[string]
read-onlyoptional
All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
profileCount
integer <int32>
read-onlyoptional
View (Profile) count for this web property.
selfLink
string 
read-onlyoptional
Link for this web property.
starred
boolean 
optional
Indicates whether this web property is starred or not.
updated
string <date-time>
read-onlyoptional
Time this web property was last modified.
websiteUrl
string 
optional
Website url for this web property.
Previous
/management/accounts/{accountId}/webproperties/{webPropertyId}
Next
/management/accounts/{accountId}/webproperties/{webPropertyId}
Built with