reports

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

Overview

Name	reports
Type	Resource
Id	google.apigee.reports

Fields

The following fields are returned by SELECT queries:

organizations_reports_get

Successful response

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 (int64)	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 (int64)	Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
lastViewedAt	string (int64)	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

organizations_reports_list

Successful response

Name	Datatype	Description
qualifier	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_reports_get	select	organizationsId, reportsId		Retrieve a custom report definition.
organizations_reports_list	select	organizationsId	expand	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_update	replace	organizationsId, reportsId		Update an existing custom report definition
organizations_reports_delete	delete	organizationsId, reportsId		Deletes an existing custom report definition

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
organizationsId	string
reportsId	string
expand	boolean

SELECT examples

organizations_reports_get

Retrieve a custom report definition.

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 }}' -- required
AND reportsId = '{{ reportsId }}' -- required;

organizations_reports_list

Return a list of Custom Reports

SELECT
qualifier
FROM google.apigee.reports
WHERE organizationsId = '{{ organizationsId }}' -- required
AND expand = '{{ expand }}';

INSERT examples

organizations_reports_create

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.

INSERT INTO google.apigee.reports (
data__name,
data__displayName,
data__metrics,
data__dimensions,
data__filter,
data__properties,
data__chartType,
data__timeUnit,
data__sortByCols,
data__sortOrder,
data__fromTime,
data__toTime,
data__offset,
data__limit,
data__topk,
data__tags,
data__comments,
organizationsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ metrics }}',
'{{ dimensions }}',
'{{ filter }}',
'{{ properties }}',
'{{ chartType }}',
'{{ timeUnit }}',
'{{ sortByCols }}',
'{{ sortOrder }}',
'{{ fromTime }}',
'{{ toTime }}',
'{{ offset }}',
'{{ limit }}',
'{{ topk }}',
'{{ tags }}',
'{{ comments }}',
'{{ organizationsId }}'
RETURNING
name,
chartType,
comments,
createdAt,
dimensions,
displayName,
environment,
filter,
fromTime,
lastModifiedAt,
lastViewedAt,
limit,
metrics,
offset,
organization,
properties,
sortByCols,
sortOrder,
tags,
timeUnit,
toTime,
topk
;

Manifest

# Description fields are for documentation purposes
- name: reports
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the reports resource.
    - name: name
      value: string
      description: >
        Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
        
    - name: displayName
      value: string
      description: >
        This is the display name for the report
        
    - name: metrics
      value: array
      description: >
        Required. This contains the list of metrics
        
    - name: dimensions
      value: array
      description: >
        This contains the list of dimensions for the report
        
    - name: filter
      value: string
      description: >
        This field contains the filter expression
        
    - name: properties
      value: array
      description: >
        This field contains report properties such as ui metadata etc.
        
    - name: chartType
      value: string
      description: >
        This field contains the chart type for the report
        
    - name: timeUnit
      value: string
      description: >
        This field contains the time unit of aggregation for the report
        
    - name: sortByCols
      value: array
      description: >
        Legacy field: not used much. Contains the list of sort by columns
        
    - name: sortOrder
      value: string
      description: >
        Legacy field: not used much. Contains the sort order for the sort columns
        
    - name: fromTime
      value: string
      description: >
        Legacy field: not used. Contains the from time for the report
        
    - name: toTime
      value: string
      description: >
        Legacy field: not used. Contains the end time for the report
        
    - name: offset
      value: string
      description: >
        Legacy field: not used. This field contains the offset for the data
        
    - name: limit
      value: string
      description: >
        Legacy field: not used This field contains the limit for the result retrieved
        
    - name: topk
      value: string
      description: >
        Legacy field: not used. This field contains the top k parameter value for restricting the result
        
    - name: tags
      value: array
      description: >
        Legacy field: not used. This field contains a list of tags associated with custom report
        
    - name: comments
      value: array
      description: >
        Legacy field: not used. This field contains a list of comments associated with custom report
        

REPLACE examples

organizations_reports_update

Update an existing custom report definition

REPLACE google.apigee.reports
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__metrics = '{{ metrics }}',
data__dimensions = '{{ dimensions }}',
data__filter = '{{ filter }}',
data__properties = '{{ properties }}',
data__chartType = '{{ chartType }}',
data__timeUnit = '{{ timeUnit }}',
data__sortByCols = '{{ sortByCols }}',
data__sortOrder = '{{ sortOrder }}',
data__fromTime = '{{ fromTime }}',
data__toTime = '{{ toTime }}',
data__offset = '{{ offset }}',
data__limit = '{{ limit }}',
data__topk = '{{ topk }}',
data__tags = '{{ tags }}',
data__comments = '{{ comments }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND reportsId = '{{ reportsId }}' --required
RETURNING
name,
chartType,
comments,
createdAt,
dimensions,
displayName,
environment,
filter,
fromTime,
lastModifiedAt,
lastViewedAt,
limit,
metrics,
offset,
organization,
properties,
sortByCols,
sortOrder,
tags,
timeUnit,
toTime,
topk;

DELETE examples

organizations_reports_delete

Deletes an existing custom report definition

DELETE FROM google.apigee.reports
WHERE organizationsId = '{{ organizationsId }}' --required
AND reportsId = '{{ reportsId }}' --required;