Get
|
|||||
|
|
||||
Returns real time data for a view (profile)
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
- View your Google Analytics data
Input
This building block consumes 6 input parameters
| Name | Format | Description |
|---|---|---|
ids Required |
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 |
metrics Required |
STRING |
A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified |
dimensions |
STRING |
A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city' |
filters |
STRING |
A comma-separated list of dimension or metric filters to be applied to real time data |
max-results |
INTEGER |
The maximum number of entries to include in this feed |
sort |
STRING |
A comma-separated list of dimensions or metrics that determine the sort order for real time data |
= Parameter name
= Format
|
ids STRING Required Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID |
|
metrics STRING Required A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified |
|
dimensions STRING A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city' |
|
filters STRING A comma-separated list of dimension or metric filters to be applied to real time data |
|
max-results INTEGER The maximum number of entries to include in this feed |
|
sort STRING A comma-separated list of dimensions or metrics that determine the sort order for real time data |
Output
This building block provides 25 output parameters
| Name | Format | Description |
|---|---|---|
columnHeaders[] |
OBJECT |
|
columnHeaders[].columnType |
STRING |
Column Type. Either DIMENSION or METRIC |
columnHeaders[].dataType |
STRING |
Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc |
columnHeaders[].name |
STRING |
Column name |
id |
STRING |
Unique ID for this data response |
kind |
STRING |
Resource type |
profileInfo |
OBJECT |
Information for the view (profile), for which the real time data was requested |
profileInfo.accountId |
STRING |
Account ID to which this view (profile) belongs |
profileInfo.internalWebPropertyId |
STRING |
Internal ID for the web property to which this view (profile) belongs |
profileInfo.profileId |
STRING |
View (Profile) ID |
profileInfo.profileName |
STRING |
View (Profile) name |
profileInfo.tableId |
STRING |
Table ID for view (profile) |
profileInfo.webPropertyId |
STRING |
Web Property ID to which this view (profile) belongs |
query |
OBJECT |
Real time data request query parameters |
query.dimensions |
STRING |
List of real time dimensions |
query.filters |
STRING |
Comma-separated list of dimension or metric filters |
query.ids |
STRING |
Unique table ID |
query.max-results |
INTEGER |
Maximum results per page |
query.metrics[] |
STRING |
|
query.sort[] |
STRING |
|
rows[] |
OBJECT_ARRAY |
|
selfLink |
STRING |
Link to this page |
totalResults |
INTEGER |
The total number of rows for the query, regardless of the number of rows in the response |
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 |
totalsForAllResults.customKey.value |
STRING |
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 |
= Parameter name
= Format
|
columnHeaders[] OBJECT |
|
columnHeaders[].columnType STRING Column Type. Either DIMENSION or METRIC |
|
columnHeaders[].dataType STRING Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc |
|
columnHeaders[].name STRING Column name |
|
id STRING Unique ID for this data response |
|
kind STRING Resource type |
|
profileInfo OBJECT Information for the view (profile), for which the real time data was requested |
|
profileInfo.accountId STRING Account ID to which this view (profile) belongs |
|
profileInfo.internalWebPropertyId STRING Internal ID for the web property to which this view (profile) belongs |
|
profileInfo.profileId STRING View (Profile) ID |
|
profileInfo.profileName STRING View (Profile) name |
|
profileInfo.tableId STRING Table ID for view (profile) |
|
profileInfo.webPropertyId STRING Web Property ID to which this view (profile) belongs |
|
query OBJECT Real time data request query parameters |
|
query.dimensions STRING List of real time dimensions |
|
query.filters STRING Comma-separated list of dimension or metric filters |
|
query.ids STRING Unique table ID |
|
query.max-results INTEGER Maximum results per page |
|
query.metrics[] STRING |
|
query.sort[] STRING |
|
rows[] OBJECT_ARRAY |
|
selfLink STRING Link to this page |
|
totalResults INTEGER The total number of rows for the query, regardless of the number of rows in the response |
|
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 |
|
totalsForAllResults.customKey.value STRING 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 |