Este documento apresenta as consultas da API Data equivalentes a relatórios predefinidos disponível na interface do Google Analytics. Clique na guia HTTP para ver solicitações de API.
Ciclo de vida
Aquisição de usuários
Relatório "Aquisição de usuários" é um relatório detalhado predefinido que pode ser usado para sobre como novos usuários encontram seu site ou app pela primeira vez.
Novos usuários por grupo de canais padrão do primeiro usuário ao longo do tempo
{
"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"
}
]
}
Novos usuários por grupo principal de canais atribuído ao primeiro usuário (grupo de canais padrão)
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "firstUserDefaultChannelGroup"
}
],
"metrics": [
{
"name": "newUsers"
}
],
"limit": 5
}
Relatório de aquisição de usuários
Relatório "Aquisição de usuários" é um relatório detalhado predefinido que pode ser usado para insights sobre como os novos usuários encontrar seu site ou app pela primeira vez.
{ "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" ] }
Aquisição de tráfego
O Relatório de aquisição de tráfego é um relatório detalhado predefinido criado para ajudar você a entender onde de onde vêm os visitantes do seu site e app. Ele mostra especificamente de onde vêm os usuários novos e recorrentes.
Usuários por grupo de canais principal da sessão (grupo de canais padrão) ao longo do tempo
{
"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"
}
]
}
Usuários por grupo de canais principal da sessão (grupo de canais padrão)
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "sessionDefaultChannelGroup"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"limit": 5
}
Aquisição de tráfego: grupo de canais principal da sessão (grupo de canais padrão)
{ "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" ] }
Engajamento
Eventos
O Relatório de eventos é um relatório detalhado predefinido que mostra quantas vezes cada evento acionadas e quantos usuários acionam cada evento no seu site ou app.
Contagem de eventos por nome ao longo do tempo
{
"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"
}
]
}
Contagem de eventos por nome do evento
{
"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"
}
]
}
Eventos: nome do evento
{ "dateRanges": [ { "startDate": "28daysAgo", "endDate": "yesterday" } ], "dimensions": [ { "name": "eventName" } ], "metrics": [ { "name": "eventCount" }, { "name": "totalUsers" }, { "name": "eventCountPerUser" }, { "name": "totalRevenue" } ], "metricAggregations": [ "TOTAL" ] }
Páginas e telas
Relatório de páginas e telas é um relatório detalhado predefinido que mostra dados sobre as páginas que os usuários visitaram no seu site e nas telas que os usuários abriram no seu app para dispositivos móveis, permitindo para ver para onde as pessoas estão indo em seus sites e aplicativos.
Visualizações por caminho da página e classe da tela ao longo do tempo
{
"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"
}
]
}
Visualizações por caminho da página e classe da tela
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "unifiedPagePathScreen"
}
],
"metrics": [
{
"name": "screenPageViews"
}
],
"limit": 5
}
Páginas e telas: caminho da página e classe da tela
{ "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" ] }
Página de destino
Relatório de páginas de destino é um relatório detalhado predefinido que ajuda a entender interagem com seu site. Ela mostra a primeira página que o visitante acessa. quando eles visitam seu site e quantos visitantes chegam em cada página.
Sessões por página de destino ao longo do tempo
{
"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)"
}
}
}
}
}
Página de destino: página de destino
{ "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" ] }
Monetização
Compras de e-commerce
Relatório de compras de e-commerce é um relatório detalhado predefinido que mostra informações sobre os produtos ou serviços que você vende na sua loja de e-commerce.
Consulta de itens por nome ao longo do tempo
{
"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"
}
]
}
Item acessado e adicionado ao carrinho por nome
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "itemName"
}
],
"metrics": [
{
"name": "itemsViewed"
},
{
"name": "itemsAddedToCart"
}
]
}
Compras de e-commerce: nome do item
{ "dateRanges": [ { "startDate": "28daysAgo", "endDate": "yesterday" } ], "dimensions": [ { "name": "itemName" } ], "metrics": [ { "name": "itemsViewed" }, { "name": "itemsAddedToCart" }, { "name": "itemsPurchased" }, { "name": "itemRevenue" } ], "metricAggregations": [ "TOTAL" ] }
Jornada de compra
Relatório da jornada de compra mostra quantos usuários desistem entre cada etapa do funil de compra. Ele ajuda a identificar as etapas do funil que precisam de melhorias.
Jornada de compra: categoria do dispositivo
{ "dateRanges": [ { "startDate": "28daysAgo", "endDate": "yesterday" } ], "dimensions": [ { "name": "itemName" } ], "metrics": [ { "name": "itemsViewed" }, { "name": "itemsAddedToCart" }, { "name": "itemsPurchased" }, { "name": "itemRevenue" } ], "metricAggregations": [ "TOTAL" ] }
Promoções
{ "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" ] }
Jornada de finalização da compra
O Relatório da jornada de finalização de compra mostra o número e a porcentagem de usuários que iniciaram a finalização da compra no seu site ou app de e-commerce e concluiu cada uma das etapas subsequentes o funil de checkout.
{
"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"
}
}
}
]
}
}
Retenção
Retenção de usuários por coorte
Para cada data no gráfico:
{
"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"
}
}
}
A partir de um objeto de resposta, recupere valores de métrica para os dias de coorte 001 e 007 da resposta, por exemplo:
{
"dimensionValues": [
{
"value": "cohort_0"
},
{
"value": "0001"
}
],
"metricValues": [
{
"value": "0.045319219318557723"
}
]
},
{
"dimensionValues": [
{
"value": "cohort_0"
},
{
"value": "0007"
}
],
"metricValues": [
{
"value": "0.011577902745616937"
}
]
},
Retenção de usuários
O relatório é baseado nos últimos 42 dias. Portanto, as datas de início e término precisam incluir a data 42 dias atrás.
{
"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"
}
}
}
Atributos do usuário
Detalhes demográficos
Relatório de detalhes demográficos é um relatório detalhado predefinido que apresenta as principais características as pessoas que usam um site ou app, incluindo o idioma do usuário; interesses, localização, idade e gênero.
Usuários por país ao longo do tempo
{
"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"
}
]
}
Usuários por país
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "country"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"limit": 5
}
Detalhes demográficos: país
{ "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" ] }
Públicos-alvo
Usuários por público-alvo ao longo do tempo
{
"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"
}
]
}
Públicos-alvo: público-alvo
{ "dateRanges": [ { "startDate": "28daysAgo", "endDate": "yesterday" } ], "dimensions": [ { "name": "audienceName" } ], "metrics": [ { "name": "activeUsers" }, { "name": "newUsers" }, { "name": "sessions" }, { "name": "screenPageViewsPerSession" }, { "name": "averageSessionDuration" }, { "name": "totalRevenue" } ], "metricAggregations": [ "TOTAL" ] }
Tecnologia
Detalhes de tecnologia
Usuários por navegador ao longo do tempo
{
"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"
}
]
}
Usuários por navegador
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "browser"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"limit": 5
}
Detalhes de tecnologia: navegador
{ "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" ] }
Publicidade
Planejamento: todos os canais
Eventos principais por grupo de canais principal (grupo de canais padrão) ao longo do tempo
{
"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"
}
]
}
Eventos principais por grupo de canais principal (grupo de canais padrão)
{
"dateRanges": [
{
"startDate": "28daysAgo",
"endDate": "yesterday"
}
],
"dimensions": [
{
"name": "defaultChannelGroup"
}
],
"metrics": [
{
"name": "keyEvents"
}
],
"limit": 5
}
Todos os canais
{ "dateRanges": [ { "startDate": "28daysAgo", "endDate": "yesterday" } ], "dimensions": [ { "name": "defaultChannelGroup" } ], "metrics": [ { "name": "keyEvents" }, { "name": "advertiserAdCost" }, { "name": "advertiserAdCostPerKeyEvent" }, { "name": "totalRevenue" }, { "name": "returnOnAdSpend" } ], "metricAggregations": [ "TOTAL" ] }