Google analytics 4 reports

Returns GA4 report preview

post/googleanalytics4/report/preview

Request

  • The document declares no server URL.
  • Auth
    API key in header TWN-InstanceKey and API key in header TWN-Authentication

Query parameters

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.

searchTermstring

Request body

Namestring

Name of the report.

PropertyNamestring

Name of the GA4 property. Something like properties/123456.

MetricNamesstring[]

API names of the metrics to include in the report.

NrOfDaysBackinteger

Number of days back the report data covers.

MappingDimensionNamestring

API name of the dimension used for mapping report rows to products.

MappingAttributeIdinteger

Identifier of the attribute used for mapping report rows to products.

RegexTemplatestring nullable

Optional regex template applied to dimension values during mapping.

Response

OK

DimensionHeaderstring

Header label for the dimension column.

MetricHeadersstring[]

Header labels for the metric columns.

TotalRowsinteger

Total number of rows available in the report.

Changes

No recorded changes to this operation across all 1 revision of this API.