Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.


You will need authorization for the scope to make a valid call.

If unset, the scope for this method defaults to You can set the scope for this method like this: apigee1 --scope <scope> organizations reports-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The parent organization name under which the Custom Report will be created. Must be of the form: organizations/{organization_id}/reports

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

  chart-type: string
  comments: [string]
  created-at: string
  dimensions: [string]
  display-name: string
  environment: string
  filter: string
  from-time: string
  last-modified-at: string
  last-viewed-at: string
  limit: string
  name: string
  offset: string
  organization: string
  sort-by-cols: [string]
  sort-order: string
  tags: [string]
  time-unit: string
  to-time: string
  topk: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . chart-type=dolor
    • This field contains the chart type for the report
  • comments=duo
    • Legacy field: not used. This field contains a list of comments associated with custom report
    • Each invocation of this argument appends the given value to the array.
  • created-at=diam
    • Output only. Unix time when the app was created json key: createdAt
  • dimensions=et
    • This contains the list of dimensions for the report
    • Each invocation of this argument appends the given value to the array.
  • display-name=lorem
    • This is the display name for the report
  • environment=no
    • Output only. Environment name
  • filter=sea
    • This field contains the filter expression
  • from-time=et
    • Legacy field: not used. Contains the from time for the report
  • last-modified-at=voluptua.
    • Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
  • last-viewed-at=ipsum
    • Output only. Last viewed time of this entity as milliseconds since epoch
  • limit=ea
    • Legacy field: not used This field contains the limit for the result retrieved
  • name=ipsum
    • Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
  • offset=eos
    • Legacy field: not used. This field contains the offset for the data
  • organization=vero
    • Output only. Organization name
  • sort-by-cols=sanctus
    • Legacy field: not used much. Contains the list of sort by columns
    • Each invocation of this argument appends the given value to the array.
  • sort-order=dolores
    • Legacy field: not used much. Contains the sort order for the sort columns
  • tags=elitr
    • Legacy field: not used. This field contains a list of tags associated with custom report
    • Each invocation of this argument appends the given value to the array.
  • time-unit=diam
    • This field contains the time unit of aggregation for the report
  • to-time=sed
    • Legacy field: not used. Contains the end time for the report
  • topk=lorem
    • Legacy field: not used. This field contains the top k parameter value for restricting the result

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").