How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Google Analytics reports API

The reports API from Google Analytics — 1 operation(s) for reports.

Google Analytics reports API is one of 13 APIs that Google Analytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 1 operation across 1 path, and defines 36 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, https://analyticsadmin.googleapis.com/.

1 operations 1 paths 36 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://analyticsreporting.googleapis.com
Authentication
OAuth 2.0, OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

Google Analytics reports API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (Oauth2) using the implicit flow, exposing 2 scopes. It supports OAuth 2.0 (Oauth2c) using the authorizationCode flow, exposing 2 scopes.

  • Oauth2 — Oauth 2.0 implicit authentication
  • Oauth2c — Oauth 2.0 authorizationCode authentication

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

reports 1
POST
/v4/reports:batchGet
Returns the Analytics data.
analyticsreporting.reports.batchGet 11 params body → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are ReportRequest (17 properties), ReportData (10 properties), SegmentDimensionFilter (6 properties), Pivot (5 properties). Each schema is shown below with its type and property counts.

ReportRow
object
A row in the report.
2 properties
SegmentMetricFilter
object
Metric filter to be used in a segment filter clause.
5 properties
OrFiltersForSegment
object
A list of segment filters in the OR group are combined with the logical OR operator.
1 property
PivotValueRegion
object
The metric values in the pivot region.
1 property
Dimension
object
[Dimensions](https://support.google.com/analytics/answer/1033861) are attributes of your data. For example, the dimension ga:city indicates the city, for examp…
2 properties
Cohort
object
Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same coho…
3 properties
DimensionFilterClause
object
A group of dimension filters. Set the operator value to specify how the filters are logically combined.
2 properties
SegmentFilter
object
SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select th…
3 properties
OrderBy
object
Specifies the sorting options.
3 properties
CohortGroup
object
Defines a cohort group. For example: "cohortGroup": { "cohorts": [{ "name": "cohort 1", "type": "FIRSTVISITDATE", "dateRange": { "startDate": "2015-08-01", "en…
2 properties
DimensionFilter
object
Dimension filter specifies the filtering options on a dimension.
5 properties
SegmentSequenceStep
object
A segment sequence definition.
2 properties
DateRangeValues
object
Used to return a list of metrics for a single DateRange / dimension combination
2 properties
SegmentFilterClause
object
Filter Clause to be used in a segment definition, can be wither a metric or a dimension filter.
3 properties
Pivot
object
The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a sec…
5 properties
GetReportsResponse
object
The main response class which holds the reports from the Reporting API batchGet call.
3 properties
Report
object
The data response corresponding to the request.
3 properties
PivotHeaderEntry
object
The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response.
3 properties
SegmentDefinition
object
SegmentDefinition defines the segment to be a set of SegmentFilters which are combined together with a logical AND operation.
1 property
ColumnHeader
object
Column headers.
2 properties
MetricHeaderEntry
object
Header for the metrics.
2 properties
SegmentDimensionFilter
object
Dimension filter specifies the filtering options on a dimension.
6 properties
DateRange
object
A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/ISO8601)…
2 properties
MetricFilter
object
MetricFilter specifies the filter on a metric.
4 properties
DynamicSegment
object
Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both.
3 properties
SequenceSegment
object
Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with sp…
2 properties
Metric
object
[Metrics](https://support.google.com/analytics/answer/1033861) are the quantitative measurements. For example, the metric ga:users indicates the total number o…
3 properties
MetricFilterClause
object
Represents a group of metric filters. Set the operator value to specify how the filters are logically combined.
2 properties
Segment
object
The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment…
2 properties
MetricHeader
object
The headers for the metrics.
2 properties
PivotHeader
object
The headers for each of the pivot sections defined in the request.
2 properties
GetReportsRequest
object
The batch request containing multiple report request.
2 properties
ResourceQuotasRemaining
object
The resource quota tokens remaining for the property after the request is completed.
2 properties
ReportRequest
object
The main request class which specifies the Reporting API request.
17 properties
SimpleSegment
object
A Simple segment conditions consist of one or more dimension/metric conditions that can be combined.
1 property
ReportData
object
The data part of the report.
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

google-analytics-reports-api-openapi.yml Raw ↑

Other APIs Google Analytics publishes across the network.

Google Analytics accounts API
Google Analytics accountSummaries API
Google Analytics data API
Google Analytics Events API
Google Analytics management API
Google Analytics metadata API
Google Analytics properties API
Google Analytics provisioning API
Google Analytics User Deletion API
Google Analytics userActivity API
Google Analytics userDeletion API
Google Analytics Validation API
Where this information came from

This is an independent, third-party profile of Google Analytics reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.