Try the MCP server for Google Analytics. Install from GitHub , and see the announcement for more details.

Create a report

This guide explains how to create a basic report for your Analytics data using the Google Analytics Data API v1. Reports from the Data API v1 are similar to the reports you can generate in the Reportssection of the Google Analytics UI .

This guide covers core reporting, the general reporting feature of the Data API. The Data API v1 also has specialized Realtime reporting and Funnel reporting .

runReport is the recommended method for queries, and is used in all examples throughout this guide. See advanced features for an overview of other core reporting methods. Try the Query Explorer to test your queries.

Reports overview

Reports are tables of event data for a Google Analytics property . Each report table has the dimensions and metrics requested in your query, with data in individual rows.

Use filters to return only rows matching a certain condition, and pagination to navigate through results.

Here's a sample report table that shows one dimension ( Country ) and one metric ( activeUsers ):

Country	Active Users
Japan	2541
France	12

Specify a data source

Every runReport request requires you to specify a Google Analytics property ID . The Analytics property you specify is used as the dataset for that query. Here's an example:

 POST https://analyticsdata.googleapis.com/v1beta/properties/ GA_PROPERTY_ID 
:runReport

The response from this request includes only data from the Analytics property you specify as the GA_PROPERTY_ID .

If you use the Data API client libraries , specify the data source in the property parameter, in the form of properties/ GA_PROPERTY_ID . See the quick start guide for examples of using the client libraries.

See Send Measurement Protocol events to Google Analytics if you want to include Measurement Protocol events in your reports.

Generate a report

To generate a report, construct a RunReportRequest object. We recommend starting with the following parameters:

A valid entry in the dateRanges field.
At least one valid entry in the dimensions field.
At least one valid entry in the metrics field.

Here's a sample request with the recommended fields:

HTTP

  POST 
  
 h 
 tt 
 ps 
 : 
 //analyticsdata.googleapis.com/v1beta/properties/ GA_PROPERTY_ID 
:runReport 
  
 { 
  
 "dateRanges" 
 : 
  
 [{ 
  
 "startDate" 
 : 
  
 " 2023-09-01" 
", " 
 e 
 n 
 dDa 
 te 
 ": " 
  2023-09-15 
 
 " }], 
 " 
 dime 
 ns 
 io 
 ns 
 ": [{ " 
 na 
 me 
 ": " 
 cou 
 ntr 
 y 
 " }], 
 " 
 me 
 tr 
 ics 
 ": [{ " 
 na 
 me 
 ": " 
 ac 
 t 
 iveUsers" }] 
 }

Java

google-analytics-data/src/main/java/com/google/analytics/data/samples/RunReportSample.java

Open in Cloud Shell View on GitHub

 import 
  
 com.google.analytics.data.v1beta.BetaAnalyticsDataClient 
 ; 
 import 
  
 com.google.analytics.data.v1beta.DateRange 
 ; 
 import 
  
 com.google.analytics.data.v1beta.Dimension 
 ; 
 import 
  
 com.google.analytics.data.v1beta.DimensionHeader 
 ; 
 import 
  
 com.google.analytics.data.v1beta.Metric 
 ; 
 import 
  
 com.google.analytics.data.v1beta.MetricHeader 
 ; 
 import 
  
 com.google.analytics.data.v1beta.Row 
 ; 
 import 
  
 com.google.analytics.data.v1beta.RunReportRequest 
 ; 
 import 
  
 com.google.analytics.data.v1beta.RunReportResponse 
 ; 
 /** 
 * Google Analytics Data API sample application demonstrating the creation of a basic report. 
 * 
 * <p>See 
 * https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport 
 * for more information. 
 * 
 * <p>Before you start the application, please review the comments starting with "TODO(developer)" 
 * and update the code to use correct values. 
 * 
 * <p>To run this sample using Maven: 
 * 
 * <pre>{@code 
 * cd google-analytics-data 
 * mvn compile exec:java -Dexec.mainClass="com.google.analytics.data.samples.RunReportSample" 
 * }</pre> 
 */ 
 public 
  
 class 
 RunReportSample 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 ... 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 /** 
 * TODO(developer): Replace this variable with your Google Analytics 4 property ID before 
 * running the sample. 
 */ 
  
 String 
  
 propertyId 
  
 = 
  
 "YOUR-GA4-PROPERTY-ID" 
 ; 
  
 sampleRunReport 
 ( 
 propertyId 
 ); 
  
 } 
  
 // Runs a report of active users grouped by country. 
  
 static 
  
 void 
  
 sampleRunReport 
 ( 
 String 
  
 propertyId 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // Using a default constructor instructs the client to use the credentials 
  
 // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable. 
  
 try 
  
 ( 
 BetaAnalyticsDataClient 
  
 analyticsData 
  
 = 
  
 BetaAnalyticsDataClient 
 . 
 create 
 ()) 
  
 { 
  
 RunReportRequest 
  
 request 
  
 = 
  
 RunReportRequest 
 . 
 newBuilder 
 () 
  
 . 
 setProperty 
 ( 
 "properties/" 
  
 + 
  
 propertyId 
 ) 
  
 . 
 addDimensions 
 ( 
 Dimension 
 . 
 newBuilder 
 (). 
 setName 
 ( 
 "country" 
 )) 
  
 . 
 addMetrics 
 ( 
 Metric 
 . 
 newBuilder 
 (). 
 setName 
 ( 
 "activeUsers" 
 )) 
  
 . 
 addDateRanges 
 ( 
  
 DateRange 
 . 
 newBuilder 
 (). 
 setStartDate 
 ( 
 "2020-09-01" 
 ). 
 setEndDate 
 ( 
 "2020-09-15" 
 )) 
  
 . 
 build 
 (); 
  
 // Make the request. 
  
 RunReportResponse 
  
 response 
  
 = 
  
 analyticsData 
 . 
 runReport 
 ( 
 request 
 ); 
  
 printRunResponseResponse 
 ( 
 response 
 ); 
  
 } 
  
 } 
  
 // Prints results of a runReport call. 
  
 static 
  
 void 
  
 printRunResponseResponse 
 ( 
 RunReportResponse 
  
 response 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "%s rows received%n" 
 , 
  
 response 
 . 
 getRowsList 
 (). 
 size 
 ()); 
  
 for 
  
 ( 
 DimensionHeader 
  
 header 
  
 : 
  
 response 
 . 
 getDimensionHeadersList 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Dimension header name: %s%n" 
 , 
  
 header 
 . 
 getName 
 ()); 
  
 } 
  
 for 
  
 ( 
 MetricHeader 
  
 header 
  
 : 
  
 response 
 . 
 getMetricHeadersList 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Metric header name: %s (%s)%n" 
 , 
  
 header 
 . 
 getName 
 (), 
  
 header 
 . 
 getType 
 ()); 
  
 } 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Report result:" 
 ); 
  
 for 
  
 ( 
 Row 
  
 row 
  
 : 
  
 response 
 . 
 getRowsList 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
  
 "%s, %s%n" 
 , 
  
 row 
 . 
 getDimensionValues 
 ( 
 0 
 ). 
 getValue 
 (), 
  
 row 
 . 
 getMetricValues 
 ( 
 0 
 ). 
 getValue 
 ()); 
  
 } 
  
 } 
 } 
   RunReportSample 
 . 
 java

