2026-05-14
▼ ▲ analytics.data.ga.get
Path : data/ga
HTTP Method : GET
Description : Returns Analytics data for a view (profile).
Parameters :
dimensions
Type : string
Description : A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
Pattern : (ga:.+)?
Location : query
end-date
Type : string
Description : 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.
Required : Yes
Pattern : [0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)
Location : query
filters
Type : string
Description : A comma-separated list of dimension or metric filters to be applied to Analytics data.
Pattern : ga:.+
Location : query
ids
Type : string
Description : Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
Required : Yes
Pattern : ga:[0-9]+
Location : query
include-empty-rows
Type : boolean
Description : The response will include empty rows if this parameter is set to true, the default is true
Location : query
max-results
Type : integer
Description : The maximum number of entries to include in this feed.
Format : int32
Location : query
metrics
Type : string
Description : A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.
Required : Yes
Pattern : ga:.+
Location : query
output
Type : string
Description : The selected format for the response. Default format is JSON.
Enum :
Enum Descriptions :
Location : query
samplingLevel
Type : string
Description : The desired sampling level.
Enum :
Enum Descriptions :
Location : query
segment
Type : string
Description : An Analytics segment to be applied to data.
Location : query
sort
Type : string
Description : A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
Pattern : (-)?ga:.+
Location : query
start-date
Type : string
Description : 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.
Required : Yes
Pattern : [0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)
Location : query
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
Parameter Order :
Scopes :
▼ ▲ analytics.data.mcf.get
Path : data/mcf
HTTP Method : GET
Description : Returns Analytics Multi-Channel Funnels data for a view (profile).
Parameters :
dimensions
Type : string
Description : A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
Pattern : (mcf:.+)?
Location : query
end-date
Type : string
Description : 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.
Required : Yes
Pattern : [0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)
Location : query
filters
Type : string
Description : A comma-separated list of dimension or metric filters to be applied to the Analytics data.
Pattern : mcf:.+
Location : query
ids
Type : string
Description : Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
Required : Yes
Pattern : ga:[0-9]+
Location : query
max-results
Type : integer
Description : The maximum number of entries to include in this feed.
Format : int32
Location : query
metrics
Type : string
Description : A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.
Required : Yes
Pattern : mcf:.+
Location : query
samplingLevel
Type : string
Description : The desired sampling level.
Enum :
Enum Descriptions :
Location : query
sort
Type : string
Description : A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
Pattern : (-)?mcf:.+
Location : query
start-date
Type : string
Description : 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.
Required : Yes
Pattern : [0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)
Location : query
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
Parameter Order :
Scopes :
▼ ▲ analytics.data.realtime.get
Path : data/realtime
HTTP Method : GET
Description : Returns real time data for a view (profile).
Parameters :
dimensions
Type : string
Description : A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.
Pattern : (ga:.+)|(rt:.+)
Location : query
filters
Type : string
Description : A comma-separated list of dimension or metric filters to be applied to real time data.
Pattern : (ga:.+)|(rt:.+)
Location : query
ids
Type : string
Description : Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
Required : Yes
Pattern : ga:[0-9]+
Location : query
max-results
Type : integer
Description : The maximum number of entries to include in this feed.
Format : int32
Location : query
metrics
Type : string
Description : A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.
Required : Yes
Pattern : (ga:.+)|(rt:.+)
Location : query
sort
Type : string
Description : A comma-separated list of dimensions or metrics that determine the sort order for real time data.
Pattern : (-)?((ga:.+)|(rt:.+))
Location : query
Parameter Order :
Scopes :
▼ ▲ analytics.management.accountSummaries.list
Path : management/accountSummaries
HTTP Method : GET
Description : Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.
Parameters :
max-results
Type : integer
Description : The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
Scopes :
▼ ▲ analytics.management.accountUserLinks.delete
Path : management/accounts/{accountId}/entityUserLinks/{linkId}
HTTP Method : DELETE
Description : Removes a user from the given account.
Parameters :
accountId
Type : string
Description : Account ID to delete the user link for.
Required : Yes
Location : path
linkId
Type : string
Description : Link ID to delete the user link for.
Required : Yes
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analytics.management.accountUserLinks.insert
Path : management/accounts/{accountId}/entityUserLinks
HTTP Method : POST
Description : Adds a new user to the given account.
Parameters :
accountId
Type : string
Description : Account ID to create the user link for.
Required : Yes
Location : path
Parameter Order : accountId
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analytics.management.accountUserLinks.list
Path : management/accounts/{accountId}/entityUserLinks
HTTP Method : GET
Description : Lists account-user links for a given account.
Parameters :
accountId
Type : string
Description : Account ID to retrieve the user links for.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of account-user links to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
Parameter Order : accountId
Scopes :
▼ ▲ analytics.management.accountUserLinks.update
Path : management/accounts/{accountId}/entityUserLinks/{linkId}
HTTP Method : PUT
Description : Updates permissions for an existing user on the given account.
Parameters :
accountId
Type : string
Description : Account ID to update the account-user link for.
Required : Yes
Location : path
linkId
Type : string
Description : Link ID to update the account-user link for.
Required : Yes
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analytics.management.accounts.list
Path : management/accounts
HTTP Method : GET
Description : Lists all accounts to which the user has access.
Parameters :
max-results
Type : integer
Description : The maximum number of accounts to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
Scopes :
▼ ▲ analytics.management.clientId.hashClientId
Path : management/clientId:hashClientId
HTTP Method : POST
Description : Hashes the given Client ID.
Scopes :
▼ ▲ analytics.management.customDataSources.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources
HTTP Method : GET
Description : List custom data sources to which the user has access.
Parameters :
accountId
Type : string
Description : Account Id for the custom data sources to retrieve.
Required : Yes
Pattern : \d+
Location : path
max-results
Type : integer
Description : The maximum number of custom data sources to include in this response.
Format : int32
Minimum : 1
Location : query
start-index
Type : integer
Description : 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.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : Web property Id for the custom data sources to retrieve.
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.customDimensions.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}
HTTP Method : GET
Description : Get a custom dimension to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID for the custom dimension to retrieve.
Required : Yes
Location : path
customDimensionId
Type : string
Description : The ID of the custom dimension to retrieve.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID for the custom dimension to retrieve.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.customDimensions.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions
HTTP Method : POST
Description : Create a new custom dimension.
Parameters :
accountId
Type : string
Description : Account ID for the custom dimension to create.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID for the custom dimension to create.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.customDimensions.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions
HTTP Method : GET
Description : Lists custom dimensions to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID for the custom dimensions to retrieve.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of custom dimensions to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : Web property ID for the custom dimensions to retrieve.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.customDimensions.patch
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}
HTTP Method : PATCH
Description : Updates an existing custom dimension. This method supports patch semantics.
Parameters :
accountId
Type : string
Description : Account ID for the custom dimension to update.
Required : Yes
Location : path
customDimensionId
Type : string
Description : Custom dimension ID for the custom dimension to update.
Required : Yes
Location : path
ignoreCustomDataSourceLinks
Type : boolean
Description : Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
Default : false
Location : query
webPropertyId
Type : string
Description : Web property ID for the custom dimension to update.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.customDimensions.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}
HTTP Method : PUT
Description : Updates an existing custom dimension.
Parameters :
accountId
Type : string
Description : Account ID for the custom dimension to update.
Required : Yes
Location : path
customDimensionId
Type : string
Description : Custom dimension ID for the custom dimension to update.
Required : Yes
Location : path
ignoreCustomDataSourceLinks
Type : boolean
Description : Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
Default : false
Location : query
webPropertyId
Type : string
Description : Web property ID for the custom dimension to update.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.customMetrics.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}
HTTP Method : GET
Description : Get a custom metric to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID for the custom metric to retrieve.
Required : Yes
Location : path
customMetricId
Type : string
Description : The ID of the custom metric to retrieve.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID for the custom metric to retrieve.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.customMetrics.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics
HTTP Method : POST
Description : Create a new custom metric.
Parameters :
accountId
Type : string
Description : Account ID for the custom metric to create.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID for the custom dimension to create.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.customMetrics.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics
HTTP Method : GET
Description : Lists custom metrics to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID for the custom metrics to retrieve.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of custom metrics to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : Web property ID for the custom metrics to retrieve.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.customMetrics.patch
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}
HTTP Method : PATCH
Description : Updates an existing custom metric. This method supports patch semantics.
Parameters :
accountId
Type : string
Description : Account ID for the custom metric to update.
Required : Yes
Location : path
customMetricId
Type : string
Description : Custom metric ID for the custom metric to update.
Required : Yes
Location : path
ignoreCustomDataSourceLinks
Type : boolean
Description : Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
Default : false
Location : query
webPropertyId
Type : string
Description : Web property ID for the custom metric to update.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.customMetrics.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}
HTTP Method : PUT
Description : Updates an existing custom metric.
Parameters :
accountId
Type : string
Description : Account ID for the custom metric to update.
Required : Yes
Location : path
customMetricId
Type : string
Description : Custom metric ID for the custom metric to update.
Required : Yes
Location : path
ignoreCustomDataSourceLinks
Type : boolean
Description : Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
Default : false
Location : query
webPropertyId
Type : string
Description : Web property ID for the custom metric to update.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.experiments.delete
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}
HTTP Method : DELETE
Description : Delete an experiment.
Parameters :
accountId
Type : string
Description : Account ID to which the experiment belongs
Required : Yes
Location : path
experimentId
Type : string
Description : ID of the experiment to delete
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to which the experiment belongs
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to which the experiment belongs
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.experiments.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}
HTTP Method : GET
Description : Returns an experiment to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID to retrieve the experiment for.
Required : Yes
Location : path
experimentId
Type : string
Description : Experiment ID to retrieve the experiment for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to retrieve the experiment for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to retrieve the experiment for.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.experiments.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments
HTTP Method : POST
Description : Create a new experiment.
Parameters :
accountId
Type : string
Description : Account ID to create the experiment for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to create the experiment for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to create the experiment for.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.experiments.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments
HTTP Method : GET
Description : Lists experiments to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID to retrieve experiments for.
Required : Yes
Pattern : \d+
Location : path
max-results
Type : integer
Description : The maximum number of experiments to include in this response.
Format : int32
Location : query
profileId
Type : string
Description : View (Profile) ID to retrieve experiments for.
Required : Yes
Pattern : \d+
Location : path
start-index
Type : integer
Description : An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : Web property ID to retrieve experiments for.
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.experiments.patch
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}
HTTP Method : PATCH
Description : Update an existing experiment. This method supports patch semantics.
Parameters :
accountId
Type : string
Description : Account ID of the experiment to update.
Required : Yes
Location : path
experimentId
Type : string
Description : Experiment ID of the experiment to update.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID of the experiment to update.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID of the experiment to update.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.experiments.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}
HTTP Method : PUT
Description : Update an existing experiment.
Parameters :
accountId
Type : string
Description : Account ID of the experiment to update.
Required : Yes
Location : path
experimentId
Type : string
Description : Experiment ID of the experiment to update.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID of the experiment to update.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID of the experiment to update.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.filters.delete
Path : management/accounts/{accountId}/filters/{filterId}
HTTP Method : DELETE
Description : Delete a filter.
Parameters :
accountId
Type : string
Description : Account ID to delete the filter for.
Required : Yes
Location : path
filterId
Type : string
Description : ID of the filter to be deleted.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.filters.get
Path : management/accounts/{accountId}/filters/{filterId}
HTTP Method : GET
Description : Returns filters to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID to retrieve filters for.
Required : Yes
Location : path
filterId
Type : string
Description : Filter ID to retrieve filters for.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.filters.insert
Path : management/accounts/{accountId}/filters
HTTP Method : POST
Description : Create a new filter.
Parameters :
accountId
Type : string
Description : Account ID to create filter for.
Required : Yes
Location : path
Parameter Order : accountId
▼ ▲ analytics.management.filters.list
Path : management/accounts/{accountId}/filters
HTTP Method : GET
Description : Lists all filters for an account
Parameters :
accountId
Type : string
Description : Account ID to retrieve filters for.
Required : Yes
Pattern : \d+
Location : path
max-results
Type : integer
Description : The maximum number of filters to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
Parameter Order : accountId
Scopes :
▼ ▲ analytics.management.filters.patch
Path : management/accounts/{accountId}/filters/{filterId}
HTTP Method : PATCH
Description : Updates an existing filter. This method supports patch semantics.
Parameters :
accountId
Type : string
Description : Account ID to which the filter belongs.
Required : Yes
Location : path
filterId
Type : string
Description : ID of the filter to be updated.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.filters.update
Path : management/accounts/{accountId}/filters/{filterId}
HTTP Method : PUT
Description : Updates an existing filter.
Parameters :
accountId
Type : string
Description : Account ID to which the filter belongs.
Required : Yes
Location : path
filterId
Type : string
Description : ID of the filter to be updated.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.goals.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}
HTTP Method : GET
Description : Gets a goal to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID to retrieve the goal for.
Required : Yes
Location : path
goalId
Type : string
Description : Goal ID to retrieve the goal for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to retrieve the goal for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to retrieve the goal for.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.goals.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals
HTTP Method : POST
Description : Create a new goal.
Parameters :
accountId
Type : string
Description : Account ID to create the goal for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to create the goal for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to create the goal for.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.goals.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals
HTTP Method : GET
Description : Lists goals to which the user has access.
Parameters :
accountId
Type : string
Description : 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.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of goals to include in this response.
Format : int32
Location : query
profileId
Type : string
Description : 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.
Required : Yes
Location : path
start-index
Type : integer
Description : An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : 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.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.goals.patch
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}
HTTP Method : PATCH
Description : Updates an existing goal. This method supports patch semantics.
Parameters :
accountId
Type : string
Description : Account ID to update the goal.
Required : Yes
Location : path
goalId
Type : string
Description : Index of the goal to be updated.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to update the goal.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to update the goal.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.goals.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}
HTTP Method : PUT
Description : Updates an existing goal.
Parameters :
accountId
Type : string
Description : Account ID to update the goal.
Required : Yes
Location : path
goalId
Type : string
Description : Index of the goal to be updated.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to update the goal.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to update the goal.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.profileFilterLinks.delete
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}
HTTP Method : DELETE
Description : Delete a profile filter link.
Parameters :
accountId
Type : string
Description : Account ID to which the profile filter link belongs.
Required : Yes
Pattern : \d+
Location : path
linkId
Type : string
Description : ID of the profile filter link to delete.
Required : Yes
Pattern : \d+:\d+
Location : path
profileId
Type : string
Description : Profile ID to which the filter link belongs.
Required : Yes
Pattern : \d+
Location : path
webPropertyId
Type : string
Description : Web property Id to which the profile filter link belongs.
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
▼ ▲ analytics.management.profileFilterLinks.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}
HTTP Method : GET
Description : Returns a single profile filter link.
Parameters :
accountId
Type : string
Description : Account ID to retrieve profile filter link for.
Required : Yes
Pattern : \d+
Location : path
linkId
Type : string
Description : ID of the profile filter link.
Required : Yes
Pattern : \d+:\d+
Location : path
profileId
Type : string
Description : Profile ID to retrieve filter link for.
Required : Yes
Pattern : \d+
Location : path
webPropertyId
Type : string
Description : Web property Id to retrieve profile filter link for.
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.profileFilterLinks.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks
HTTP Method : POST
Description : Create a new profile filter link.
Parameters :
accountId
Type : string
Description : Account ID to create profile filter link for.
Required : Yes
Pattern : \d+
Location : path
profileId
Type : string
Description : Profile ID to create filter link for.
Required : Yes
Pattern : \d+
Location : path
webPropertyId
Type : string
Description : Web property Id to create profile filter link for.
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
▼ ▲ analytics.management.profileFilterLinks.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks
HTTP Method : GET
Description : Lists all profile filter links for a profile.
Parameters :
accountId
Type : string
Description : Account ID to retrieve profile filter links for.
Required : Yes
Pattern : \d+
Location : path
max-results
Type : integer
Description : The maximum number of profile filter links to include in this response.
Format : int32
Location : query
profileId
Type : string
Description : 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.
Required : Yes
Location : path
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : 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.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.profileFilterLinks.patch
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}
HTTP Method : PATCH
Description : Update an existing profile filter link. This method supports patch semantics.
Parameters :
accountId
Type : string
Description : Account ID to which profile filter link belongs.
Required : Yes
Pattern : \d+
Location : path
linkId
Type : string
Description : ID of the profile filter link to be updated.
Required : Yes
Pattern : \d+:\d+
Location : path
profileId
Type : string
Description : Profile ID to which filter link belongs
Required : Yes
Pattern : \d+
Location : path
webPropertyId
Type : string
Description : Web property Id to which profile filter link belongs
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
▼ ▲ analytics.management.profileFilterLinks.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}
HTTP Method : PUT
Description : Update an existing profile filter link.
Parameters :
accountId
Type : string
Description : Account ID to which profile filter link belongs.
Required : Yes
Pattern : \d+
Location : path
linkId
Type : string
Description : ID of the profile filter link to be updated.
Required : Yes
Pattern : \d+:\d+
Location : path
profileId
Type : string
Description : Profile ID to which filter link belongs
Required : Yes
Pattern : \d+
Location : path
webPropertyId
Type : string
Description : Web property Id to which profile filter link belongs
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
▼ ▲ analytics.management.profileUserLinks.delete
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}
HTTP Method : DELETE
Description : Removes a user from the given view (profile).
Parameters :
accountId
Type : string
Description : Account ID to delete the user link for.
Required : Yes
Location : path
linkId
Type : string
Description : Link ID to delete the user link for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to delete the user link for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web Property ID to delete the user link for.
Required : Yes
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analytics.management.profileUserLinks.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks
HTTP Method : POST
Description : Adds a new user to the given view (profile).
Parameters :
accountId
Type : string
Description : Account ID to create the user link for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to create the user link for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web Property ID to create the user link for.
Required : Yes
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analytics.management.profileUserLinks.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks
HTTP Method : GET
Description : Lists profile-user links for a given view (profile).
Parameters :
accountId
Type : string
Description : Account ID which the given view (profile) belongs to.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of profile-user links to include in this response.
Format : int32
Location : query
profileId
Type : string
Description : 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.
Required : Yes
Location : path
start-index
Type : integer
Description : An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : 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.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.profileUserLinks.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}
HTTP Method : PUT
Description : Updates permissions for an existing user on the given view (profile).
Parameters :
accountId
Type : string
Description : Account ID to update the user link for.
Required : Yes
Location : path
linkId
Type : string
Description : Link ID to update the user link for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile ID) to update the user link for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web Property ID to update the user link for.
Required : Yes
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analytics.management.profiles.delete
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}
HTTP Method : DELETE
Description : Deletes a view (profile).
Parameters :
accountId
Type : string
Description : Account ID to delete the view (profile) for.
Required : Yes
Location : path
profileId
Type : string
Description : ID of the view (profile) to be deleted.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to delete the view (profile) for.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.profiles.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}
HTTP Method : GET
Description : Gets a view (profile) to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID to retrieve the view (profile) for.
Required : Yes
Pattern : [0-9]+
Location : path
profileId
Type : string
Description : View (Profile) ID to retrieve the view (profile) for.
Required : Yes
Pattern : [0-9]+
Location : path
webPropertyId
Type : string
Description : Web property ID to retrieve the view (profile) for.
Required : Yes
Pattern : UA-[0-9]+-[0-9]+
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.profiles.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles
HTTP Method : POST
Description : Create a new view (profile).
Parameters :
accountId
Type : string
Description : Account ID to create the view (profile) for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to create the view (profile) for.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.profiles.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles
HTTP Method : GET
Description : Lists views (profiles) to which the user has access.
Parameters :
accountId
Type : string
Description : 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.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of views (profiles) to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : 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.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.profiles.patch
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}
HTTP Method : PATCH
Description : Updates an existing view (profile). This method supports patch semantics.
Parameters :
accountId
Type : string
Description : Account ID to which the view (profile) belongs
Required : Yes
Location : path
profileId
Type : string
Description : ID of the view (profile) to be updated.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to which the view (profile) belongs
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.profiles.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}
HTTP Method : PUT
Description : Updates an existing view (profile).
Parameters :
accountId
Type : string
Description : Account ID to which the view (profile) belongs
Required : Yes
Location : path
profileId
Type : string
Description : ID of the view (profile) to be updated.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to which the view (profile) belongs
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.remarketingAudience.delete
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}
HTTP Method : DELETE
Description : Delete a remarketing audience.
Parameters :
accountId
Type : string
Description : Account ID to which the remarketing audience belongs.
Required : Yes
Location : path
remarketingAudienceId
Type : string
Description : The ID of the remarketing audience to delete.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to which the remarketing audience belongs.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.remarketingAudience.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}
HTTP Method : GET
Description : Gets a remarketing audience to which the user has access.
Parameters :
accountId
Type : string
Description : The account ID of the remarketing audience to retrieve.
Required : Yes
Location : path
remarketingAudienceId
Type : string
Description : The ID of the remarketing audience to retrieve.
Required : Yes
Location : path
webPropertyId
Type : string
Description : The web property ID of the remarketing audience to retrieve.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.remarketingAudience.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences
HTTP Method : POST
Description : Creates a new remarketing audience.
Parameters :
accountId
Type : string
Description : The account ID for which to create the remarketing audience.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID for which to create the remarketing audience.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.remarketingAudience.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences
HTTP Method : GET
Description : Lists remarketing audiences to which the user has access.
Parameters :
accountId
Type : string
Description : The account ID of the remarketing audiences to retrieve.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of remarketing audiences to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
type
Type : string
Default : all
Location : query
webPropertyId
Type : string
Description : The web property ID of the remarketing audiences to retrieve.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.remarketingAudience.patch
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}
HTTP Method : PATCH
Description : Updates an existing remarketing audience. This method supports patch semantics.
Parameters :
accountId
Type : string
Description : The account ID of the remarketing audience to update.
Required : Yes
Location : path
remarketingAudienceId
Type : string
Description : The ID of the remarketing audience to update.
Required : Yes
Location : path
webPropertyId
Type : string
Description : The web property ID of the remarketing audience to update.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.remarketingAudience.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}
HTTP Method : PUT
Description : Updates an existing remarketing audience.
Parameters :
accountId
Type : string
Description : The account ID of the remarketing audience to update.
Required : Yes
Location : path
remarketingAudienceId
Type : string
Description : The ID of the remarketing audience to update.
Required : Yes
Location : path
webPropertyId
Type : string
Description : The web property ID of the remarketing audience to update.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.segments.list
Path : management/segments
HTTP Method : GET
Description : Lists segments to which the user has access.
Parameters :
max-results
Type : integer
Description : The maximum number of segments to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
Scopes :
▼ ▲ analytics.management.unsampledReports.delete
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}
HTTP Method : DELETE
Description : Deletes an unsampled report.
Parameters :
accountId
Type : string
Description : Account ID to delete the unsampled report for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to delete the unsampled report for.
Required : Yes
Location : path
unsampledReportId
Type : string
Description : ID of the unsampled report to be deleted.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to delete the unsampled reports for.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.unsampledReports.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}
HTTP Method : GET
Description : Returns a single unsampled report.
Parameters :
accountId
Type : string
Description : Account ID to retrieve unsampled report for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to retrieve unsampled report for.
Required : Yes
Location : path
unsampledReportId
Type : string
Description : ID of the unsampled report to retrieve.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to retrieve unsampled reports for.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.unsampledReports.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports
HTTP Method : POST
Description : Create a new unsampled report.
Parameters :
accountId
Type : string
Description : Account ID to create the unsampled report for.
Required : Yes
Location : path
profileId
Type : string
Description : View (Profile) ID to create the unsampled report for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to create the unsampled report for.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.unsampledReports.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports
HTTP Method : GET
Description : Lists unsampled reports to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of unsampled reports to include in this response.
Format : int32
Location : query
profileId
Type : string
Description : View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.
Required : Yes
Location : path
start-index
Type : integer
Description : An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.uploads.deleteUploadData
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData
HTTP Method : POST
Description : Delete data associated with a previous upload.
Parameters :
accountId
Type : string
Description : Account Id for the uploads to be deleted.
Required : Yes
Pattern : \d+
Location : path
customDataSourceId
Type : string
Description : Custom data source Id for the uploads to be deleted.
Required : Yes
Pattern : .{22}
Location : path
webPropertyId
Type : string
Description : Web property Id for the uploads to be deleted.
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.uploads.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}
HTTP Method : GET
Description : List uploads to which the user has access.
Parameters :
accountId
Type : string
Description : Account Id for the upload to retrieve.
Required : Yes
Pattern : \d+
Location : path
customDataSourceId
Type : string
Description : Custom data source Id for upload to retrieve.
Required : Yes
Pattern : .{22}
Location : path
uploadId
Type : string
Description : Upload Id to retrieve.
Required : Yes
Pattern : .{22}
Location : path
webPropertyId
Type : string
Description : Web property Id for the upload to retrieve.
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.uploads.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads
HTTP Method : GET
Description : List uploads to which the user has access.
Parameters :
accountId
Type : string
Description : Account Id for the uploads to retrieve.
Required : Yes
Pattern : \d+
Location : path
customDataSourceId
Type : string
Description : Custom data source Id for uploads to retrieve.
Required : Yes
Pattern : .{22}
Location : path
max-results
Type : integer
Description : The maximum number of uploads to include in this response.
Format : int32
Minimum : 1
Location : query
start-index
Type : integer
Description : A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : Web property Id for the uploads to retrieve.
Required : Yes
Pattern : UA-(\d+)-(\d+)
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.uploads.uploadData
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads
HTTP Method : POST
Description : Upload data for a custom data source.
Parameters :
accountId
Type : string
Description : Account Id associated with the upload.
Required : Yes
Pattern : \d+
Location : path
customDataSourceId
Type : string
Description : Custom data source Id to which the data being uploaded belongs.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property UA-string associated with the upload.
Required : Yes
Pattern : UA-\d+-\d+
Location : path
Parameter Order :
Scopes :
Supportsmediaupload : Yes
Mediaupload :
Accept : application/octet-stream
Maxsize : 1GB
Protocols :
Simple :
Multipart : Yes
Path : /upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads
Resumable :
Multipart : Yes
Path : /resumable/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads
▼ ▲ analytics.management.webPropertyAdWordsLinks.delete
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}
HTTP Method : DELETE
Description : Deletes a web property-Google Ads link.
Parameters :
accountId
Type : string
Description : ID of the account which the given web property belongs to.
Required : Yes
Location : path
webPropertyAdWordsLinkId
Type : string
Description : Web property Google Ads link ID.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to delete the Google Ads link for.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.webPropertyAdWordsLinks.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}
HTTP Method : GET
Description : Returns a web property-Google Ads link to which the user has access.
Parameters :
accountId
Type : string
Description : ID of the account which the given web property belongs to.
Required : Yes
Location : path
webPropertyAdWordsLinkId
Type : string
Description : Web property-Google Ads link ID.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to retrieve the Google Ads link for.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.webPropertyAdWordsLinks.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks
HTTP Method : POST
Description : Creates a webProperty-Google Ads link.
Parameters :
accountId
Type : string
Description : ID of the Google Analytics account to create the link for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to create the link for.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.webPropertyAdWordsLinks.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks
HTTP Method : GET
Description : Lists webProperty-Google Ads links for a given web property.
Parameters :
accountId
Type : string
Description : ID of the account which the given web property belongs to.
Required : Yes
Pattern : \d+
Location : path
max-results
Type : integer
Description : The maximum number of webProperty-Google Ads links to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : Web property ID to retrieve the Google Ads links for.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.webPropertyAdWordsLinks.patch
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}
HTTP Method : PATCH
Description : Updates an existing webProperty-Google Ads link. This method supports patch semantics.
Parameters :
accountId
Type : string
Description : ID of the account which the given web property belongs to.
Required : Yes
Location : path
webPropertyAdWordsLinkId
Type : string
Description : Web property-Google Ads link ID.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to retrieve the Google Ads link for.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.webPropertyAdWordsLinks.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}
HTTP Method : PUT
Description : Updates an existing webProperty-Google Ads link.
Parameters :
accountId
Type : string
Description : ID of the account which the given web property belongs to.
Required : Yes
Location : path
webPropertyAdWordsLinkId
Type : string
Description : Web property-Google Ads link ID.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to retrieve the Google Ads link for.
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.webproperties.get
Path : management/accounts/{accountId}/webproperties/{webPropertyId}
HTTP Method : GET
Description : Gets a web property to which the user has access.
Parameters :
accountId
Type : string
Description : Account ID to retrieve the web property for.
Required : Yes
Pattern : [0-9]+
Location : path
webPropertyId
Type : string
Description : ID to retrieve the web property for.
Required : Yes
Pattern : UA-[0-9]+-[0-9]+
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.webproperties.insert
Path : management/accounts/{accountId}/webproperties
HTTP Method : POST
Description : 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.
Parameters :
accountId
Type : string
Description : Account ID to create the web property for.
Required : Yes
Location : path
Parameter Order : accountId
▼ ▲ analytics.management.webproperties.list
Path : management/accounts/{accountId}/webproperties
HTTP Method : GET
Description : Lists web properties to which the user has access.
Parameters :
accountId
Type : string
Description : 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.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of web properties to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
Parameter Order : accountId
Scopes :
▼ ▲ analytics.management.webproperties.patch
Path : management/accounts/{accountId}/webproperties/{webPropertyId}
HTTP Method : PATCH
Description : Updates an existing web property. This method supports patch semantics.
Parameters :
accountId
Type : string
Description : Account ID to which the web property belongs
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.webproperties.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}
HTTP Method : PUT
Description : Updates an existing web property.
Parameters :
accountId
Type : string
Description : Account ID to which the web property belongs
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID
Required : Yes
Location : path
Parameter Order :
▼ ▲ analytics.management.webpropertyUserLinks.delete
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}
HTTP Method : DELETE
Description : Removes a user from the given web property.
Parameters :
accountId
Type : string
Description : Account ID to delete the user link for.
Required : Yes
Location : path
linkId
Type : string
Description : Link ID to delete the user link for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web Property ID to delete the user link for.
Required : Yes
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analytics.management.webpropertyUserLinks.insert
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks
HTTP Method : POST
Description : Adds a new user to the given web property.
Parameters :
accountId
Type : string
Description : Account ID to create the user link for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web Property ID to create the user link for.
Required : Yes
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analytics.management.webpropertyUserLinks.list
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks
HTTP Method : GET
Description : Lists webProperty-user links for a given web property.
Parameters :
accountId
Type : string
Description : Account ID which the given web property belongs to.
Required : Yes
Location : path
max-results
Type : integer
Description : The maximum number of webProperty-user Links to include in this response.
Format : int32
Location : query
start-index
Type : integer
Description : An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Format : int32
Minimum : 1
Location : query
webPropertyId
Type : string
Description : 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.
Required : Yes
Location : path
Parameter Order :
Scopes :
▼ ▲ analytics.management.webpropertyUserLinks.update
Path : management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}
HTTP Method : PUT
Description : Updates permissions for an existing user on the given web property.
Parameters :
accountId
Type : string
Description : Account ID to update the account-user link for.
Required : Yes
Location : path
linkId
Type : string
Description : Link ID to update the account-user link for.
Required : Yes
Location : path
webPropertyId
Type : string
Description : Web property ID to update the account-user link for.
Required : Yes
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analytics.metadata.columns.list
Path : metadata/{reportType}/columns
HTTP Method : GET
Description : Lists all columns for a report type
Parameters :
reportType
Type : string
Description : Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API
Required : Yes
Pattern : ga
Location : path
Parameter Order : reportType
Scopes :
▼ ▲ analytics.provisioning.createAccountTicket
Path : provisioning/createAccountTicket
HTTP Method : POST
Description : Creates an account ticket.
Scopes : https://www.googleapis.com/auth/analytics.provision
▼ ▲ analytics.provisioning.createAccountTree
Path : provisioning/createAccountTree
HTTP Method : POST
Description : Provision account.
Scopes : https://www.googleapis.com/auth/analytics.provision
▼ ▲ analytics.userDeletion.userDeletionRequest.upsert
Path : userDeletion/userDeletionRequests:upsert
HTTP Method : POST
Description : Insert or update a user deletion requests.
Scopes : https://www.googleapis.com/auth/analytics.user.deletion