Analytics - Documentation

Analytics

analytics. Analytics

new Analytics(analyticsAggregatenon-null, analyticsEventsnon-null, analyticsRequestnon-null, analyticsResponsenon-null)

Source:

analytics/Analytics.js, line 30

See:

https://docs.dhis2.org/master/en/developer/html/webapi_analytics.html Analytics API documentation
https://docs.dhis2.org/master/en/developer/html/webapi_event_analytics.html Event analytics API documentation

Analytics class used to request analytics data from Web API.

Example

const d2Analytics = new Analytics(
 new AnalyticsAggregate(),
 new AnalyticsEvents(),
 AnalyticsRequest,
 AnalyticsResponse
)

Parameters:

Name	Type	Description
`analyticsAggregate`	module:analytics.AnalyticsAggregate	The AnalyticsAggregate instance
`analyticsEvents`	module:analytics.AnalyticsEvents	The AnalyticsEvents instance
`analyticsRequest`	module:analytics.AnalyticsRequest	The AnalyticsRequest class
`analyticsResponse`	module:analytics.AnalyticsResponse	The AnalyticsResponse class

Requires:

Requires

Methods

(static) getAnalytics() → {Analytics}

Source:

analytics/Analytics.js, line 61

Get a new instance of the Analytics object. This will function as a singleton, once Analytics object has been created when requesting getAnalytics again the original version will be returned.

Example

const d2Analytics = d2.getAnalytics();

Returns:

Object with the analytics interaction properties

Type: Analytics