PHP

google-analytics-data/src/run_report.php

Open in Cloud Shell View on GitHub

 use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient; 
 use Google\Analytics\Data\V1beta\DateRange; 
 use Google\Analytics\Data\V1beta\Dimension; 
 use Google\Analytics\Data\V1beta\Metric; 
 use Google\Analytics\Data\V1beta\MetricType; 
 use Google\Analytics\Data\V1beta\RunReportRequest; 
 use Google\Analytics\Data\V1beta\RunReportResponse; 
 /** 
 * @param string $propertyId Your GA-4 Property ID 
 */ 
 function run_report(string $propertyId) 
 { 
 // Create an instance of the Google Analytics Data API client library. 
 $client = new BetaAnalyticsDataClient(); 
 // Make an API call. 
 $request = (new RunReportRequest()) 
 ->setProperty('properties/' . $propertyId) 
 ->setDateRanges([ 
 new DateRange([ 
 'start_date' => '2020-09-01', 
 'end_date' => '2020-09-15', 
 ]), 
 ]) 
 ->setDimensions([ 
 new Dimension([ 
 'name' => 'country', 
 ]), 
 ]) 
 ->setMetrics([ 
 new Metric([ 
 'name' => 'activeUsers', 
 ]), 
 ]); 
 $response = $client->runReport($request); 
 printRunReportResponse($response); 
 } 
 /** 
 * Print results of a runReport call. 
 * @param RunReportResponse $response 
 */ 
 function printRunReportResponse(RunReportResponse $response) 
 { 
 printf('%s rows received%s', $response->getRowCount(), PHP_EOL); 
 foreach ($response->getDimensionHeaders() as $dimensionHeader) { 
 printf('Dimension header name: %s%s', $dimensionHeader->getName(), PHP_EOL); 
 } 
 foreach ($response->getMetricHeaders() as $metricHeader) { 
 printf( 
 'Metric header name: %s (%s)%s', 
 $metricHeader->getName(), 
 MetricType::name($metricHeader->getType()), 
 PHP_EOL 
 ); 
 } 
 print 'Report result: ' . PHP_EOL; 
 foreach ($response->getRows() as $row) { 
 print $row->getDimensionValues()[0]->getValue() 
 . ' ' . $row->getMetricValues()[0]->getValue() . PHP_EOL; 
 } 
 }  run_report.php

offset	limit	Range of row indexes returned
`0`	`250000`	`[ 0, 249999]`
`250000`	`250000`	`[250000, 499999]`
`500000`	`250000`	`[500000, 572345]`

Create a report Stay organized with collections Save and categorize content based on your preferences.

Reports overview

Specify a data source

Generate a report

HTTP

Java

PHP

Python

Node.js

Query for metrics

HTTP

Java

PHP

Python

Node.js

Read the response

Group and filter data

Group

HTTP

Java

PHP

Python

Node.js

Filter

HTTP

Java

PHP

Python

Node.js

HTTP

Java

PHP

Python

Node.js

HTTP

Java

PHP

Python

Node.js

HTTP

Java

PHP

Python

Node.js

Navigate long reports

HTTP

Java

PHP

Python

Node.js

HTTP

Java

PHP

Python

Node.js

Use multiple date ranges

HTTP

Java

PHP

Python

Node.js

Next steps

Create a report