analytics/AnalyticsEvents.js

  1. import AnalyticsBase from './AnalyticsBase'
  3. /**
  4.  * @extends module:analytics.AnalyticsBase
  5.  *
  6.  * @description
  7.  * Analytics events class used to request analytics events data from Web API.
  8.  *
  9.  * @memberof module:analytics
  10.  *
  11.  * @see https://docs.dhis2.org/master/en/developer/html/webapi_event_analytics.html
  12.  */
  13. class AnalyticsEvents extends AnalyticsBase {
  14.     /**
  15.      * @param {!AnalyticsRequest} req Request object
  16.      *
  17.      * @returns {Promise} Promise that resolves with the analytics aggregate data from the api.
  18.      *
  19.      * @example
  20.      * const req = new d2.analytics.request()
  21.      *  .withProgram('eBAyeGv0exc')
  22.      *  .addDataDimension(['Uvn6LCg7dVU','OdiHJayrsKo'])
  23.      *  .addPeriodDimension('LAST_4_QUARTERS')
  24.      *  .addOrgUnitDimension(['lc3eMKXaEfw','PMa2VCrupOd'])
  25.      *  .addOrgUnitFilter('O6uvpzGd5pu')
  26.      *  .withStartDate('2017-10-01')
  27.      *  .withEndDate('2017-10-31');
  28.      *
  29.      *  d2.analytics.events.getAggregate(req)
  30.      *  .then(console.log);
  31.      */
  32.     getAggregate(req) {
  33.         return this.fetch(req.withPath('events/aggregate'))
  34.     }
  36.     /**
  37.      * @param {!AnalyticsRequest} req Request object
  38.      *
  39.      * @returns {Promise} Promise that resolves with the analytics count data from the api.
  40.      *
  41.      * @example
  42.      * const req = new d2.analytics.request()
  43.      *  .withProgram('eBAyeGv0exc')
  44.      *  .addDataDimension(['Uvn6LCg7dVU','OdiHJayrsKo'])
  45.      *  .addPeriodDimension('LAST_4_QUARTERS')
  46.      *  .addOrgUnitDimension(['lc3eMKXaEfw','PMa2VCrupOd'])
  47.      *  .addOrgUnitFilter('O6uvpzGd5pu')
  48.      *  .withStartDate('2017-10-01')
  49.      *  .withEndDate('2017-10-31');
  50.      *
  51.      *  d2.analytics.events.getCount(req)
  52.      *  .then(console.log);
  53.      */
  54.     getCount(req) {
  55.         return this.fetch(req.withPath('events/count'))
  56.     }
  58.     /**
  59.      * @param {!AnalyticsRequest} req Request object
  60.      * Must contain clusterSize and bbox parameters.
  61.      *
  62.      * @returns {Promise} Promise that resolves with the analytics cluster data from the api.
  63.      *
  64.      * @example
  65.      * const req = new d2.analytics.request()
  66.      *  .withProgram('eBAyeGv0exc')
  67.      *  .addDataDimension(['Uvn6LCg7dVU','OdiHJayrsKo'])
  68.      *  .addPeriodDimension('LAST_4_QUARTERS')
  69.      *  .addOrgUnitDimension(['lc3eMKXaEfw','PMa2VCrupOd'])
  70.      *  .addOrgUnitFilter('O6uvpzGd5pu')
  71.      *  .withStartDate('2017-10-01')
  72.      *  .withEndDate('2017-10-31')
  73.      *  .withClusterSize(100000)
  74.      *  .withBbox('-13.2682125,7.3721619,-10.4261178,9.904012');
  75.      *
  76.      *  d2.analytics.events.getCluster(req)
  77.      *  .then(console.log);
  78.      */
  79.     getCluster(req) {
  80.         return this.fetch(req.withPath('events/cluster'))
  81.     }
  83.     /**
  84.      * @param {!AnalyticsRequest} req Request object
  85.      *
  86.      * @returns {Promise} Promise that resolves with the analytics query data from the api.
  87.      *
  88.      * @example
  89.      * const req = new d2.analytics.request()
  90.      *  .withProgram('eBAyeGv0exc')
  91.      *  .addDataDimension(['Uvn6LCg7dVU','OdiHJayrsKo'])
  92.      *  .addPeriodDimension('LAST_4_QUARTERS')
  93.      *  .addOrgUnitDimension(['lc3eMKXaEfw','PMa2VCrupOd'])
  94.      *  .addOrgUnitFilter('O6uvpzGd5pu')
  95.      *  .withStartDate('2017-10-01')
  96.      *  .withEndDate('2017-10-31');
  97.      *
  98.      *  d2.analytics.events.getQuery(req)
  99.      *  .then(console.log);
  100.      */
  101.     getQuery(req) {
  102.         return this.fetch(req.withPath('events/query'))
  103.     }
  104. }
  106. export default AnalyticsEvents