# Apigee API . organizations . reports

## Instance Methods

Creates a Custom Report for an Organization. A Custom Report

Deletes an existing custom report definition

Retrieve a custom report definition.

Return a list of Custom Reports

Update an existing custom report definition

### Method Details

`create(parent, body=None, x__xgafv=None)`

    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.

    Args:
      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)
      body: object, The request body.
        The object takes the form of:

    {
      "chartType": "A String", # This field contains the chart type for the report
      "fromTime": "A String", # Legacy field: not used. Contains the from time for the report
      "createdAt": "A String", # Output only. Unix time when the app was created
          # json key: createdAt
      "name": "A String", # Required. Unique identifier for the report
          # T his is a legacy field used to encode custom report unique id
      "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch.
          # json key: lastModifiedAt
      "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
      "limit": "A String", # Legacy field: not used This field contains the limit for the result
          # retrieved
      "comments": [ # Legacy field: not used. This field contains a list of comments associated
          # with custom report
        "A String",
      ],
      "organization": "A String", # Output only. Organization name
      "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
        "A String",
      ],
      "environment": "A String", # Output only. Environment name
      "properties": [ # This field contains report properties such as ui metadata etc.
        {
          "property": "A String", # name of the property
          "value": [ # property values
            { # Key-value pair to store extra metadata.
              "value": "A String", # Value of the attribute.
              "name": "A String", # API key of the attribute.
            },
          ],
        },
      ],
      "toTime": "A String", # Legacy field: not used. Contains the end time for the report
      "metrics": [ # Required. This contains the list of metrics
        { # This encapsulates a metric property of the form sum(message_count)
            # where name is message_count and function is sum
          "function": "A String", # aggregate function
          "name": "A String", # name of the metric
        },
      ],
      "offset": "A String", # Legacy field: not used. This field contains the offset for the data
      "topk": "A String", # Legacy field: not used. This field contains the top k parameter value
          # for restricting the result
      "timeUnit": "A String", # This field contains the time unit of aggregation for the report
      "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
      "displayName": "A String", # This is the display name for the report
      "tags": [ # Legacy field: not used. This field contains a list of tags associated with
          # custom report
        "A String",
      ],
      "filter": "A String", # This field contains the filter expression
      "dimensions": [ # This contains the list of dimensions for the report
        "A String",
      ],
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
        "chartType": "A String", # This field contains the chart type for the report
        "fromTime": "A String", # Legacy field: not used. Contains the from time for the report
        "createdAt": "A String", # Output only. Unix time when the app was created
            # json key: createdAt
        "name": "A String", # Required. Unique identifier for the report
            # T his is a legacy field used to encode custom report unique id
        "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch.
            # json key: lastModifiedAt
        "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
        "limit": "A String", # Legacy field: not used This field contains the limit for the result
            # retrieved
        "comments": [ # Legacy field: not used. This field contains a list of comments associated
            # with custom report
          "A String",
        ],
        "organization": "A String", # Output only. Organization name
        "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
          "A String",
        ],
        "environment": "A String", # Output only. Environment name
        "properties": [ # This field contains report properties such as ui metadata etc.
          {
            "property": "A String", # name of the property
            "value": [ # property values
              { # Key-value pair to store extra metadata.
                "value": "A String", # Value of the attribute.
                "name": "A String", # API key of the attribute.
              },
            ],
          },
        ],
        "toTime": "A String", # Legacy field: not used. Contains the end time for the report
        "metrics": [ # Required. This contains the list of metrics
          { # This encapsulates a metric property of the form sum(message_count)
              # where name is message_count and function is sum
            "function": "A String", # aggregate function
            "name": "A String", # name of the metric
          },
        ],
        "offset": "A String", # Legacy field: not used. This field contains the offset for the data
        "topk": "A String", # Legacy field: not used. This field contains the top k parameter value
            # for restricting the result
        "timeUnit": "A String", # This field contains the time unit of aggregation for the report
        "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
        "displayName": "A String", # This is the display name for the report
        "tags": [ # Legacy field: not used. This field contains a list of tags associated with
            # custom report
          "A String",
        ],
        "filter": "A String", # This field contains the filter expression
        "dimensions": [ # This contains the list of dimensions for the report
          "A String",
        ],
      }

