Class: Report

Analytics~Report

(protected) new Report(conn)

Report object in Analytics API
Parameters:
Name Type Description
conn Connection Connection
Source:

Methods

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

Describe report metadata
Parameters:
Name Type Attributes Description
callback Callback.<Analytics~ReportMetadata> <optional>
 Callback function
Source:
Returns:
Type
Promise.<Analytics~ReportMetadata>

execute(optionsopt, callbackopt) → {Promise.<Analytics~ReportResult>}

Run report synchronously
Parameters:
Name Type Attributes 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:
Returns:
Type
Promise.<Analytics~ReportResult>

executeAsync(optionsopt, callbackopt) → {Promise.<Analytics~ReportInstanceAttrs>}

Run report asynchronously
Parameters:
Name Type Attributes 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:
Returns:
Type
Promise.<Analytics~ReportInstanceAttrs>

explain(callbackopt) → {Promise.<ExplainInfo>}

Explain plan for executing report
Parameters:
Name Type Attributes Description
callback Callback.<ExplainInfo> <optional>
 Callback function
Source:
Returns:
Type
Promise.<ExplainInfo>

instance(id) → {Analytics~ReportInstance}

Get report instance for specified instance ID
Parameters:
Name Type Description
id String Report instance ID
Source:
Returns:
Type
Analytics~ReportInstance

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

List report instances which had been executed asynchronously
Parameters:
Name Type Attributes Description
callback Callback.<Array.<Analytics~ReportInstanceAttrs>> <optional>
 Callback function
Source:
Returns:
Type
Promise.<Array.<Analytics~ReportInstanceAttrs>>