Method: networks.reports.results.fetchRows

Returns the result rows from a completed report. The caller must have previously called RunReport and waited for that operation to complete. The rows will be returned according to the order specified by the sorts member of the report definition.

HTTP request

GET https://admanager.googleapis.com/v1/{name}:fetchRows

Path parameters

Parameters
name

string

The report result being fetched. Format: networks/{networkCode}/reports/{reportId}/results/{reportResultId}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 1,000 rows will be returned. The maximum value is 10,000; values above 10,000 will be reduced to 10,000.
pageToken

string

Optional. A page token, received from a previous results.fetchRows call. Provide this to retrieve the second and subsequent batches of rows.

Request body

The request body must be empty.

Response body

The response message for the fetch report result rows endpoint.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "rows": [
    {
      object (Row)
    }
  ],
  "runTime": string,
  "dateRanges": [
    {
      object (FixedDateRange)
    }
  ],
  "comparisonDateRanges": [
    {
      object (FixedDateRange)
    }
  ],
  "totalRowCount": integer,
  "nextPageToken": string
}
Fields
rows[]

object (Row)

Up to pageSize rows of report data.
runTime

string (Timestamp format)

The time at which the report was scheduled to run. For non-scheduled reports, this is the time at which the report was requested to be run.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
dateRanges[]

object (FixedDateRange)

The computed fixed date ranges this report includes. Only returned with the first page of results (when pageToken is not included in the request).
comparisonDateRanges[]

object (FixedDateRange)

The computed comparison fixed date ranges this report includes. Only returned with the first page of results (when pageToken is not included in the request).
totalRowCount

integer

The total number of rows available from this report. Useful for pagination. Only returned with the first page of results (when pageToken is not included in the request).
nextPageToken

string

A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/admanager

For more information, see the OAuth 2.0 Overview.

Row

A row of report data.

JSON representation 
{
  "dimensionValues": [
    {
      object (Value)
    }
  ],
  "metricValueGroups": [
    {
      object (MetricValueGroup)
    }
  ]
}
Fields
dimensionValues[]

object (Value)

The order of the dimension values is the same as the order of the dimensions specified in the request.
metricValueGroups[]

object (MetricValueGroup)

The length of the metricValueGroups field will be equal to the length of the dateRanges field in the fetch response. The metricValueGroups field is ordered such that each index corresponds to the dateRange at the same index. For example, given dateRanges [x, y], metricValueGroups will have a length of two. The first entry in metricValueGroups represents the metrics for date x and the second entry in metricValueGroups represents the metrics for date y.

MetricValueGroup

Contains all metric values requested for a single date range and set of column dimension values (returned in the columns field of the response). The order of the metrics in each field corresponds to the order of the metrics specified in the request.

JSON representation 
{
  "primaryValues": [
    {
      object (Value)
    }
  ],
  "primaryPercentOfTotalValues": [
    {
      object (Value)
    }
  ],
  "comparisonValues": [
    {
      object (Value)
    }
  ],
  "comparisonPercentOfTotalValues": [
    {
      object (Value)
    }
  ],
  "absoluteChangeValues": [
    {
      object (Value)
    }
  ],
  "relativeChangeValues": [
    {
      object (Value)
    }
  ],
  "flagValues": [
    boolean
  ]
}
Fields
primaryValues[]

object (Value)

Data for the PRIMARY MetricValueType.
primaryPercentOfTotalValues[]

object (Value)

Data for the PRIMARY_PERCENT_OF_TOTAL MetricValueType.
comparisonValues[]

object (Value)

Data for the COMPARISON MetricValueType.
comparisonPercentOfTotalValues[]

object (Value)

Data for the COMPARISON_PERCENT_OF_TOTAL MetricValueType.
absoluteChangeValues[]

object (Value)

Data for the ABSOLUTE_CHANGE MetricValueType.
relativeChangeValues[]

object (Value)

Data for the RELATIVE_CHANGE MetricValueType.
flagValues[]

boolean

If true, the flag's conditions are met. If false, the flag's conditions are not met. flagValues has the same length as flags and index i of flagValues represents the flag at index i of flags.