AnalyticsRequest

analytics. AnalyticsRequest

new AnalyticsRequest(optionsnon-null)

Source:

Class for constructing a request object to use for communicating with the analytics API endpoint.

Parameters:
Name Type Description
options Object

Object with analytics request options

Extends

  • module:analytics.AnalyticsRequestDimensionsMixin
  • module:analytics.AnalyticsRequestFiltersMixin
  • module:analytics.AnalyticsRequestPropertiesMixin
  • module:analytics.AnalyticsRequestBase

Methods

fromModel(model, passFilterAsDimensionopt) → {AnalyticsRequest}

Source:

Extracts dimensions and filters from an analytic object model and add them to the request

Example
const req = new d2.analytics.request()
   .fromModel(model);

// dimension=pe:LAST_12_MONTH&dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU;Jtf34kNZhzP;hfdmMSPBgLG&filter=ou:ImspTQPwCqd

const req2 = new d2.analytics.request()
   .fromModel(model, true);

// dimension=pe:LAST_12_MONTH&dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU;Jtf34kNZhzP;hfdmMSPBgLG&dimension=ou:ImspTQPwCqd
Parameters:
Name Type Attributes Default Description
model Object

The analytics object model from which extract the dimensions/filters
passFilterAsDimension Boolean <optional>
 false

Pass filters as dimension in the query string (used in dataValueSet requests)
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest