ReportResult

    • A ReportResult contains the generated report data, including headers, rows, totals, and averages.

    • Each ReportResult includes the total number of matched rows and any warnings generated during report generation.

    • The headers provide information about the columns in the report, including their name, type, and currency code if applicable.

    • Rows consist of a list of cells, where each cell holds a string value representing the data.

    • HeaderType specifies the different types of headers such as dimension, metric tally, metric ratio, and metric currency.

    Result of a generated report.

    JSON representation 
     { 
 "totalMatchedRows" 
 : 
 string 
 , 
 "headers" 
 : 
 [ 
 { 
 object (  Header 
 
) 
 } 
 ] 
 , 
 "rows" 
 : 
 [ 
 { 
 object (  Row 
 
) 
 } 
 ] 
 , 
 "totals" 
 : 
 { 
 object (  Row 
 
) 
 } 
 , 
 "averages" 
 : 
 { 
 object (  Row 
 
) 
 } 
 , 
 "warnings" 
 : 
 [ 
 string 
 ] 
 , 
 "startDate" 
 : 
 { 
 object (  Date 
 
) 
 } 
 , 
 "endDate" 
 : 
 { 
 object (  Date 
 
) 
 } 
 }
    Fields
    totalMatchedRows

    string ( int64 format)

    The total number of rows matched by the report request.
    headers[]

    object ( Header )

    The header information; one for each dimension in the request, followed by one for each metric in the request.
    rows[]

    object ( Row )

    The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request.
    totals

    object ( Row )

    The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
    averages

    object ( Row )

    The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
    warnings[]

    string

    Any warnings associated with generation of the report. These warnings are always returned in English.
    startDate

    object ( Date )

    Required. Start date of the range (inclusive).
    endDate

    object ( Date )

    Required. End date of the range (inclusive).

    HeaderType

    Type of the header.

    Enums
    HEADER_TYPE_UNSPECIFIED Unspecified header.
    DIMENSION Dimension header type.
    METRIC_TALLY Tally header type.
    METRIC_RATIO Ratio header type.
    METRIC_CURRENCY Currency header type.
    METRIC_MILLISECONDS Milliseconds header type.
    METRIC_DECIMAL Decimal header type.

    Row

    Row representation.

    JSON representation 
     { 
 "cells" 
 : 
 [ 
 { 
 object (  Cell 
 
) 
 } 
 ] 
 }
    Fields
    cells[]

    object ( Cell )

    Cells in the row.

    Cell

    Cell representation.

    JSON representation 
     { 
 "value" 
 : 
 string 
 }
    Fields
    value

    string

    Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: