/google-analytics-admin | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
google-analytics-admin_list_account_summaries | Returns summaries of all accounts accessible by the caller. |
google-analytics-admin_list_accounts | Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: “trashed”) accounts are excluded by default. Returns an empty list if no relevant accounts are found. |
google-analytics-admin_list_conversion_events | Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found. |
google-analytics-admin_list_custom_dimensions | Lists CustomDimensions on a property. |
google-analytics-admin_list_custom_metrics | Lists CustomMetrics on a property. |
google-analytics-admin_list_data_streams | Lists DataStreams on a property. |
google-analytics-admin_list_properties | Returns child Properties under the specified parent Account. Only “GA4” properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: “trashed”) properties are excluded by default. Returns an empty list if no relevant properties are found. |
google-analytics-admin_run_access_report | Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don’t include property configuration changes like adding a stream or changing a property’s time zone. For configuration change history, see searchChangeHistoryEvents. |
google-analytics-admin_list_account_summaries
Returns summaries of all accounts accessible by the caller. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
pageToken | string | No | — | A page token, received from a previous ListAccountSummaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountSummaries must match the call that provided the page token. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)"
},
"pageToken": {
"type": "string",
"description": "A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token."
}
},
"required": [
"PCID"
]
}
google-analytics-admin_list_accounts
Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: “trashed”) accounts are excluded by default. Returns an empty list if no relevant accounts are found. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
pageToken | string | No | — | A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token. |
showDeleted | boolean | No | — | Whether to include soft-deleted (ie: “trashed”) Accounts in the results. Accounts can be inspected to determine whether they are deleted or not. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)"
},
"pageToken": {
"type": "string",
"description": "A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token."
},
"showDeleted": {
"type": "boolean",
"description": "Whether to include soft-deleted (ie: \"trashed\") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not."
}
},
"required": [
"PCID"
]
}
google-analytics-admin_list_conversion_events
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
parent | string | Yes | — | Required. The resource name of the parent property. Example: ‘properties/123’ |
pageSize | integer | No | — | The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
pageToken | string | No | — | A page token, received from a previous ListConversionEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListConversionEvents must match the call that provided the page token. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"parent": {
"type": "string",
"description": "Required. The resource name of the parent property. Example: 'properties/123'"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)"
},
"pageToken": {
"type": "string",
"description": "A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token."
}
},
"required": [
"PCID",
"parent"
]
}
google-analytics-admin_list_custom_dimensions
Lists CustomDimensions on a property. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
parent | string | Yes | — | Required. Example format: properties/1234 |
pageSize | integer | No | — | The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |
pageToken | string | No | — | A page token, received from a previous ListCustomDimensions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCustomDimensions must match the call that provided the page token. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"parent": {
"type": "string",
"description": "Required. Example format: properties/1234"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)."
},
"pageToken": {
"type": "string",
"description": "A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token."
}
},
"required": [
"PCID",
"parent"
]
}
google-analytics-admin_list_custom_metrics
Lists CustomMetrics on a property. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
parent | string | Yes | — | Required. Example format: properties/1234 |
pageSize | integer | No | — | The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |
pageToken | string | No | — | A page token, received from a previous ListCustomMetrics call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCustomMetrics must match the call that provided the page token. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"parent": {
"type": "string",
"description": "Required. Example format: properties/1234"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)."
},
"pageToken": {
"type": "string",
"description": "A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomMetrics` must match the call that provided the page token."
}
},
"required": [
"PCID",
"parent"
]
}
google-analytics-admin_list_data_streams
Lists DataStreams on a property. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
parent | string | Yes | — | Required. Example format: properties/1234 |
pageSize | integer | No | — | The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |
pageToken | string | No | — | A page token, received from a previous ListDataStreams call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataStreams must match the call that provided the page token. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"parent": {
"type": "string",
"description": "Required. Example format: properties/1234"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)."
},
"pageToken": {
"type": "string",
"description": "A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token."
}
},
"required": [
"PCID",
"parent"
]
}
google-analytics-admin_list_properties
Returns child Properties under the specified parent Account. Only “GA4” properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: “trashed”) properties are excluded by default. Returns an empty list if no relevant properties are found. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | Yes | — | Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property) or ancestor:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters: | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | |
pageSize | integer | No | — | The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
pageToken | string | No | — | A page token, received from a previous ListProperties call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProperties must match the call that provided the page token. |
showDeleted | boolean | No | — | Whether to include soft-deleted (ie: “trashed”) Properties in the results. Properties can be inspected to determine whether they are deleted or not. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filter": {
"type": "string",
"description": "Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ```"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)"
},
"pageToken": {
"type": "string",
"description": "A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token."
},
"showDeleted": {
"type": "boolean",
"description": "Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not."
}
},
"required": [
"PCID",
"filter"
]
}
google-analytics-admin_run_access_report
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don’t include property configuration changes like adding a stream or changing a property’s time zone. For configuration change history, see searchChangeHistoryEvents. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entity | string | Yes | — | The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example ‘properties/123’ if “123” is your GA4 property ID. To request at the account level, entity should be for example ‘accounts/1234’ if “1234” is your GA4 Account ID. |
dateRanges | object[] | No | — | Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges. |
dimensionFilter | object | No | — | Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. |
dimensions | object[] | No | — | The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. |
limit | string | No | — | The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive. The API may return fewer rows than the requested limit, if there aren’t as many remaining rows as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can’t get more than 300 rows, even if you set limit to a higher value. To learn more about this pagination parameter, see Pagination. |
metricFilter | object | No | — | Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. |
metrics | object[] | No | — | The metrics requested and displayed in the response. Requests are allowed up to 10 metrics. |
offset | string | No | — | The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with limit entries. To learn more about this pagination parameter, see Pagination. |
orderBys | object[] | No | — | Specifies how rows are ordered in the response. |
returnEntityQuota | boolean | No | — | Toggles whether to return the current state of this Analytics Property’s quota. Quota is returned in AccessQuota. For account-level requests, this field must be false. |
timeZone | string | No | — | This request’s time zone if specified. If unspecified, the property’s time zone is used. The request’s time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example “America/New_York” or “Asia/Tokyo”. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entity": {
"type": "string",
"description": "The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example 'properties/123' if \"123\" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if \"1234\" is your GA4 Account ID."
},
"dateRanges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endDate": {
"type": "string",
"description": "The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone."
},
"startDate": {
"type": "string",
"description": "The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone."
}
}
},
"description": "Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges."
},
"dimensionFilter": {
"type": "object",
"description": "Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.",
"properties": {
"accessFilter": {
"type": "object",
"description": "An expression to filter dimension or metric values."
},
"andGroup": {
"type": "object",
"description": "A list of filter expressions."
},
"notExpression": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression"
},
"orGroup": {
"type": "object",
"description": "A list of filter expressions."
}
}
},
"dimensions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dimensionName": {
"type": "string",
"description": "The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`."
}
}
},
"description": "The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions."
},
"limit": {
"type": "string",
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination)."
},
"metricFilter": {
"type": "object",
"description": "Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.",
"properties": {
"accessFilter": {
"type": "object",
"description": "An expression to filter dimension or metric values."
},
"andGroup": {
"type": "object",
"description": "A list of filter expressions."
},
"notExpression": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression"
},
"orGroup": {
"type": "object",
"description": "A list of filter expressions."
}
}
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metricName": {
"type": "string",
"description": "The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this API. Metrics are referenced by name in `metricFilter` & `orderBys`."
}
}
},
"description": "The metrics requested and displayed in the response. Requests are allowed up to 10 metrics."
},
"offset": {
"type": "string",
"description": "The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination)."
},
"orderBys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"desc": {
"type": "boolean",
"description": "If true, sorts by descending order. If false or unspecified, sorts in ascending order."
},
"dimension": {
"type": "object",
"description": "Sorts by dimension values."
},
"metric": {
"type": "object",
"description": "Sorts by metric values."
}
}
},
"description": "Specifies how rows are ordered in the response."
},
"returnEntityQuota": {
"type": "boolean",
"description": "Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false."
},
"timeZone": {
"type": "string",
"description": "This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example \"America/New_York\" or \"Asia/Tokyo\"."
}
},
"required": [
"PCID",
"entity"
]
}