Console
    Contact Us Start free

    REST Resource: organizations.reports

    Resource: CustomReport

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "metrics" 
 : 
 [ 
 { 
 object (  Metric 
 
) 
 } 
 ] 
 , 
 "dimensions" 
 : 
 [ 
 string 
 ] 
 , 
 "filter" 
 : 
 string 
 , 
 "createdAt" 
 : 
 string 
 , 
 "lastModifiedAt" 
 : 
 string 
 , 
 "properties" 
 : 
 [ 
 { 
 object (  ReportProperty 
 
) 
 } 
 ] 
 , 
 "chartType" 
 : 
 string 
 , 
 "timeUnit" 
 : 
 string 
 , 
 "sortByCols" 
 : 
 [ 
 string 
 ] 
 , 
 "sortOrder" 
 : 
 string 
 , 
 "fromTime" 
 : 
 string 
 , 
 "toTime" 
 : 
 string 
 , 
 "offset" 
 : 
 string 
 , 
 "limit" 
 : 
 string 
 , 
 "topk" 
 : 
 string 
 , 
 "organization" 
 : 
 string 
 , 
 "environment" 
 : 
 string 
 , 
 "lastViewedAt" 
 : 
 string 
 , 
 "tags" 
 : 
 [ 
 string 
 ] 
 , 
 "comments" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    name

    string

    Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
    displayName

    string

    This is the display name for the report
    metrics[]

    object ( Metric )

    Required. This contains the list of metrics
    dimensions[]

    string

    This contains the list of dimensions for the report
    filter

    string

    This field contains the filter expression
    createdAt

    string ( int64 format)

    Output only. Unix time when the app was created json key: createdAt
    lastModifiedAt

    string ( int64 format)

    Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
    properties[]

    object ( ReportProperty )

    This field contains report properties such as ui metadata etc.
    chartType

    string

    This field contains the chart type for the report
    timeUnit

    string

    This field contains the time unit of aggregation for the report
    sortByCols[]

    string

    Legacy field: not used much. Contains the list of sort by columns
    sortOrder

    string

    Legacy field: not used much. Contains the sort order for the sort columns
    fromTime

    string

    Legacy field: not used. Contains the from time for the report
    toTime

    string

    Legacy field: not used. Contains the end time for the report
    offset

    string

    Legacy field: not used. This field contains the offset for the data
    limit

    string

    Legacy field: not used This field contains the limit for the result retrieved
    topk

    string

    Legacy field: not used. This field contains the top k parameter value for restricting the result
    organization

    string

    Output only. Organization name
    environment

    string

    Output only. Environment name
    lastViewedAt

    string ( int64 format)

    Output only. Last viewed time of this entity as milliseconds since epoch
    tags[]

    string

    Legacy field: not used. This field contains a list of tags associated with custom report
    comments[]

    string

    Legacy field: not used. This field contains a list of comments associated with custom report

    Metric

    This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "function" 
 : 
 string 
 }
    Fields
    name

    string

    name of the metric
    function

    string

    aggregate function

    ReportProperty

    JSON representation 
     { 
 "property" 
 : 
 string 
 , 
 "value" 
 : 
 [ 
 { 
 object (  Attribute 
 
) 
 } 
 ] 
 }
    Fields
    property

    string

    name of the property
    value[]

    object ( Attribute )

    property values

    Methods

    create

    		Creates a Custom Report for an Organization.

    delete

    		Deletes an existing custom report definition

    get

    		Retrieve a custom report definition.

    list

    		Return a list of Custom Reports

    update

    		Update an existing custom report definition
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: