Class: Report

Methods

describe(callback) → {Promise.<Analytics~ReportMetadata>}

Describe report metadata

Parameters:

Name	Type	Argument	Description
callback	Callback.<Analytics~ReportMetadata>	<optional>	Callback function

Source:

• analytics.js, line 49

Returns:

Type

Promise.<Analytics~ReportMetadata>

execute(options, callback) → {Promise.<Analytics~ReportResult>}

Run report synchronously

Parameters:

Name	Type	Argument	Description
options	Object	<optional>	Options Properties Name Type Description details Boolean Flag if include detail in result metadata Analytics~ReportMetadata Overriding report metadata
callback	Callback.<Analytics~ReportResult>	<optional>	Callback function

Source:

• analytics.js, line 61

Returns:

Type

Promise.<Analytics~ReportResult>

executeAsync(options, callback) → {Promise.<Analytics~ReportInstanceAttrs>}

Run report asynchronously

Parameters:

Name	Type	Argument	Description
options	Object	<optional>	Options Properties Name Type Description details Boolean Flag if include detail in result metadata Analytics~ReportMetadata Overriding report metadata
callback	Callback.<Analytics~ReportInstanceAttrs>	<optional>	Callback function

Source:

• analytics.js, line 91

Returns:

Type

Promise.<Analytics~ReportInstanceAttrs>

instance(id) → {Analytics~ReportInstance}

Get report instance for specified instance ID

Parameters:

Name	Type	Description
id	String	Report instance ID

Source:

• analytics.js, line 119

Returns:

Type

Analytics~ReportInstance

instances(callback) → {Promise.<Array.<Analytics~ReportInstanceAttrs>>}

List report instances which had been executed asynchronously

Parameters:

Name	Type	Argument	Description
callback	Callback.<Array.<Analytics~ReportInstanceAttrs>>	<optional>	Callback function

Source:

• analytics.js, line 130

Returns:

Type

Promise.<Array.<Analytics~ReportInstanceAttrs>>