runReport

Back to index

Summary

Retrieves data for the requested report from the reporting system.

projectName

Stringrequired

The name for the project that must be unique among all projects.

reportName

Stringrequired

The name of the report.

actualParameters

Array<ActualParameter>optional

Parameters passed as arguments to the report.

dashboardName

Stringoptional

The name of the dashboard that the widget using the report belongs to.

dashboardProjectName

Stringoptional

Set if the dashboard is in a different project than the report.

definition

Stringoptional

The Elasticsearch query definition to use for retrieving report data.

filters

Array<Filter>optional

A list of zero or more filter criteria definitions used to define objects to find.

previewMode

Booleanoptional

Whether the report should be run in preview mode returning a small result sample.

reportObjectTypeName

Stringoptional

Report object type name.

reportQuery

Stringoptional

The report query in JSON format. It will be translated to the Elasticsearch query definition when retrieving report data.

uri

Stringoptional

An advanced mode option for identifying the Elasticsearch URI to use for retrieving report data. By default, the reportObjectTypeName argument will be used to construct the URI based on the Elasticsearch index for the report object, e.g., ef-deployment-*/_search?pretty.

widgetName

Stringoptional

The name of the widget using the report.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.runReport(
  projectName: "test-projectName",
  reportName: "test-reportName"
  /* optional arguments */
)▼