This document provides the Data API queries equivalent to
[predefined reports](https://support.google.com/analytics/answer/9212670)
available in the Google Analytics UI. Click the **HTTP** tab to see
the API requests.
## Life cycle
### User Acquisition
The [User acquisition report](https://support.google.com/analytics/answer/12922540)
is a predefined detail report that you can use to get insights
into how new users find your website or app for the first time.
#### New users by First user default channel group over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22firstUserDefaultChannelGroup%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22firstUserDefaultChannelGroup%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22newUsers%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"firstUserDefaultChannelGroup"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "firstUserDefaultChannelGroup"
}
],
"metrics": [
{
"name": "newUsers"
}
]
}
```
#### New users by First user primary channel group (Default Channel Group)
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22firstUserDefaultChannelGroup%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22newUsers%22%7D%5D,+%22limit%22:+5%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "firstUserDefaultChannelGroup"
}
],
"metrics": [
{
"name": "newUsers"
}
],
"limit": 5
}
```
#### User acquisition report
The [User acquisition report](https://support.google.com/analytics/answer/12922540)
is a predefined detail report that you can use to get insights into how new users
find your website or app for the first time.
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22firstUserDefaultChannelGroup%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22newUsers%22%7D,+%7B%22name%22:+%22engagedSessions%22%7D,+%7B%22name%22:+%22engagementRate%22%7D,+%7B%22name%22:+%22engagedSessionsPerUser%22,+%22expression%22:+%22engagedSessions/activeUsers%22%7D,+%7B%22name%22:+%22averageEngagementTime%22,+%22expression%22:+%22userEngagementDuration/activeUsers%22%7D,+%7B%22name%22:+%22eventCount%22%7D,+%7B%22name%22:+%22keyEvents%22%7D,+%7B%22name%22:+%22totalRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "firstUserDefaultChannelGroup"
}
],
"metrics": [
{
"name": "newUsers"
},
{
"name": "engagedSessions"
},
{
"name": "engagementRate"
},
{
"name": "engagedSessionsPerUser",
"expression": "engagedSessions/activeUsers"
},
{
"name": "averageEngagementTime",
"expression": "userEngagementDuration/activeUsers"
},
{
"name": "eventCount"
},
{
"name": "keyEvents"
},
{
"name": "totalRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
### Traffic Acquisition
The [Traffic acquisition report](https://support.google.com/analytics/answer/12923437)
is a predefined detail report that's designed to help you understand where
your website and app visitors are coming from. It specifically shows
where new and returning users come from.
#### Users by Session primary channel group (Default Channel Group) over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22sessionDefaultChannelGroup%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22sessionDefaultChannelGroup%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"sessionDefaultChannelGroup"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "sessionDefaultChannelGroup"
}
],
"metrics": [
{
"name": "activeUsers"
}
]
}
```
#### Users by Session primary channel group (Default Channel Group)
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22sessionDefaultChannelGroup%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D%5D,+%22limit%22:+5%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "sessionDefaultChannelGroup"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"limit": 5
}
```
#### Traffic acquisition: Session primary channel group (Default Channel Group)
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22sessionDefaultChannelGroup%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D,+%7B%22name%22:+%22sessions%22%7D,+%7B%22name%22:+%22engagedSessions%22%7D,+%7B%22name%22:+%22averageEngagementTimePerSession%22,+%22expression%22:+%22userEngagementDuration/sessions%22%7D,+%7B%22name%22:+%22engagedSessionsPerUser%22,+%22expression%22:+%22engagedSessions/activeUsers%22%7D,+%7B%22name%22:+%22eventsPerSession%22%7D,+%7B%22name%22:+%22engagementRate%22%7D,+%7B%22name%22:+%22eventCount%22%7D,+%7B%22name%22:+%22keyEvents%22%7D,+%7B%22name%22:+%22totalRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "sessionDefaultChannelGroup"
}
],
"metrics": [
{
"name": "activeUsers"
},
{
"name": "sessions"
},
{
"name": "engagedSessions"
},
{
"name": "averageEngagementTimePerSession",
"expression": "userEngagementDuration/sessions"
},
{
"name": "engagedSessionsPerUser",
"expression": "engagedSessions/activeUsers"
},
{
"name": "eventsPerSession"
},
{
"name": "engagementRate"
},
{
"name": "eventCount"
},
{
"name": "keyEvents"
},
{
"name": "totalRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
## Engagement
### Events
The [Events report](https://support.google.com/analytics/answer/12926615)
is a predefined detail report that shows how many times each event is
triggered and how many users trigger each event on your website or app.
#### Event count by Event name over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22eventName%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22eventName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22eventCount%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"eventName"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "eventName"
}
],
"metrics": [
{
"name": "eventCount"
}
]
}
```
#### Event count by Event name
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22eventName%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22eventName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22eventCount%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"eventName"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "eventName"
}
],
"metrics": [
{
"name": "eventCount"
}
]
}
```
#### Events: Event name
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22eventName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22eventCount%22%7D,+%7B%22name%22:+%22totalUsers%22%7D,+%7B%22name%22:+%22eventCountPerUser%22%7D,+%7B%22name%22:+%22totalRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "eventName"
}
],
"metrics": [
{
"name": "eventCount"
},
{
"name": "totalUsers"
},
{
"name": "eventCountPerUser"
},
{
"name": "totalRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
### Pages and screens
The [Pages and screens report](https://support.google.com/analytics/answer/12926732)
is a predefined detail report that shows data about the pages users visited
on your website and the screens users opened on your mobile app, enabling
you to see where people are going across both your websites and apps.
#### Views by Page path and screen class over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22unifiedPagePathScreen%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22unifiedPagePathScreen%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22screenPageViews%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"unifiedPagePathScreen"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "unifiedPagePathScreen"
}
],
"metrics": [
{
"name": "screenPageViews"
}
]
}
```
#### Views by Page path and screen class
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22unifiedPagePathScreen%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22screenPageViews%22%7D%5D,+%22limit%22:+5%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "unifiedPagePathScreen"
}
],
"metrics": [
{
"name": "screenPageViews"
}
],
"limit": 5
}
```
#### Pages and screens: Page path and screen class
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22unifiedPagePathScreen%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22screenPageViews%22%7D,+%7B%22name%22:+%22activeUsers%22%7D,+%7B%22name%22:+%22screenPageViewsPerUser%22%7D,+%7B%22name%22:+%22averageEngagementTime%22,+%22expression%22:+%22userEngagementDuration/activeUsers%22%7D,+%7B%22name%22:+%22eventCount%22%7D,+%7B%22name%22:+%22keyEvents%22%7D,+%7B%22name%22:+%22totalRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "unifiedPagePathScreen"
}
],
"metrics": [
{
"name": "screenPageViews"
},
{
"name": "activeUsers"
},
{
"name": "screenPageViewsPerUser"
},
{
"name": "averageEngagementTime",
"expression": "userEngagementDuration/activeUsers"
},
{
"name": "eventCount"
},
{
"name": "keyEvents"
},
{
"name": "totalRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
### Landing page
The [Landing page report](https://support.google.com/analytics/answer/12931766)
is a predefined detail report that helps you understand how visitors
interact with your website. It shows you the first page a visitor lands on
when they visit your website and how many visitors land on each page.
#### Sessions by Landing page over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22landingPage%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22landingPage%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22sessions%22%7D%5D,+%22dimensionFilter%22:+%7B%22notExpression%22:+%7B%22filter%22:+%7B%22fieldName%22:+%22landingPage%22,+%22stringFilter%22:+%7B%22value%22:+%22(not+set)%22%7D%7D%7D%7D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"landingPage"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "landingPage"
}
],
"metrics": [
{
"name": "sessions"
}
],
"dimensionFilter": {
"notExpression": {
"filter": {
"fieldName": "landingPage",
"stringFilter": {
"value": "(not set)"
}
}
}
}
}
```
#### Landing page: Landing page
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22landingPage%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22sessions%22%7D,+%7B%22name%22:+%22activeUsers%22%7D,+%7B%22name%22:+%22newUsers%22%7D,+%7B%22name%22:+%22averageEngagementTimePerSession%22,+%22expression%22:+%22userEngagementDuration/sessions%22%7D,+%7B%22name%22:+%22keyEvents%22%7D,+%7B%22name%22:+%22totalRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "landingPage"
}
],
"metrics": [
{
"name": "sessions"
},
{
"name": "activeUsers"
},
{
"name": "newUsers"
},
{
"name": "averageEngagementTimePerSession",
"expression": "userEngagementDuration/sessions"
},
{
"name": "keyEvents"
},
{
"name": "totalRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
## Monetization
### Ecommerce purchases
The [Ecommerce purchases report](https://support.google.com/analytics/answer/12924131)
is a predefined detail report that shows information about the products
or services you sell on your ecommerce store.
#### Items viewed by Item name over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22itemName%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22itemName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22itemsViewed%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"itemName"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "itemName"
}
],
"metrics": [
{
"name": "itemsViewed"
}
]
}
```
#### Items viewed and Items added to cart by Item name
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22itemName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22itemsViewed%22%7D,+%7B%22name%22:+%22itemsAddedToCart%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "itemName"
}
],
"metrics": [
{
"name": "itemsViewed"
},
{
"name": "itemsAddedToCart"
}
]
}
```
#### Ecommerce purchases: Item name
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22itemName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22itemsViewed%22%7D,+%7B%22name%22:+%22itemsAddedToCart%22%7D,+%7B%22name%22:+%22itemsPurchased%22%7D,+%7B%22name%22:+%22itemRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "itemName"
}
],
"metrics": [
{
"name": "itemsViewed"
},
{
"name": "itemsAddedToCart"
},
{
"name": "itemsPurchased"
},
{
"name": "itemRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
### Purchase journey
The [Purchase journey report](https://support.google.com/analytics/answer/13128171)
shows how many users drop off between each step in your purchase funnel.
The report can help you identify steps in the funnel that need improvement.
#### Purchase journey: Device category
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22itemName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22itemsViewed%22%7D,+%7B%22name%22:+%22itemsAddedToCart%22%7D,+%7B%22name%22:+%22itemsPurchased%22%7D,+%7B%22name%22:+%22itemRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "itemName"
}
],
"metrics": [
{
"name": "itemsViewed"
},
{
"name": "itemsAddedToCart"
},
{
"name": "itemsPurchased"
},
{
"name": "itemRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
### Promotions
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22itemPromotionName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22itemsViewedInPromotion%22%7D,+%7B%22name%22:+%22itemsClickedInPromotion%22%7D,+%7B%22name%22:+%22itemPromotionClickThroughRate%22%7D,+%7B%22name%22:+%22itemsAddedToCart%22%7D,+%7B%22name%22:+%22itemsCheckedOut%22%7D,+%7B%22name%22:+%22itemsPurchased%22%7D,+%7B%22name%22:+%22itemRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "itemPromotionName"
}
],
"metrics": [
{
"name": "itemsViewedInPromotion"
},
{
"name": "itemsClickedInPromotion"
},
{
"name": "itemPromotionClickThroughRate"
},
{
"name": "itemsAddedToCart"
},
{
"name": "itemsCheckedOut"
},
{
"name": "itemsPurchased"
},
{
"name": "itemRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
### Checkout journey
The [Checkout journey report](https://support.google.com/analytics/answer/14000977)
shows the number and percentage of users who began checkout on your
ecommerce website or app and completed each of the subsequent steps in
the checkout funnel.
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22funnelBreakdown%22:+%7B%22breakdownDimension%22:+%7B%22name%22:+%22deviceCategory%22%7D%7D,+%22funnel%22:+%7B%22steps%22:+%5B%7B%22name%22:+%22Begin+checkout%22,+%22filterExpression%22:+%7B%22funnelEventFilter%22:+%7B%22eventName%22:+%22begin_checkout%22%7D%7D%7D,+%7B%22name%22:+%22Add+shipping%22,+%22filterExpression%22:+%7B%22funnelEventFilter%22:+%7B%22eventName%22:+%22add_shipping_info%22%7D%7D%7D,+%7B%22name%22:+%22Add+payment%22,+%22filterExpression%22:+%7B%22funnelEventFilter%22:+%7B%22eventName%22:+%22add_payment_info%22%7D%7D%7D,+%7B%22name%22:+%22Purchase%22,+%22filterExpression%22:+%7B%22funnelEventFilter%22:+%7B%22eventName%22:+%22purchase%22%7D%7D%7D%5D%7D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"funnelBreakdown": {
"breakdownDimension": {
"name": "deviceCategory"
}
},
"funnel": {
"steps": [
{
"name": "Begin checkout",
"filterExpression": {
"funnelEventFilter": {
"eventName": "begin_checkout"
}
}
},
{
"name": "Add shipping",
"filterExpression": {
"funnelEventFilter": {
"eventName": "add_shipping_info"
}
}
},
{
"name": "Add payment",
"filterExpression": {
"funnelEventFilter": {
"eventName": "add_payment_info"
}
}
},
{
"name": "Purchase",
"filterExpression": {
"funnelEventFilter": {
"eventName": "purchase"
}
}
}
]
}
}
```
### Retention
#### User retention by cohort
### UI Example
For **each date** on the chart:
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dimensions%22:+%5B%7B%22name%22:+%22cohort%22%7D,+%7B%22name%22:+%22cohortNthDay%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22cohortRetentionFraction%22,+%22expression%22:+%22cohortActiveUsers/cohortTotalUsers%22%7D%5D,+%22cohortSpec%22:+%7B%22cohorts%22:+%5B%7B%22dimension%22:+%22firstSessionDate%22,+%22dateRange%22:+%7B%22startDate%22:+%222023-12-11%22,+%22endDate%22:+%222023-12-11%22%7D%7D%5D,+%22cohortsRange%22:+%7B%22endOffset%22:+7,+%22granularity%22:+%22DAILY%22%7D%7D%7D%7D "Open this sample in API Explorer")
```json
{
"dimensions": [
{
"name": "cohort"
},
{
"name": "cohortNthDay"
}
],
"metrics": [
{
"name": "cohortRetentionFraction",
"expression": "cohortActiveUsers/cohortTotalUsers"
}
],
"cohortSpec": {
"cohorts": [
{
"dimension": "firstSessionDate",
"dateRange": {
"startDate": "2023-12-11",
"endDate": "2023-12-11"
}
}
],
"cohortsRange": {
"endOffset": 7,
"granularity": "DAILY"
}
}
}
```
From a response object, retrieve metric values for cohort days 001 and 007
from the response, for example:
```json
{
"dimensionValues": [
{
"value": "cohort_0"
},
{
"value": "0001"
}
],
"metricValues": [
{
"value": "0.045319219318557723"
}
]
},
```
```json
{
"dimensionValues": [
{
"value": "cohort_0"
},
{
"value": "0007"
}
],
"metricValues": [
{
"value": "0.011577902745616937"
}
]
},
```
#### User retention
### UI Example
The report is based on last 42 days, so the start and end date should include
the date 42 days ago.
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dimensions%22:+%5B%7B%22name%22:+%22cohort%22%7D,+%7B%22name%22:+%22cohortNthDay%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22userRetention%22,+%22expression%22:+%22cohortActiveUsers/cohortTotalUsers%22%7D%5D,+%22cohortSpec%22:+%7B%22cohorts%22:+%5B%7B%22dimension%22:+%22firstSessionDate%22,+%22dateRange%22:+%7B%22startDate%22:+%222023-11-21%22,+%22endDate%22:+%222023-11-21%22%7D%7D%5D,+%22cohortsRange%22:+%7B%22endOffset%22:+42,+%22granularity%22:+%22DAILY%22%7D%7D%7D%7D "Open this sample in API Explorer")
```json
{
"dimensions": [
{
"name": "cohort"
},
{
"name": "cohortNthDay"
}
],
"metrics": [
{
"name": "userRetention",
"expression": "cohortActiveUsers/cohortTotalUsers"
}
],
"cohortSpec": {
"cohorts": [
{
"dimension": "firstSessionDate",
"dateRange": {
"startDate": "2023-11-21",
"endDate": "2023-11-21"
}
}
],
"cohortsRange": {
"endOffset": 42,
"granularity": "DAILY"
}
}
}
```
## User attributes
### Demographic details
The [Demographic details report](https://support.google.com/analytics/answer/12948931)
is a predefined detail report that provides key characteristics about
the people who use a website or app, including a user's language,
interests, location, age, and gender.
#### Users by Country over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22country%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22country%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"country"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "country"
}
],
"metrics": [
{
"name": "activeUsers"
}
]
}
```
#### Users by Country
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22country%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D%5D,+%22limit%22:+5%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "country"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"limit": 5
}
```
#### Demographic details: Country
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22country%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D,+%7B%22name%22:+%22newUsers%22%7D,+%7B%22name%22:+%22engagedSessions%22%7D,+%7B%22name%22:+%22engagementRate%22%7D,+%7B%22name%22:+%22engagedSessionsPerUser%22,+%22expression%22:+%22engagedSessions/activeUsers%22%7D,+%7B%22name%22:+%22averageEngagementTimePerUser%22,+%22expression%22:+%22userEngagementDuration/activeUsers%22%7D,+%7B%22name%22:+%22eventCount%22%7D,+%7B%22name%22:+%22keyEvents%22%7D,+%7B%22name%22:+%22totalRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "country"
}
],
"metrics": [
{
"name": "activeUsers"
},
{
"name": "newUsers"
},
{
"name": "engagedSessions"
},
{
"name": "engagementRate"
},
{
"name": "engagedSessionsPerUser",
"expression": "engagedSessions/activeUsers"
},
{
"name": "averageEngagementTimePerUser",
"expression": "userEngagementDuration/activeUsers"
},
{
"name": "eventCount"
},
{
"name": "keyEvents"
},
{
"name": "totalRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
### Audiences
#### Users by Audience over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22audienceName%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22audienceName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"audienceName"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "audienceName"
}
],
"metrics": [
{
"name": "activeUsers"
}
]
}
```
#### Audiences: Audience
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22audienceName%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D,+%7B%22name%22:+%22newUsers%22%7D,+%7B%22name%22:+%22sessions%22%7D,+%7B%22name%22:+%22screenPageViewsPerSession%22%7D,+%7B%22name%22:+%22averageSessionDuration%22%7D,+%7B%22name%22:+%22totalRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "audienceName"
}
],
"metrics": [
{
"name": "activeUsers"
},
{
"name": "newUsers"
},
{
"name": "sessions"
},
{
"name": "screenPageViewsPerSession"
},
{
"name": "averageSessionDuration"
},
{
"name": "totalRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
## Tech
### Tech details
#### Users by Browser over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22browser%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22browser%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"browser"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "browser"
}
],
"metrics": [
{
"name": "activeUsers"
}
]
}
```
#### Users by Browser
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22browser%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D%5D,+%22limit%22:+5%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "browser"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"limit": 5
}
```
#### Tech details: Browser
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22browser%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22activeUsers%22%7D,+%7B%22name%22:+%22newUsers%22%7D,+%7B%22name%22:+%22engagedSessions%22%7D,+%7B%22name%22:+%22engagementRate%22%7D,+%7B%22name%22:+%22engagedSessionsPerUser%22,+%22expression%22:+%22engagedSessions/activeUsers%22%7D,+%7B%22name%22:+%22averageEngagementTimePerUser%22,+%22expression%22:+%22userEngagementDuration/activeUsers%22%7D,+%7B%22name%22:+%22eventCount%22%7D,+%7B%22name%22:+%22keyEvents%22%7D,+%7B%22name%22:+%22totalRevenue%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "browser"
}
],
"metrics": [
{
"name": "activeUsers"
},
{
"name": "newUsers"
},
{
"name": "engagedSessions"
},
{
"name": "engagementRate"
},
{
"name": "engagedSessionsPerUser",
"expression": "engagedSessions/activeUsers"
},
{
"name": "averageEngagementTimePerUser",
"expression": "userEngagementDuration/activeUsers"
},
{
"name": "eventCount"
},
{
"name": "keyEvents"
},
{
"name": "totalRevenue"
}
],
"metricAggregations": [
"TOTAL"
]
}
```
## Advertising
### Planning: All channels
#### Key events by Primary channel group (Default Channel Group) over time
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runPivotReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22pivots%22:+%5B%7B%22fieldNames%22:+%5B%22date%22%5D,+%22orderBys%22:+%5B%7B%22dimension%22:+%7B%22dimensionName%22:+%22date%22%7D%7D%5D,+%22limit%22:+28%7D,+%7B%22fieldNames%22:+%5B%22defaultChannelGroup%22%5D,+%22limit%22:+5%7D%5D,+%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22date%22%7D,+%7B%22name%22:+%22defaultChannelGroup%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22keyEvents%22%7D%5D%7D%7D "Open this sample in API Explorer")
```json
{
"pivots": [
{
"fieldNames": [
"date"
],
"orderBys": [
{
"dimension": {
"dimensionName": "date"
}
}
],
"limit": 28
},
{
"fieldNames": [
"defaultChannelGroup"
],
"limit": 5
}
],
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "date"
},
{
"name": "defaultChannelGroup"
}
],
"metrics": [
{
"name": "keyEvents"
}
]
}
```
#### Key events by Primary channel group (Default Channel Group)
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22defaultChannelGroup%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22keyEvents%22%7D%5D,+%22limit%22:+5%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "defaultChannelGroup"
}
],
"metrics": [
{
"name": "keyEvents"
}
],
"limit": 5
}
```
#### All channels
### UI Example
### HTTP
[Open in API Explorer](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport.md.txt?apix=true&apix_params=%0A%7B%22resource%22:%7B%22dateRanges%22:+%5B%7B%22startDate%22:+%2228daysAgo%22,+%22endDate%22:+%22yesterday%22%7D%5D,+%22dimensions%22:+%5B%7B%22name%22:+%22defaultChannelGroup%22%7D%5D,+%22metrics%22:+%5B%7B%22name%22:+%22keyEvents%22%7D,+%7B%22name%22:+%22advertiserAdCost%22%7D,+%7B%22name%22:+%22advertiserAdCostPerKeyEvent%22%7D,+%7B%22name%22:+%22totalRevenue%22%7D,+%7B%22name%22:+%22returnOnAdSpend%22%7D%5D,+%22metricAggregations%22:+%5B%22TOTAL%22%5D%7D%7D "Open this sample in API Explorer")
```json
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "defaultChannelGroup"
}
],
"metrics": [
{
"name": "keyEvents"
},
{
"name": "advertiserAdCost"
},
{
"name": "advertiserAdCostPerKeyEvent"
},
{
"name": "totalRevenue"
},
{
"name": "returnOnAdSpend"
}
],
"metricAggregations": [
"TOTAL"
]
}
```