Resources
data
Returns Analytics data for a view (profile).
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
start-date
|
string |
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. |
sort
|
string |
A comma-separated list of dimensions or metrics that determine the sort order for Analytics data. |
segment
|
string |
An Analytics segment to be applied to data. |
samplingLevel
|
string Allowed values: - DEFAULT- FASTER- HIGHER_PRECISION |
The desired sampling level. |
output
|
string Allowed values: - dataTable- json |
The selected format for the response. Default format is JSON. |
metrics
|
string |
A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. |
max-results
|
integer |
The maximum number of entries to include in this feed. |
include-empty-rows
|
boolean |
The response will include empty rows if this parameter is set to true, the default is true |
ids
|
string |
Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. |
filters
|
string |
A comma-separated list of dimension or metric filters to be applied to Analytics data. |
end-date
|
string |
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. |
dimensions
|
string |
A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GaData
|
object |
Analytics data for a given view (profile). |
Properties
totalsForAllResults
|
object |
Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. |
totalResults
|
integer |
The total number of rows for the query, regardless of the number of rows in the response. |
selfLink
|
string |
Link to this page. |
sampleSpace
|
string |
Total size of the sample space from which the samples were selected. |
sampleSize
|
string |
The number of samples used to calculate the result. |
rows
|
array [array] |
Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. |
query
|
||
profileInfo
|
||
previousLink
|
string |
Link to previous page for this Analytics data query. |
nextLink
|
string |
Link to next page for this Analytics data query. |
kind
|
string Default value: analytics#gaData
|
Resource type. |
itemsPerPage
|
integer |
The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
id
|
string |
Unique ID for this data response. |
dataTable
|
||
dataLastRefreshed
|
string |
The last refreshed time in seconds for Analytics data. |
containsSampledData
|
boolean |
Determines if Analytics data contains samples. |
columnHeaders
|
array [object] |
Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. |
Returns Analytics Multi-Channel Funnels data for a view (profile).
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
start-date
|
string |
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. |
sort
|
string |
A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data. |
samplingLevel
|
string Allowed values: - DEFAULT- FASTER- HIGHER_PRECISION |
The desired sampling level. |
metrics
|
string |
A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. |
max-results
|
integer |
The maximum number of entries to include in this feed. |
ids
|
string |
Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. |
filters
|
string |
A comma-separated list of dimension or metric filters to be applied to the Analytics data. |
end-date
|
string |
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. |
dimensions
|
string |
A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
McfData
|
object |
Multi-Channel Funnels data for a given view (profile). |
Properties
totalsForAllResults
|
object |
Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. |
totalResults
|
integer |
The total number of rows for the query, regardless of the number of rows in the response. |
selfLink
|
string |
Link to this page. |
sampleSpace
|
string |
Total size of the sample space from which the samples were selected. |
sampleSize
|
string |
The number of samples used to calculate the result. |
rows
|
array [array] |
Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. |
query
|
||
profileInfo
|
||
previousLink
|
string |
Link to previous page for this Analytics data query. |
nextLink
|
string |
Link to next page for this Analytics data query. |
kind
|
string Default value: analytics#mcfData
|
Resource type. |
itemsPerPage
|
integer |
The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
id
|
string |
Unique ID for this data response. |
containsSampledData
|
boolean |
Determines if the Analytics data contains sampled data. |
columnHeaders
|
array [object] |
Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. |
Returns real time data for a view (profile).
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
sort
|
string |
A comma-separated list of dimensions or metrics that determine the sort order for real time data. |
metrics
|
string |
A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified. |
max-results
|
integer |
The maximum number of entries to include in this feed. |
ids
|
string |
Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. |
filters
|
string |
A comma-separated list of dimension or metric filters to be applied to real time data. |
dimensions
|
string |
A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
RealtimeData
|
object |
Real time data for a given view (profile). |
Properties
totalsForAllResults
|
object |
Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. |
totalResults
|
integer |
The total number of rows for the query, regardless of the number of rows in the response. |
selfLink
|
string |
Link to this page. |
rows
|
array [array] |
Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. |
query
|
||
profileInfo
|
||
kind
|
string Default value: analytics#realtimeData
|
Resource type. |
id
|
string |
Unique ID for this data response. |
columnHeaders
|
array [object] |
Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. |
management
Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
max-results
|
integer |
The maximum number of account summaries to include in this response, where the largest acceptable value is 1000. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AccountSummaries
|
object |
An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary. |
Properties
username
|
string |
Email ID of the authenticated user |
||||||||||||||||||||||||||||||||||||||||||||||||||
totalResults
|
integer |
The total number of results for the query, regardless of the number of results in the response. |
||||||||||||||||||||||||||||||||||||||||||||||||||
startIndex
|
integer |
The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
||||||||||||||||||||||||||||||||||||||||||||||||||
previousLink
|
string |
Link to previous page for this AccountSummary collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string |
Link to next page for this AccountSummary collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: analytics#accountSummaries
|
Collection type. |
||||||||||||||||||||||||||||||||||||||||||||||||||
itemsPerPage
|
integer |
The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [AccountSummary] |
A list of AccountSummaries. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
Removes a user from the given account.
Request
Path
| Name | Data Type | Description |
|---|---|---|
linkId
|
string |
Link ID to delete the user link for. |
accountId
|
string |
Account ID to delete the user link for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Updates permissions for an existing user on the given account.
Request
Path
| Name | Data Type | Description |
|---|---|---|
linkId
|
string |
Link ID to update the account-user link for. |
accountId
|
string |
Account ID to update the account-user link for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLink
|
object |
JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. |
Properties
userRef
|
UserRef |
User reference. |
|||||||||||||
Properties
|
|||||||||||||||
selfLink
|
string |
Self link for this resource. |
|||||||||||||
permissions
|
|||||||||||||||
kind
|
string Default value: analytics#entityUserLink
|
Resource type for entity user link. |
|||||||||||||
id
|
string |
Entity user link ID |
|||||||||||||
entity
|
|||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLink
|
object |
JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. |
Properties
userRef
|
UserRef |
User reference. |
|||||||||||||
Properties
|
|||||||||||||||
selfLink
|
string |
Self link for this resource. |
|||||||||||||
permissions
|
|||||||||||||||
kind
|
string Default value: analytics#entityUserLink
|
Resource type for entity user link. |
|||||||||||||
id
|
string |
Entity user link ID |
|||||||||||||
entity
|
|||||||||||||||
Lists account-user links for a given account.
Request
Path
| Name | Data Type | Description |
|---|---|---|
accountId
|
string |
Account ID to retrieve the user links for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
max-results
|
integer |
The maximum number of account-user links to include in this response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLinks
|
object |
An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link. |
Properties
totalResults
|
integer |
The total number of results for the query, regardless of the number of results in the response. |
||||||||||||||||||||||||||||||||||||||
startIndex
|
integer |
The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. |
||||||||||||||||||||||||||||||||||||||
previousLink
|
string |
Previous link for this account collection. |
||||||||||||||||||||||||||||||||||||||
nextLink
|
string |
Next link for this account collection. |
||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: analytics#entityUserLinks
|
Collection type. |
||||||||||||||||||||||||||||||||||||||
itemsPerPage
|
integer |
The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
||||||||||||||||||||||||||||||||||||||
items
|
array [EntityUserLink] |
A list of entity user links. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
Adds a new user to the given account.
Request
Path
| Name | Data Type | Description |
|---|---|---|
accountId
|
string |
Account ID to create the user link for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLink
|
object |
JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. |
Properties
userRef
|
UserRef |
User reference. |
|||||||||||||
Properties
|
|||||||||||||||
selfLink
|
string |
Self link for this resource. |
|||||||||||||
permissions
|
|||||||||||||||
kind
|
string Default value: analytics#entityUserLink
|
Resource type for entity user link. |
|||||||||||||
id
|
string |
Entity user link ID |
|||||||||||||
entity
|
|||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLink
|
object |
JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. |
Properties
userRef
|
UserRef |
User reference. |
|||||||||||||
Properties
|
|||||||||||||||
selfLink
|
string |
Self link for this resource. |
|||||||||||||
permissions
|
|||||||||||||||
kind
|
string Default value: analytics#entityUserLink
|
Resource type for entity user link. |
|||||||||||||
id
|
string |
Entity user link ID |
|||||||||||||
entity
|
|||||||||||||||
Delete a filter.
Request
Path
| Name | Data Type | Description |
|---|---|---|
filterId
|
string |
ID of the filter to be deleted. |
accountId
|
string |
Account ID to delete the filter for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Filter
|
object |
JSON template for an Analytics account filter. |
Properties
uppercaseDetails
|
||||||||||||||||||||||||
updated
|
dateTime Read-only |
Time this filter was last modified. |
||||||||||||||||||||||
type
|
string |
Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
||||||||||||||||||||||
selfLink
|
string Read-only |
Link for this filter. |
||||||||||||||||||||||
searchAndReplaceDetails
|
||||||||||||||||||||||||
parentLink
|
||||||||||||||||||||||||
name
|
string |
Name of this filter. |
||||||||||||||||||||||
lowercaseDetails
|
||||||||||||||||||||||||
kind
|
string Read-only Default value: analytics#filter
|
Resource type for Analytics filter. |
||||||||||||||||||||||
includeDetails
|
FilterExpression |
Details for the filter of the type INCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
id
|
string |
Filter ID. |
||||||||||||||||||||||
excludeDetails
|
FilterExpression |
Details for the filter of the type EXCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
created
|
dateTime Read-only |
Time this filter was created. |
||||||||||||||||||||||
advancedDetails
|
||||||||||||||||||||||||
accountId
|
string |
Account ID to which this filter belongs. |
||||||||||||||||||||||
Returns filters to which the user has access.
Request
Path
| Name | Data Type | Description |
|---|---|---|
filterId
|
string |
Filter ID to retrieve filters for. |
accountId
|
string |
Account ID to retrieve filters for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Filter
|
object |
JSON template for an Analytics account filter. |
Properties
uppercaseDetails
|
||||||||||||||||||||||||
updated
|
dateTime Read-only |
Time this filter was last modified. |
||||||||||||||||||||||
type
|
string |
Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
||||||||||||||||||||||
selfLink
|
string Read-only |
Link for this filter. |
||||||||||||||||||||||
searchAndReplaceDetails
|
||||||||||||||||||||||||
parentLink
|
||||||||||||||||||||||||
name
|
string |
Name of this filter. |
||||||||||||||||||||||
lowercaseDetails
|
||||||||||||||||||||||||
kind
|
string Read-only Default value: analytics#filter
|
Resource type for Analytics filter. |
||||||||||||||||||||||
includeDetails
|
FilterExpression |
Details for the filter of the type INCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
id
|
string |
Filter ID. |
||||||||||||||||||||||
excludeDetails
|
FilterExpression |
Details for the filter of the type EXCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
created
|
dateTime Read-only |
Time this filter was created. |
||||||||||||||||||||||
advancedDetails
|
||||||||||||||||||||||||
accountId
|
string |
Account ID to which this filter belongs. |
||||||||||||||||||||||
Updates an existing filter. This method supports patch semantics.
Request
Path
| Name | Data Type | Description |
|---|---|---|
filterId
|
string |
ID of the filter to be updated. |
accountId
|
string |
Account ID to which the filter belongs. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
Filter
|
object |
JSON template for an Analytics account filter. |
Properties
uppercaseDetails
|
||||||||||||||||||||||||
updated
|
dateTime Read-only |
Time this filter was last modified. |
||||||||||||||||||||||
type
|
string |
Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
||||||||||||||||||||||
selfLink
|
string Read-only |
Link for this filter. |
||||||||||||||||||||||
searchAndReplaceDetails
|
||||||||||||||||||||||||
parentLink
|
||||||||||||||||||||||||
name
|
string |
Name of this filter. |
||||||||||||||||||||||
lowercaseDetails
|
||||||||||||||||||||||||
kind
|
string Read-only Default value: analytics#filter
|
Resource type for Analytics filter. |
||||||||||||||||||||||
includeDetails
|
FilterExpression |
Details for the filter of the type INCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
id
|
string |
Filter ID. |
||||||||||||||||||||||
excludeDetails
|
FilterExpression |
Details for the filter of the type EXCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
created
|
dateTime Read-only |
Time this filter was created. |
||||||||||||||||||||||
advancedDetails
|
||||||||||||||||||||||||
accountId
|
string |
Account ID to which this filter belongs. |
||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Filter
|
object |
JSON template for an Analytics account filter. |
Properties
uppercaseDetails
|
||||||||||||||||||||||||
updated
|
dateTime Read-only |
Time this filter was last modified. |
||||||||||||||||||||||
type
|
string |
Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
||||||||||||||||||||||
selfLink
|
string Read-only |
Link for this filter. |
||||||||||||||||||||||
searchAndReplaceDetails
|
||||||||||||||||||||||||
parentLink
|
||||||||||||||||||||||||
name
|
string |
Name of this filter. |
||||||||||||||||||||||
lowercaseDetails
|
||||||||||||||||||||||||
kind
|
string Read-only Default value: analytics#filter
|
Resource type for Analytics filter. |
||||||||||||||||||||||
includeDetails
|
FilterExpression |
Details for the filter of the type INCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
id
|
string |
Filter ID. |
||||||||||||||||||||||
excludeDetails
|
FilterExpression |
Details for the filter of the type EXCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
created
|
dateTime Read-only |
Time this filter was created. |
||||||||||||||||||||||
advancedDetails
|
||||||||||||||||||||||||
accountId
|
string |
Account ID to which this filter belongs. |
||||||||||||||||||||||
Updates an existing filter.
Request
Path
| Name | Data Type | Description |
|---|---|---|
filterId
|
string |
ID of the filter to be updated. |
accountId
|
string |
Account ID to which the filter belongs. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
Filter
|
object |
JSON template for an Analytics account filter. |
Properties
uppercaseDetails
|
||||||||||||||||||||||||
updated
|
dateTime Read-only |
Time this filter was last modified. |
||||||||||||||||||||||
type
|
string |
Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
||||||||||||||||||||||
selfLink
|
string Read-only |
Link for this filter. |
||||||||||||||||||||||
searchAndReplaceDetails
|
||||||||||||||||||||||||
parentLink
|
||||||||||||||||||||||||
name
|
string |
Name of this filter. |
||||||||||||||||||||||
lowercaseDetails
|
||||||||||||||||||||||||
kind
|
string Read-only Default value: analytics#filter
|
Resource type for Analytics filter. |
||||||||||||||||||||||
includeDetails
|
FilterExpression |
Details for the filter of the type INCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
id
|
string |
Filter ID. |
||||||||||||||||||||||
excludeDetails
|
FilterExpression |
Details for the filter of the type EXCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
created
|
dateTime Read-only |
Time this filter was created. |
||||||||||||||||||||||
advancedDetails
|
||||||||||||||||||||||||
accountId
|
string |
Account ID to which this filter belongs. |
||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Filter
|
object |
JSON template for an Analytics account filter. |
Properties
uppercaseDetails
|
||||||||||||||||||||||||
updated
|
dateTime Read-only |
Time this filter was last modified. |
||||||||||||||||||||||
type
|
string |
Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
||||||||||||||||||||||
selfLink
|
string Read-only |
Link for this filter. |
||||||||||||||||||||||
searchAndReplaceDetails
|
||||||||||||||||||||||||
parentLink
|
||||||||||||||||||||||||
name
|
string |
Name of this filter. |
||||||||||||||||||||||
lowercaseDetails
|
||||||||||||||||||||||||
kind
|
string Read-only Default value: analytics#filter
|
Resource type for Analytics filter. |
||||||||||||||||||||||
includeDetails
|
FilterExpression |
Details for the filter of the type INCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
id
|
string |
Filter ID. |
||||||||||||||||||||||
excludeDetails
|
FilterExpression |
Details for the filter of the type EXCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
created
|
dateTime Read-only |
Time this filter was created. |
||||||||||||||||||||||
advancedDetails
|
||||||||||||||||||||||||
accountId
|
string |
Account ID to which this filter belongs. |
||||||||||||||||||||||
Lists all filters for an account
Request
Path
| Name | Data Type | Description |
|---|---|---|
accountId
|
string |
Account ID to retrieve filters for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
max-results
|
integer |
The maximum number of filters to include in this response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Filters
|
object |
A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter. |
Properties
username
|
string |
Email ID of the authenticated user |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalResults
|
integer |
The total number of results for the query, regardless of the number of results in the response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
startIndex
|
integer |
The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previousLink
|
string |
Link to previous page for this filter collection. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string |
Link to next page for this filter collection. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: analytics#filters
|
Collection type. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
itemsPerPage
|
integer |
The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [Filter] |
A list of filters. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Create a new filter.
Request
Path
| Name | Data Type | Description |
|---|---|---|
accountId
|
string |
Account ID to create filter for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
Filter
|
object |
JSON template for an Analytics account filter. |
Properties
uppercaseDetails
|
||||||||||||||||||||||||
updated
|
dateTime Read-only |
Time this filter was last modified. |
||||||||||||||||||||||
type
|
string |
Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
||||||||||||||||||||||
selfLink
|
string Read-only |
Link for this filter. |
||||||||||||||||||||||
searchAndReplaceDetails
|
||||||||||||||||||||||||
parentLink
|
||||||||||||||||||||||||
name
|
string |
Name of this filter. |
||||||||||||||||||||||
lowercaseDetails
|
||||||||||||||||||||||||
kind
|
string Read-only Default value: analytics#filter
|
Resource type for Analytics filter. |
||||||||||||||||||||||
includeDetails
|
FilterExpression |
Details for the filter of the type INCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
id
|
string |
Filter ID. |
||||||||||||||||||||||
excludeDetails
|
FilterExpression |
Details for the filter of the type EXCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
created
|
dateTime Read-only |
Time this filter was created. |
||||||||||||||||||||||
advancedDetails
|
||||||||||||||||||||||||
accountId
|
string |
Account ID to which this filter belongs. |
||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Filter
|
object |
JSON template for an Analytics account filter. |
Properties
uppercaseDetails
|
||||||||||||||||||||||||
updated
|
dateTime Read-only |
Time this filter was last modified. |
||||||||||||||||||||||
type
|
string |
Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
||||||||||||||||||||||
selfLink
|
string Read-only |
Link for this filter. |
||||||||||||||||||||||
searchAndReplaceDetails
|
||||||||||||||||||||||||
parentLink
|
||||||||||||||||||||||||
name
|
string |
Name of this filter. |
||||||||||||||||||||||
lowercaseDetails
|
||||||||||||||||||||||||
kind
|
string Read-only Default value: analytics#filter
|
Resource type for Analytics filter. |
||||||||||||||||||||||
includeDetails
|
FilterExpression |
Details for the filter of the type INCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
id
|
string |
Filter ID. |
||||||||||||||||||||||
excludeDetails
|
FilterExpression |
Details for the filter of the type EXCLUDE. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
created
|
dateTime Read-only |
Time this filter was created. |
||||||||||||||||||||||
advancedDetails
|
||||||||||||||||||||||||
accountId
|
string |
Account ID to which this filter belongs. |
||||||||||||||||||||||
Delete data associated with a previous upload.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property Id for the uploads to be deleted. |
customDataSourceId
|
string |
Custom data source Id for the uploads to be deleted. |
accountId
|
string |
Account Id for the uploads to be deleted. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
AnalyticsDataimportDeleteUploadDataRequest
|
object |
Request template for the delete upload data request. |
Properties
customDataImportUids
|
array [string] |
A list of upload UIDs. |
Responses
List uploads to which the user has access.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property Id for the upload to retrieve. |
uploadId
|
string |
Upload Id to retrieve. |
customDataSourceId
|
string |
Custom data source Id for upload to retrieve. |
accountId
|
string |
Account Id for the upload to retrieve. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Upload
|
object |
Metadata returned for an upload operation. |
Properties
uploadTime
|
dateTime |
Time this file is uploaded. |
status
|
string |
Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED. |
kind
|
string Default value: analytics#upload
|
Resource type for Analytics upload. |
id
|
string |
A unique ID for this upload. |
errors
|
array [string] |
Data import errors collection. |
customDataSourceId
|
string |
Custom data source Id to which this data import belongs. |
accountId
|
string |
Account Id to which this upload belongs. |
List uploads to which the user has access.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property Id for the uploads to retrieve. |
customDataSourceId
|
string |
Custom data source Id for uploads to retrieve. |
accountId
|
string |
Account Id for the uploads to retrieve. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
max-results
|
integer Minimum: 1 |
The maximum number of uploads to include in this response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Uploads
|
object |
Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload. |
Properties
totalResults
|
integer |
The total number of results for the query, regardless of the number of resources in the result. |
|||||||||||||||||||||||||
startIndex
|
integer |
The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
|||||||||||||||||||||||||
previousLink
|
string |
Link to previous page for this upload collection. |
|||||||||||||||||||||||||
nextLink
|
string |
Link to next page for this upload collection. |
|||||||||||||||||||||||||
kind
|
string Default value: analytics#uploads
|
Collection type. |
|||||||||||||||||||||||||
itemsPerPage
|
integer |
The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
|||||||||||||||||||||||||
items
|
array [Upload] |
A list of uploads. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
Upload data for a custom data source.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property UA-string associated with the upload. |
customDataSourceId
|
string |
Custom data source Id to which the data being uploaded belongs. |
accountId
|
string |
Account Id associated with the upload. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Upload
|
object |
Metadata returned for an upload operation. |
Properties
uploadTime
|
dateTime |
Time this file is uploaded. |
status
|
string |
Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED. |
kind
|
string Default value: analytics#upload
|
Resource type for Analytics upload. |
id
|
string |
A unique ID for this upload. |
errors
|
array [string] |
Data import errors collection. |
customDataSourceId
|
string |
Custom data source Id to which this data import belongs. |
accountId
|
string |
Account Id to which this upload belongs. |
List custom data sources to which the user has access.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property Id for the custom data sources to retrieve. |
accountId
|
string |
Account Id for the custom data sources to retrieve. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
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. |
max-results
|
integer Minimum: 1 |
The maximum number of custom data sources to include in this response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomDataSources
|
object |
Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source. |
Properties
username
|
string |
Email ID of the authenticated user |
||||||||||||||||||||||||||||||||||||||||||||||||||||
totalResults
|
integer |
The total number of results for the query, regardless of the number of results in the response. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
startIndex
|
integer |
The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
previousLink
|
string |
Link to previous page for this custom data source collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string |
Link to next page for this custom data source collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: analytics#customDataSources
|
Collection type. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
itemsPerPage
|
integer |
The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [CustomDataSource] |
Collection of custom data sources. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get a custom dimension to which the user has access.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom dimension to retrieve. |
customDimensionId
|
string |
The ID of the custom dimension to retrieve. |
accountId
|
string |
Account ID for the custom dimension to retrieve. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomDimension
|
object |
JSON template for Analytics Custom Dimension. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom dimension was last modified. |
selfLink
|
string Read-only |
Link for the custom dimension |
scope
|
string |
Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom dimension. |
kind
|
string Read-only Default value: analytics#customDimension
|
Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
index
|
integer Read-only |
Index of the custom dimension. |
id
|
string |
Custom dimension ID. |
created
|
dateTime Read-only |
Time the custom dimension was created. |
active
|
boolean |
Boolean indicating whether the custom dimension is active. |
accountId
|
string |
Account ID. |
Updates an existing custom dimension. This method supports patch semantics.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom dimension to update. |
customDimensionId
|
string |
Custom dimension ID for the custom dimension to update. |
accountId
|
string |
Account ID for the custom dimension to update. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
ignoreCustomDataSourceLinks
|
boolean Default value: false
|
Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. |
Body
| Name | Data Type | Description |
|---|---|---|
CustomDimension
|
object |
JSON template for Analytics Custom Dimension. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom dimension was last modified. |
selfLink
|
string Read-only |
Link for the custom dimension |
scope
|
string |
Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom dimension. |
kind
|
string Read-only Default value: analytics#customDimension
|
Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
index
|
integer Read-only |
Index of the custom dimension. |
id
|
string |
Custom dimension ID. |
created
|
dateTime Read-only |
Time the custom dimension was created. |
active
|
boolean |
Boolean indicating whether the custom dimension is active. |
accountId
|
string |
Account ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomDimension
|
object |
JSON template for Analytics Custom Dimension. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom dimension was last modified. |
selfLink
|
string Read-only |
Link for the custom dimension |
scope
|
string |
Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom dimension. |
kind
|
string Read-only Default value: analytics#customDimension
|
Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
index
|
integer Read-only |
Index of the custom dimension. |
id
|
string |
Custom dimension ID. |
created
|
dateTime Read-only |
Time the custom dimension was created. |
active
|
boolean |
Boolean indicating whether the custom dimension is active. |
accountId
|
string |
Account ID. |
Updates an existing custom dimension.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom dimension to update. |
customDimensionId
|
string |
Custom dimension ID for the custom dimension to update. |
accountId
|
string |
Account ID for the custom dimension to update. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
ignoreCustomDataSourceLinks
|
boolean Default value: false
|
Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. |
Body
| Name | Data Type | Description |
|---|---|---|
CustomDimension
|
object |
JSON template for Analytics Custom Dimension. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom dimension was last modified. |
selfLink
|
string Read-only |
Link for the custom dimension |
scope
|
string |
Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom dimension. |
kind
|
string Read-only Default value: analytics#customDimension
|
Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
index
|
integer Read-only |
Index of the custom dimension. |
id
|
string |
Custom dimension ID. |
created
|
dateTime Read-only |
Time the custom dimension was created. |
active
|
boolean |
Boolean indicating whether the custom dimension is active. |
accountId
|
string |
Account ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomDimension
|
object |
JSON template for Analytics Custom Dimension. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom dimension was last modified. |
selfLink
|
string Read-only |
Link for the custom dimension |
scope
|
string |
Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom dimension. |
kind
|
string Read-only Default value: analytics#customDimension
|
Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
index
|
integer Read-only |
Index of the custom dimension. |
id
|
string |
Custom dimension ID. |
created
|
dateTime Read-only |
Time the custom dimension was created. |
active
|
boolean |
Boolean indicating whether the custom dimension is active. |
accountId
|
string |
Account ID. |
Lists custom dimensions to which the user has access.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom dimensions to retrieve. |
accountId
|
string |
Account ID for the custom dimensions to retrieve. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
max-results
|
integer |
The maximum number of custom dimensions to include in this response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomDimensions
|
object |
A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension. |
Properties
username
|
string |
Email ID of the authenticated user |
||||||||||||||||||||||||||||||||||||||||
totalResults
|
integer |
The total number of results for the query, regardless of the number of results in the response. |
||||||||||||||||||||||||||||||||||||||||
startIndex
|
integer |
The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
||||||||||||||||||||||||||||||||||||||||
previousLink
|
string |
Link to previous page for this custom dimension collection. |
||||||||||||||||||||||||||||||||||||||||
nextLink
|
string |
Link to next page for this custom dimension collection. |
||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: analytics#customDimensions
|
Collection type. |
||||||||||||||||||||||||||||||||||||||||
itemsPerPage
|
integer |
The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
||||||||||||||||||||||||||||||||||||||||
items
|
array [CustomDimension] |
Collection of custom dimensions. |
||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||
Create a new custom dimension.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom dimension to create. |
accountId
|
string |
Account ID for the custom dimension to create. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
CustomDimension
|
object |
JSON template for Analytics Custom Dimension. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom dimension was last modified. |
selfLink
|
string Read-only |
Link for the custom dimension |
scope
|
string |
Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom dimension. |
kind
|
string Read-only Default value: analytics#customDimension
|
Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
index
|
integer Read-only |
Index of the custom dimension. |
id
|
string |
Custom dimension ID. |
created
|
dateTime Read-only |
Time the custom dimension was created. |
active
|
boolean |
Boolean indicating whether the custom dimension is active. |
accountId
|
string |
Account ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomDimension
|
object |
JSON template for Analytics Custom Dimension. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom dimension was last modified. |
selfLink
|
string Read-only |
Link for the custom dimension |
scope
|
string |
Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom dimension. |
kind
|
string Read-only Default value: analytics#customDimension
|
Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
index
|
integer Read-only |
Index of the custom dimension. |
id
|
string |
Custom dimension ID. |
created
|
dateTime Read-only |
Time the custom dimension was created. |
active
|
boolean |
Boolean indicating whether the custom dimension is active. |
accountId
|
string |
Account ID. |
Get a custom metric to which the user has access.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom metric to retrieve. |
customMetricId
|
string |
The ID of the custom metric to retrieve. |
accountId
|
string |
Account ID for the custom metric to retrieve. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomMetric
|
object |
JSON template for Analytics Custom Metric. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom metric was last modified. |
type
|
string |
Data type of custom metric. |
selfLink
|
string Read-only |
Link for the custom metric |
scope
|
string |
Scope of the custom metric: HIT or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom metric. |
min_value
|
string |
Min value of custom metric. |
max_value
|
string |
Max value of custom metric. |
kind
|
string Read-only Default value: analytics#customMetric
|
Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. |
index
|
integer Read-only |
Index of the custom metric. |
id
|
string |
Custom metric ID. |
created
|
dateTime Read-only |
Time the custom metric was created. |
active
|
boolean |
Boolean indicating whether the custom metric is active. |
accountId
|
string |
Account ID. |
Updates an existing custom metric. This method supports patch semantics.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom metric to update. |
customMetricId
|
string |
Custom metric ID for the custom metric to update. |
accountId
|
string |
Account ID for the custom metric to update. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
ignoreCustomDataSourceLinks
|
boolean Default value: false
|
Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. |
Body
| Name | Data Type | Description |
|---|---|---|
CustomMetric
|
object |
JSON template for Analytics Custom Metric. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom metric was last modified. |
type
|
string |
Data type of custom metric. |
selfLink
|
string Read-only |
Link for the custom metric |
scope
|
string |
Scope of the custom metric: HIT or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom metric. |
min_value
|
string |
Min value of custom metric. |
max_value
|
string |
Max value of custom metric. |
kind
|
string Read-only Default value: analytics#customMetric
|
Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. |
index
|
integer Read-only |
Index of the custom metric. |
id
|
string |
Custom metric ID. |
created
|
dateTime Read-only |
Time the custom metric was created. |
active
|
boolean |
Boolean indicating whether the custom metric is active. |
accountId
|
string |
Account ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomMetric
|
object |
JSON template for Analytics Custom Metric. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom metric was last modified. |
type
|
string |
Data type of custom metric. |
selfLink
|
string Read-only |
Link for the custom metric |
scope
|
string |
Scope of the custom metric: HIT or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom metric. |
min_value
|
string |
Min value of custom metric. |
max_value
|
string |
Max value of custom metric. |
kind
|
string Read-only Default value: analytics#customMetric
|
Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. |
index
|
integer Read-only |
Index of the custom metric. |
id
|
string |
Custom metric ID. |
created
|
dateTime Read-only |
Time the custom metric was created. |
active
|
boolean |
Boolean indicating whether the custom metric is active. |
accountId
|
string |
Account ID. |
Updates an existing custom metric.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom metric to update. |
customMetricId
|
string |
Custom metric ID for the custom metric to update. |
accountId
|
string |
Account ID for the custom metric to update. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
ignoreCustomDataSourceLinks
|
boolean Default value: false
|
Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. |
Body
| Name | Data Type | Description |
|---|---|---|
CustomMetric
|
object |
JSON template for Analytics Custom Metric. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom metric was last modified. |
type
|
string |
Data type of custom metric. |
selfLink
|
string Read-only |
Link for the custom metric |
scope
|
string |
Scope of the custom metric: HIT or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom metric. |
min_value
|
string |
Min value of custom metric. |
max_value
|
string |
Max value of custom metric. |
kind
|
string Read-only Default value: analytics#customMetric
|
Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. |
index
|
integer Read-only |
Index of the custom metric. |
id
|
string |
Custom metric ID. |
created
|
dateTime Read-only |
Time the custom metric was created. |
active
|
boolean |
Boolean indicating whether the custom metric is active. |
accountId
|
string |
Account ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomMetric
|
object |
JSON template for Analytics Custom Metric. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom metric was last modified. |
type
|
string |
Data type of custom metric. |
selfLink
|
string Read-only |
Link for the custom metric |
scope
|
string |
Scope of the custom metric: HIT or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom metric. |
min_value
|
string |
Min value of custom metric. |
max_value
|
string |
Max value of custom metric. |
kind
|
string Read-only Default value: analytics#customMetric
|
Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. |
index
|
integer Read-only |
Index of the custom metric. |
id
|
string |
Custom metric ID. |
created
|
dateTime Read-only |
Time the custom metric was created. |
active
|
boolean |
Boolean indicating whether the custom metric is active. |
accountId
|
string |
Account ID. |
Lists custom metrics to which the user has access.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom metrics to retrieve. |
accountId
|
string |
Account ID for the custom metrics to retrieve. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
max-results
|
integer |
The maximum number of custom metrics to include in this response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomMetrics
|
object |
A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric. |
Properties
username
|
string |
Email ID of the authenticated user |
|||||||||||||||||||||||||||||||||||||||||||||||||
totalResults
|
integer |
The total number of results for the query, regardless of the number of results in the response. |
|||||||||||||||||||||||||||||||||||||||||||||||||
startIndex
|
integer |
The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
|||||||||||||||||||||||||||||||||||||||||||||||||
previousLink
|
string |
Link to previous page for this custom metric collection. |
|||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string |
Link to next page for this custom metric collection. |
|||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: analytics#customMetrics
|
Collection type. |
|||||||||||||||||||||||||||||||||||||||||||||||||
itemsPerPage
|
integer |
The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
|||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [CustomMetric] |
Collection of custom metrics. |
|||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Create a new custom metric.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID for the custom dimension to create. |
accountId
|
string |
Account ID for the custom metric to create. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
CustomMetric
|
object |
JSON template for Analytics Custom Metric. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom metric was last modified. |
type
|
string |
Data type of custom metric. |
selfLink
|
string Read-only |
Link for the custom metric |
scope
|
string |
Scope of the custom metric: HIT or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom metric. |
min_value
|
string |
Min value of custom metric. |
max_value
|
string |
Max value of custom metric. |
kind
|
string Read-only Default value: analytics#customMetric
|
Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. |
index
|
integer Read-only |
Index of the custom metric. |
id
|
string |
Custom metric ID. |
created
|
dateTime Read-only |
Time the custom metric was created. |
active
|
boolean |
Boolean indicating whether the custom metric is active. |
accountId
|
string |
Account ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomMetric
|
object |
JSON template for Analytics Custom Metric. |
Properties
webPropertyId
|
string |
Property ID. |
updated
|
dateTime Read-only |
Time the custom metric was last modified. |
type
|
string |
Data type of custom metric. |
selfLink
|
string Read-only |
Link for the custom metric |
scope
|
string |
Scope of the custom metric: HIT or PRODUCT. |
parentLink
|
||
name
|
string |
Name of the custom metric. |
min_value
|
string |
Min value of custom metric. |
max_value
|
string |
Max value of custom metric. |
kind
|
string Read-only Default value: analytics#customMetric
|
Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. |
index
|
integer Read-only |
Index of the custom metric. |
id
|
string |
Custom metric ID. |
created
|
dateTime Read-only |
Time the custom metric was created. |
active
|
boolean |
Boolean indicating whether the custom metric is active. |
accountId
|
string |
Account ID. |
Deletes a web property-Google Ads link.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID to delete the Google Ads link for. |
webPropertyAdWordsLinkId
|
string |
Web property Google Ads link ID. |
accountId
|
string |
ID of the account which the given web property belongs to. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Returns a web property-Google Ads link to which the user has access.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID to retrieve the Google Ads link for. |
webPropertyAdWordsLinkId
|
string |
Web property-Google Ads link ID. |
accountId
|
string |
ID of the account which the given web property belongs to. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityAdWordsLink
|
object |
JSON template for Analytics Entity Google Ads Link. |
Properties
selfLink
|
string |
URL link for this Google Analytics - Google Ads link. |
|||||||||||||
profileIds
|
array [string] |
IDs of linked Views (Profiles) represented as strings. |
|||||||||||||
name
|
string |
Name of the link. This field is required when creating a Google Ads link. |
|||||||||||||
kind
|
string Default value: analytics#entityAdWordsLink
|
Resource type for entity Google Ads link. |
|||||||||||||
id
|
string |
Entity Google Ads link ID |
|||||||||||||
entity
|
|||||||||||||||
adWordsAccounts
|
array [AdWordsAccount] |
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. |
|||||||||||||
Properties
|
|||||||||||||||
Updates an existing webProperty-Google Ads link. This method supports patch semantics.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID to retrieve the Google Ads link for. |
webPropertyAdWordsLinkId
|
string |
Web property-Google Ads link ID. |
accountId
|
string |
ID of the account which the given web property belongs to. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
EntityAdWordsLink
|
object |
JSON template for Analytics Entity Google Ads Link. |
Properties
selfLink
|
string |
URL link for this Google Analytics - Google Ads link. |
|||||||||||||
profileIds
|
array [string] |
IDs of linked Views (Profiles) represented as strings. |
|||||||||||||
name
|
string |
Name of the link. This field is required when creating a Google Ads link. |
|||||||||||||
kind
|
string Default value: analytics#entityAdWordsLink
|
Resource type for entity Google Ads link. |
|||||||||||||
id
|
string |
Entity Google Ads link ID |
|||||||||||||
entity
|
|||||||||||||||
adWordsAccounts
|
array [AdWordsAccount] |
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. |
|||||||||||||
Properties
|
|||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityAdWordsLink
|
object |
JSON template for Analytics Entity Google Ads Link. |
Properties
selfLink
|
string |
URL link for this Google Analytics - Google Ads link. |
|||||||||||||
profileIds
|
array [string] |
IDs of linked Views (Profiles) represented as strings. |
|||||||||||||
name
|
string |
Name of the link. This field is required when creating a Google Ads link. |
|||||||||||||
kind
|
string Default value: analytics#entityAdWordsLink
|
Resource type for entity Google Ads link. |
|||||||||||||
id
|
string |
Entity Google Ads link ID |
|||||||||||||
entity
|
|||||||||||||||
adWordsAccounts
|
array [AdWordsAccount] |
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. |
|||||||||||||
Properties
|
|||||||||||||||
Updates an existing webProperty-Google Ads link.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID to retrieve the Google Ads link for. |
webPropertyAdWordsLinkId
|
string |
Web property-Google Ads link ID. |
accountId
|
string |
ID of the account which the given web property belongs to. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
EntityAdWordsLink
|
object |
JSON template for Analytics Entity Google Ads Link. |
Properties
selfLink
|
string |
URL link for this Google Analytics - Google Ads link. |
|||||||||||||
profileIds
|
array [string] |
IDs of linked Views (Profiles) represented as strings. |
|||||||||||||
name
|
string |
Name of the link. This field is required when creating a Google Ads link. |
|||||||||||||
kind
|
string Default value: analytics#entityAdWordsLink
|
Resource type for entity Google Ads link. |
|||||||||||||
id
|
string |
Entity Google Ads link ID |
|||||||||||||
entity
|
|||||||||||||||
adWordsAccounts
|
array [AdWordsAccount] |
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. |
|||||||||||||
Properties
|
|||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityAdWordsLink
|
object |
JSON template for Analytics Entity Google Ads Link. |
Properties
selfLink
|
string |
URL link for this Google Analytics - Google Ads link. |
|||||||||||||
profileIds
|
array [string] |
IDs of linked Views (Profiles) represented as strings. |
|||||||||||||
name
|
string |
Name of the link. This field is required when creating a Google Ads link. |
|||||||||||||
kind
|
string Default value: analytics#entityAdWordsLink
|
Resource type for entity Google Ads link. |
|||||||||||||
id
|
string |
Entity Google Ads link ID |
|||||||||||||
entity
|
|||||||||||||||
adWordsAccounts
|
array [AdWordsAccount] |
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. |
|||||||||||||
Properties
|
|||||||||||||||
Lists webProperty-Google Ads links for a given web property.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID to retrieve the Google Ads links for. |
accountId
|
string |
ID of the account which the given web property belongs to. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
max-results
|
integer |
The maximum number of webProperty-Google Ads links to include in this response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityAdWordsLinks
|
object |
An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link. |
Properties
totalResults
|
integer |
The total number of results for the query, regardless of the number of results in the response. |
|||||||||||||||||||||||||||||||||||||||||
startIndex
|
integer |
The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. |
|||||||||||||||||||||||||||||||||||||||||
previousLink
|
string |
Previous link for this Google Ads link collection. |
|||||||||||||||||||||||||||||||||||||||||
nextLink
|
string |
Next link for this Google Ads link collection. |
|||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: analytics#entityAdWordsLinks
|
Collection type. |
|||||||||||||||||||||||||||||||||||||||||
itemsPerPage
|
integer |
The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
|||||||||||||||||||||||||||||||||||||||||
items
|
array [EntityAdWordsLink] |
A list of entity Google Ads links. |
|||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||
Creates a webProperty-Google Ads link.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID to create the link for. |
accountId
|
string |
ID of the Google Analytics account to create the link for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
EntityAdWordsLink
|
object |
JSON template for Analytics Entity Google Ads Link. |
Properties
selfLink
|
string |
URL link for this Google Analytics - Google Ads link. |
|||||||||||||
profileIds
|
array [string] |
IDs of linked Views (Profiles) represented as strings. |
|||||||||||||
name
|
string |
Name of the link. This field is required when creating a Google Ads link. |
|||||||||||||
kind
|
string Default value: analytics#entityAdWordsLink
|
Resource type for entity Google Ads link. |
|||||||||||||
id
|
string |
Entity Google Ads link ID |
|||||||||||||
entity
|
|||||||||||||||
adWordsAccounts
|
array [AdWordsAccount] |
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. |
|||||||||||||
Properties
|
|||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityAdWordsLink
|
object |
JSON template for Analytics Entity Google Ads Link. |
Properties
selfLink
|
string |
URL link for this Google Analytics - Google Ads link. |
|||||||||||||
profileIds
|
array [string] |
IDs of linked Views (Profiles) represented as strings. |
|||||||||||||
name
|
string |
Name of the link. This field is required when creating a Google Ads link. |
|||||||||||||
kind
|
string Default value: analytics#entityAdWordsLink
|
Resource type for entity Google Ads link. |
|||||||||||||
id
|
string |
Entity Google Ads link ID |
|||||||||||||
entity
|
|||||||||||||||
adWordsAccounts
|
array [AdWordsAccount] |
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. |
|||||||||||||
Properties
|
|||||||||||||||
Removes a user from the given web property.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web Property ID to delete the user link for. |
linkId
|
string |
Link ID to delete the user link for. |
accountId
|
string |
Account ID to delete the user link for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Updates permissions for an existing user on the given web property.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web property ID to update the account-user link for. |
linkId
|
string |
Link ID to update the account-user link for. |
accountId
|
string |
Account ID to update the account-user link for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLink
|
object |
JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. |
Properties
userRef
|
UserRef |
User reference. |
|||||||||||||
Properties
|
|||||||||||||||
selfLink
|
string |
Self link for this resource. |
|||||||||||||
permissions
|
|||||||||||||||
kind
|
string Default value: analytics#entityUserLink
|
Resource type for entity user link. |
|||||||||||||
id
|
string |
Entity user link ID |
|||||||||||||
entity
|
|||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLink
|
object |
JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. |
Properties
userRef
|
UserRef |
User reference. |
|||||||||||||
Properties
|
|||||||||||||||
selfLink
|
string |
Self link for this resource. |
|||||||||||||
permissions
|
|||||||||||||||
kind
|
string Default value: analytics#entityUserLink
|
Resource type for entity user link. |
|||||||||||||
id
|
string |
Entity user link ID |
|||||||||||||
entity
|
|||||||||||||||
Lists webProperty-user links for a given web property.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
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. |
accountId
|
string |
Account ID which the given web property belongs to. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
start-index
|
integer Minimum: 1 |
An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
max-results
|
integer |
The maximum number of webProperty-user Links to include in this response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLinks
|
object |
An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link. |
Properties
totalResults
|
integer |
The total number of results for the query, regardless of the number of results in the response. |
||||||||||||||||||||||||||||||||||||||
startIndex
|
integer |
The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. |
||||||||||||||||||||||||||||||||||||||
previousLink
|
string |
Previous link for this account collection. |
||||||||||||||||||||||||||||||||||||||
nextLink
|
string |
Next link for this account collection. |
||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: analytics#entityUserLinks
|
Collection type. |
||||||||||||||||||||||||||||||||||||||
itemsPerPage
|
integer |
The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
||||||||||||||||||||||||||||||||||||||
items
|
array [EntityUserLink] |
A list of entity user links. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
Adds a new user to the given web property.
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web Property ID to create the user link for. |
accountId
|
string |
Account ID to create the user link for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLink
|
object |
JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. |
Properties
userRef
|
UserRef |
User reference. |
|||||||||||||
Properties
|
|||||||||||||||
selfLink
|
string |
Self link for this resource. |
|||||||||||||
permissions
|
|||||||||||||||
kind
|
string Default value: analytics#entityUserLink
|
Resource type for entity user link. |
|||||||||||||
id
|
string |
Entity user link ID |
|||||||||||||
entity
|
|||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EntityUserLink
|
object |
JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. |
Properties
userRef
|
UserRef |
User reference. |
|||||||||||||
Properties
|
|||||||||||||||
selfLink
|
string |
Self link for this resource. |
|||||||||||||
permissions
|
|||||||||||||||
kind
|
string Default value: analytics#entityUserLink
|
Resource type for entity user link. |
|||||||||||||
id
|
string |
Entity user link ID |
|||||||||||||
entity
|
|||||||||||||||
Removes a user from the given view (profile).
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web Property ID to delete the user link for. |
profileId
|
string |
View (Profile) ID to delete the user link for. |
linkId
|
string |
Link ID to delete the user link for. |
accountId
|
string |
Account ID to delete the user link for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Updates permissions for an existing user on the given view (profile).
Request
Path
| Name | Data Type | Description |
|---|---|---|
webPropertyId
|
string |
Web Property ID to update the user link for. |
profileId
|
string |
View (Profile ID) to update the user link for. |
linkId
|
string |
Link ID to update the user link for. |
accountId
|
string |
Account ID to update the user link for. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: false
|
Returns response with indentations and line breaks. |