`delete(name, x__xgafv=None)`

    Deletes an existing custom report definition

    Args:
      name: string, Required. Custom Report name of the form:
      `organizations/{organization_id}/reports/{report_name}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
        "message": "A String", # The response contains only a message field.
      }

`get(name, x__xgafv=None)`

    Retrieve a custom report definition.

    Args:
      name: string, Required. Custom Report name of the form:
      `organizations/{organization_id}/reports/{report_name}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
        "chartType": "A String", # This field contains the chart type for the report
        "fromTime": "A String", # Legacy field: not used. Contains the from time for the report
        "createdAt": "A String", # Output only. Unix time when the app was created
            # json key: createdAt
        "name": "A String", # Required. Unique identifier for the report
            # T his is a legacy field used to encode custom report unique id
        "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch.
            # json key: lastModifiedAt
        "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
        "limit": "A String", # Legacy field: not used This field contains the limit for the result
            # retrieved
        "comments": [ # Legacy field: not used. This field contains a list of comments associated
            # with custom report
          "A String",
        ],
        "organization": "A String", # Output only. Organization name
        "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
          "A String",
        ],
        "environment": "A String", # Output only. Environment name
        "properties": [ # This field contains report properties such as ui metadata etc.
          {
            "property": "A String", # name of the property
            "value": [ # property values
              { # Key-value pair to store extra metadata.
                "value": "A String", # Value of the attribute.
                "name": "A String", # API key of the attribute.
              },
            ],
          },
        ],
        "toTime": "A String", # Legacy field: not used. Contains the end time for the report
        "metrics": [ # Required. This contains the list of metrics
          { # This encapsulates a metric property of the form sum(message_count)
              # where name is message_count and function is sum
            "function": "A String", # aggregate function
            "name": "A String", # name of the metric
          },
        ],
        "offset": "A String", # Legacy field: not used. This field contains the offset for the data
        "topk": "A String", # Legacy field: not used. This field contains the top k parameter value
            # for restricting the result
        "timeUnit": "A String", # This field contains the time unit of aggregation for the report
        "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
        "displayName": "A String", # This is the display name for the report
        "tags": [ # Legacy field: not used. This field contains a list of tags associated with
            # custom report
          "A String",
        ],
        "filter": "A String", # This field contains the filter expression
        "dimensions": [ # This contains the list of dimensions for the report
          "A String",
        ],
      }

`list(parent, expand=None, x__xgafv=None)`

    Return a list of Custom Reports

    Args:
      parent: string, Required. The parent organization name under which the API product will
    be listed
      `organizations/{organization_id}/reports` (required)
      expand: boolean, Set to 'true' to get expanded details about each custom report.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This message encapsulates a list of custom report definitions
        "qualifier": [
          {
            "chartType": "A String", # This field contains the chart type for the report
            "fromTime": "A String", # Legacy field: not used. Contains the from time for the report
            "createdAt": "A String", # Output only. Unix time when the app was created
                # json key: createdAt
            "name": "A String", # Required. Unique identifier for the report
                # T his is a legacy field used to encode custom report unique id
            "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch.
                # json key: lastModifiedAt
            "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
            "limit": "A String", # Legacy field: not used This field contains the limit for the result
                # retrieved
            "comments": [ # Legacy field: not used. This field contains a list of comments associated
                # with custom report
              "A String",
            ],
            "organization": "A String", # Output only. Organization name
            "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
              "A String",
            ],
            "environment": "A String", # Output only. Environment name
            "properties": [ # This field contains report properties such as ui metadata etc.
              {
                "property": "A String", # name of the property
                "value": [ # property values
                  { # Key-value pair to store extra metadata.
                    "value": "A String", # Value of the attribute.
                    "name": "A String", # API key of the attribute.
                  },
                ],
              },
            ],
            "toTime": "A String", # Legacy field: not used. Contains the end time for the report
            "metrics": [ # Required. This contains the list of metrics
              { # This encapsulates a metric property of the form sum(message_count)
                  # where name is message_count and function is sum
                "function": "A String", # aggregate function
                "name": "A String", # name of the metric
              },
            ],
            "offset": "A String", # Legacy field: not used. This field contains the offset for the data
            "topk": "A String", # Legacy field: not used. This field contains the top k parameter value
                # for restricting the result
            "timeUnit": "A String", # This field contains the time unit of aggregation for the report
            "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
            "displayName": "A String", # This is the display name for the report
            "tags": [ # Legacy field: not used. This field contains a list of tags associated with
                # custom report
              "A String",
            ],
            "filter": "A String", # This field contains the filter expression
            "dimensions": [ # This contains the list of dimensions for the report
              "A String",
            ],
          },
        ],
      }

