List
|
|||||
|
|
||||
Lists unsampled reports to which the user has access
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your Google Analytics data
- Edit Google Analytics management entities
- View your Google Analytics data
Input
This building block consumes 5 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported |
webPropertyId Required |
STRING |
Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported |
profileId Required |
STRING |
View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported |
max-results |
INTEGER |
The maximum number of unsampled reports to include in this response |
start-index |
INTEGER |
An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
= Parameter name
= Format
|
accountId STRING Required Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported |
|
webPropertyId STRING Required Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported |
|
profileId STRING Required View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported |
|
max-results INTEGER The maximum number of unsampled reports to include in this response |
|
start-index INTEGER An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
Output
This building block provides 30 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for Analytics unsampled report resource |
items[].accountId |
STRING |
Account ID to which this unsampled report belongs |
items[].cloudStorageDownloadDetails |
OBJECT |
Download details for a file stored in Google Cloud Storage |
items[].cloudStorageDownloadDetails.bucketId |
STRING |
Id of the bucket the file object is stored in |
items[].cloudStorageDownloadDetails.objectId |
STRING |
Id of the file object containing the report data |
items[].created |
DATE_TIME |
Time this unsampled report was created |
items[].dimensions |
STRING |
The dimensions for the unsampled report |
items[].downloadType |
STRING |
The type of download you need to use for the report data file. Possible values include |
items[].driveDownloadDetails |
OBJECT |
Download details for a file stored in Google Drive |
items[].driveDownloadDetails.documentId |
STRING |
Id of the document/file containing the report data |
items[].end-date |
STRING |
The end date for the unsampled report |
items[].filters |
STRING |
The filters for the unsampled report |
items[].id |
STRING |
Unsampled report ID |
items[].kind |
STRING |
Resource type for an Analytics unsampled report |
items[].metrics |
STRING |
The metrics for the unsampled report |
items[].profileId |
STRING |
View (Profile) ID to which this unsampled report belongs |
items[].segment |
STRING |
The segment for the unsampled report |
items[].selfLink |
STRING |
Link for this unsampled report |
items[].start-date |
STRING |
The start date for the unsampled report |
items[].status |
STRING |
Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED |
items[].title |
STRING |
Title of the unsampled report |
items[].updated |
DATE_TIME |
Time this unsampled report was last modified |
items[].webPropertyId |
STRING |
Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY |
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 |
kind |
STRING |
Collection type |
nextLink |
STRING |
Link to next page for this unsampled report collection |
previousLink |
STRING |
Link to previous page for this unsampled report collection |
startIndex |
INTEGER |
The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter |
totalResults |
INTEGER |
The total number of results for the query, regardless of the number of resources in the result |
username |
STRING |
Email ID of the authenticated user |
= Parameter name
= Format
|
items[] OBJECT JSON template for Analytics unsampled report resource |
|
items[].accountId STRING Account ID to which this unsampled report belongs |
|
items[].cloudStorageDownloadDetails OBJECT Download details for a file stored in Google Cloud Storage |
|
items[].cloudStorageDownloadDetails.bucketId STRING Id of the bucket the file object is stored in |
|
items[].cloudStorageDownloadDetails.objectId STRING Id of the file object containing the report data |
|
items[].created DATE_TIME Time this unsampled report was created |
|
items[].dimensions STRING The dimensions for the unsampled report |
|
items[].downloadType STRING The type of download you need to use for the report data file. Possible values include |
|
items[].driveDownloadDetails OBJECT Download details for a file stored in Google Drive |
|
items[].driveDownloadDetails.documentId STRING Id of the document/file containing the report data |
|
items[].end-date STRING The end date for the unsampled report |
|
items[].filters STRING The filters for the unsampled report |
|
items[].id STRING Unsampled report ID |
|
items[].kind STRING Resource type for an Analytics unsampled report |
|
items[].metrics STRING The metrics for the unsampled report |
|
items[].profileId STRING View (Profile) ID to which this unsampled report belongs |
|
items[].segment STRING The segment for the unsampled report |
|
items[].selfLink STRING Link for this unsampled report |
|
items[].start-date STRING The start date for the unsampled report |
|
items[].status STRING Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED |
|
items[].title STRING Title of the unsampled report |
|
items[].updated DATE_TIME Time this unsampled report was last modified |
|
items[].webPropertyId STRING Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY |
|
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 |
|
kind STRING Collection type |
|
nextLink STRING Link to next page for this unsampled report collection |
|
previousLink STRING Link to previous page for this unsampled report collection |
|
startIndex INTEGER The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter |
|
totalResults INTEGER The total number of results for the query, regardless of the number of resources in the result |
|
username STRING Email ID of the authenticated user |