v1

latestOpenAPI 3.0.02026-07-24182211348.4 KB

Google analytics 4 reports

Preview report data

post/googleanalytics4/report/preview

Query parameters

searchTermstring

Contains match on the dimension value

limitinteger

The maximum number of records which should be retrieved. You cannot retrieve more than 100 records in a single call. By default, the limit is 20.

offsetinteger

The number of records which should be skipped.

Request body

Namestring

Name of the report.

PropertyNamestring

Name of the property the report gets its data from.

MetricNamesstring[]

Names of the metrics read from the property when running the report.

NrOfDaysBackinteger

How many days worth of data should be taken into account.

MappingDimensionNamestring

The name of the dimension used to map to an attribute.

MappingAttributeIdinteger

The ID of the attribute to which the dimension gets mapped.

RegexTemplatestring

Regex template used to get a substring of a URL. This substring is matched to the chosen mapping attribute. Only applicable to reports using the page views metric.

Response

The GA4 report preview

DimensionHeaderstring

MetricHeadersstring[]

TotalRowsinteger