`update(name, body=None, x__xgafv=None)`

    Update an existing custom report definition

    Args:
      name: string, Required. Custom Report name of the form:
      `organizations/{organization_id}/reports/{report_name}` (required)
      body: object, The request body.
        The object takes the form of:

    {
      "chartType": "A String", # This field contains the chart type for the report
      "fromTime": "A String", # Legacy field: not used. Contains the from time for the report
      "createdAt": "A String", # Output only. Unix time when the app was created
          # json key: createdAt
      "name": "A String", # Required. Unique identifier for the report
          # T his is a legacy field used to encode custom report unique id
      "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch.
          # json key: lastModifiedAt
      "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
      "limit": "A String", # Legacy field: not used This field contains the limit for the result
          # retrieved
      "comments": [ # Legacy field: not used. This field contains a list of comments associated
          # with custom report
        "A String",
      ],
      "organization": "A String", # Output only. Organization name
      "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
        "A String",
      ],
      "environment": "A String", # Output only. Environment name
      "properties": [ # This field contains report properties such as ui metadata etc.
        {
          "property": "A String", # name of the property
          "value": [ # property values
            { # Key-value pair to store extra metadata.
              "value": "A String", # Value of the attribute.
              "name": "A String", # API key of the attribute.
            },
          ],
        },
      ],
      "toTime": "A String", # Legacy field: not used. Contains the end time for the report
      "metrics": [ # Required. This contains the list of metrics
        { # This encapsulates a metric property of the form sum(message_count)
            # where name is message_count and function is sum
          "function": "A String", # aggregate function
          "name": "A String", # name of the metric
        },
      ],
      "offset": "A String", # Legacy field: not used. This field contains the offset for the data
      "topk": "A String", # Legacy field: not used. This field contains the top k parameter value
          # for restricting the result
      "timeUnit": "A String", # This field contains the time unit of aggregation for the report
      "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
      "displayName": "A String", # This is the display name for the report
      "tags": [ # Legacy field: not used. This field contains a list of tags associated with
          # custom report
        "A String",
      ],
      "filter": "A String", # This field contains the filter expression
      "dimensions": [ # This contains the list of dimensions for the report
        "A String",
      ],
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
        "chartType": "A String", # This field contains the chart type for the report
        "fromTime": "A String", # Legacy field: not used. Contains the from time for the report
        "createdAt": "A String", # Output only. Unix time when the app was created
            # json key: createdAt
        "name": "A String", # Required. Unique identifier for the report
            # T his is a legacy field used to encode custom report unique id
        "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch.
            # json key: lastModifiedAt
        "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
        "limit": "A String", # Legacy field: not used This field contains the limit for the result
            # retrieved
        "comments": [ # Legacy field: not used. This field contains a list of comments associated
            # with custom report
          "A String",
        ],
        "organization": "A String", # Output only. Organization name
        "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
          "A String",
        ],
        "environment": "A String", # Output only. Environment name
        "properties": [ # This field contains report properties such as ui metadata etc.
          {
            "property": "A String", # name of the property
            "value": [ # property values
              { # Key-value pair to store extra metadata.
                "value": "A String", # Value of the attribute.
                "name": "A String", # API key of the attribute.
              },
            ],
          },
        ],
        "toTime": "A String", # Legacy field: not used. Contains the end time for the report
        "metrics": [ # Required. This contains the list of metrics
          { # This encapsulates a metric property of the form sum(message_count)
              # where name is message_count and function is sum
            "function": "A String", # aggregate function
            "name": "A String", # name of the metric
          },
        ],
        "offset": "A String", # Legacy field: not used. This field contains the offset for the data
        "topk": "A String", # Legacy field: not used. This field contains the top k parameter value
            # for restricting the result
        "timeUnit": "A String", # This field contains the time unit of aggregation for the report
        "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
        "displayName": "A String", # This is the display name for the report
        "tags": [ # Legacy field: not used. This field contains a list of tags associated with
            # custom report
          "A String",
        ],
        "filter": "A String", # This field contains the filter expression
        "dimensions": [ # This contains the list of dimensions for the report
          "A String",
        ],
      }