reports

Creates, updates, deletes, gets or lists a reports resource.

Overview

Name	reports
Type	Resource
Id	google.apigee.reports

Fields

Name	Datatype	Description
name	string	Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
chartType	string	This field contains the chart type for the report
comments	array	Legacy field: not used. This field contains a list of comments associated with custom report
createdAt	string	Output only. Unix time when the app was created json key: createdAt
dimensions	array	This contains the list of dimensions for the report
displayName	string	This is the display name for the report
environment	string	Output only. Environment name
filter	string	This field contains the filter expression
fromTime	string	Legacy field: not used. Contains the from time for the report
lastModifiedAt	string	Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
lastViewedAt	string	Output only. Last viewed time of this entity as milliseconds since epoch
limit	string	Legacy field: not used This field contains the limit for the result retrieved
metrics	array	Required. This contains the list of metrics
offset	string	Legacy field: not used. This field contains the offset for the data
organization	string	Output only. Organization name
properties	array	This field contains report properties such as ui metadata etc.
sortByCols	array	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
tags	array	Legacy field: not used. This field contains a list of tags associated with custom report
timeUnit	string	This field contains the time unit of aggregation for the report
toTime	string	Legacy field: not used. Contains the end time for the report
topk	string	Legacy field: not used. This field contains the top k parameter value for restricting the result

Methods

Name	Accessible by	Required Params	Description
organizations_reports_get	SELECT	organizationsId, reportsId	Retrieve a custom report definition.
organizations_reports_list	SELECT	organizationsId	Return a list of Custom Reports
organizations_reports_create	INSERT	organizationsId	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.
organizations_reports_delete	DELETE	organizationsId, reportsId	Deletes an existing custom report definition
organizations_reports_update	REPLACE	organizationsId, reportsId	Update an existing custom report definition

SELECT examples

Return a list of Custom Reports

SELECT
name,
chartType,
comments,
createdAt,
dimensions,
displayName,
environment,
filter,
fromTime,
lastModifiedAt,
lastViewedAt,
limit,
metrics,
offset,
organization,
properties,
sortByCols,
sortOrder,
tags,
timeUnit,
toTime,
topk
FROM google.apigee.reports
WHERE organizationsId = '{{ organizationsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new reports resource.

All Properties

/*+ create */
INSERT INTO google.apigee.reports (
organizationsId,
dimensions,
displayName,
sortOrder,
filter,
chartType,
metrics,
timeUnit,
name,
toTime,
sortByCols,
properties,
offset,
tags,
topk,
fromTime,
comments,
limit
)
SELECT 
'{{ organizationsId }}',
'{{ dimensions }}',
'{{ displayName }}',
'{{ sortOrder }}',
'{{ filter }}',
'{{ chartType }}',
'{{ metrics }}',
'{{ timeUnit }}',
'{{ name }}',
'{{ toTime }}',
'{{ sortByCols }}',
'{{ properties }}',
'{{ offset }}',
'{{ tags }}',
'{{ topk }}',
'{{ fromTime }}',
'{{ comments }}',
'{{ limit }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: dimensions
      value:
        - string
    - name: environment
      value: string
    - name: displayName
      value: string
    - name: organization
      value: string
    - name: sortOrder
      value: string
    - name: filter
      value: string
    - name: chartType
      value: string
    - name: metrics
      value:
        - - name: name
            value: string
          - name: function
            value: string
    - name: timeUnit
      value: string
    - name: name
      value: string
    - name: toTime
      value: string
    - name: sortByCols
      value:
        - string
    - name: properties
      value:
        - - name: value
            value:
              - - name: name
                  value: string
                - name: value
                  value: string
          - name: property
            value: string
    - name: offset
      value: string
    - name: createdAt
      value: string
    - name: tags
      value:
        - string
    - name: topk
      value: string
    - name: lastModifiedAt
      value: string
    - name: fromTime
      value: string
    - name: comments
      value:
        - string
    - name: limit
      value: string
    - name: lastViewedAt
      value: string

REPLACE example

Replaces all fields in the specified reports resource.

/*+ update */
REPLACE google.apigee.reports
SET 
dimensions = '{{ dimensions }}',
displayName = '{{ displayName }}',
sortOrder = '{{ sortOrder }}',
filter = '{{ filter }}',
chartType = '{{ chartType }}',
metrics = '{{ metrics }}',
timeUnit = '{{ timeUnit }}',
name = '{{ name }}',
toTime = '{{ toTime }}',
sortByCols = '{{ sortByCols }}',
properties = '{{ properties }}',
offset = '{{ offset }}',
tags = '{{ tags }}',
topk = '{{ topk }}',
fromTime = '{{ fromTime }}',
comments = '{{ comments }}',
limit = '{{ limit }}'
WHERE 
organizationsId = '{{ organizationsId }}'
AND reportsId = '{{ reportsId }}';

DELETE example

Deletes the specified reports resource.

/*+ delete */
DELETE FROM google.apigee.reports
WHERE organizationsId = '{{ organizationsId }}'
AND reportsId = '{{ reportsId }}';