Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

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.

post/v1/{+parent}/reports

Path parameters

parentstring required

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

Request body

dimensionsstring[]

This contains the list of dimensions for the report

chartTypestring

This field contains the chart type for the report

sortByColsstring[]

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

commentsstring[]

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

tagsstring[]

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

createdAtstring int64

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

lastModifiedAtstring int64

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

namestring

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

organizationstring

Output only. Organization name

fromTimestring

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

environmentstring

Output only. Environment name

offsetstring

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

toTimestring

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

limitstring

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

timeUnitstring

This field contains the time unit of aggregation for the report

displayNamestring

This is the display name for the report

lastViewedAtstring int64

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

sortOrderstring

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

filterstring

This field contains the filter expression

topkstring

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

Response

Successful response