d2
Version:
Javascript library for DHIS2
10,854 lines • 151 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Global - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GeoFeatures.html">GeoFeatures</a></li><li></li><li><a href="module-analytics.Analytics.html">Analytics</a><ul class='methods'><li data-type='method'><a href="module-analytics.Analytics.html#.getAnalytics">getAnalytics</a></li></ul></li><li><a href="module-analytics.AnalyticsAggregate.html">AnalyticsAggregate</a><ul class='methods'><li data-type='method'><a href="module-analytics.AnalyticsAggregate.html#get">get</a></li><li data-type='method'><a href="module-analytics.AnalyticsAggregate.html#getDataValueSet">getDataValueSet</a></li><li data-type='method'><a href="module-analytics.AnalyticsAggregate.html#getDebugSql">getDebugSql</a></li><li data-type='method'><a href="module-analytics.AnalyticsAggregate.html#getRawData">getRawData</a></li></ul></li><li><a href="module-analytics.AnalyticsEvents.html">AnalyticsEvents</a><ul class='methods'><li data-type='method'><a href="module-analytics.AnalyticsEvents.html#get">get</a></li><li data-type='method'><a href="module-analytics.AnalyticsEvents.html#getAggregate">getAggregate</a></li><li data-type='method'><a href="module-analytics.AnalyticsEvents.html#getCluster">getCluster</a></li><li data-type='method'><a href="module-analytics.AnalyticsEvents.html#getCount">getCount</a></li><li data-type='method'><a href="module-analytics.AnalyticsEvents.html#getQuery">getQuery</a></li></ul></li><li><a href="module-analytics.AnalyticsRequest.html">AnalyticsRequest</a><ul class='methods'><li data-type='method'><a href="module-analytics.AnalyticsRequest.html#fromModel">fromModel</a></li></ul></li><li><a href="module-api.Api.html">Api</a><ul class='methods'><li data-type='method'><a href="module-api.Api.html#get">get</a></li><li data-type='method'><a href="module-api.Api.html#patch">patch</a></li><li data-type='method'><a href="module-api.Api.html#post">post</a></li><li data-type='method'><a href="module-api.Api.html#setBaseUrl">setBaseUrl</a></li><li data-type='method'><a href="module-api.Api.html#setDefaultHeaders">setDefaultHeaders</a></li><li data-type='method'><a href="module-api.Api.html#setUnauthorizedCallback">setUnauthorizedCallback</a></li><li data-type='method'><a href="module-api.Api.html#update">update</a></li></ul></li><li><a href="module-current-user.CurrentUser.html">CurrentUser</a><ul class='methods'><li data-type='method'><a href="module-current-user.CurrentUser.html#.create">create</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#canCreate">canCreate</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#canCreatePrivate">canCreatePrivate</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#canCreatePublic">canCreatePublic</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#canDelete">canDelete</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#canUpdate">canUpdate</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#getDataViewOrganisationUnits">getDataViewOrganisationUnits</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#getOrganisationUnits">getOrganisationUnits</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#getUserGroupIds">getUserGroupIds</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#getUserGroups">getUserGroups</a></li><li data-type='method'><a href="module-current-user.CurrentUser.html#getUserRoles">getUserRoles</a></li></ul></li><li><a href="module-current-user.UserAuthorities.html">UserAuthorities</a><ul class='methods'><li data-type='method'><a href="module-current-user.UserAuthorities.html#.create">create</a></li><li data-type='method'><a href="module-current-user.UserAuthorities.html#has">has</a></li></ul></li><li><a href="module-current-user.UserDataStore.html">UserDataStore</a><ul class='methods'><li data-type='method'><a href="module-current-user.UserDataStore.html#.getUserDataStore">getUserDataStore</a></li><li data-type='method'><a href="module-current-user.UserDataStore.html#create">create</a></li><li data-type='method'><a href="module-current-user.UserDataStore.html#delete">delete</a></li><li data-type='method'><a href="module-current-user.UserDataStore.html#get">get</a></li><li data-type='method'><a href="module-current-user.UserDataStore.html#getAll">getAll</a></li><li data-type='method'><a href="module-current-user.UserDataStore.html#has">has</a></li></ul></li><li><a href="module-current-user.UserDataStoreNamespace.html">UserDataStoreNamespace</a><ul class='methods'><li data-type='method'><a href="module-current-user.UserDataStoreNamespace.html#delete">delete</a></li><li data-type='method'><a href="module-current-user.UserDataStoreNamespace.html#get">get</a></li><li data-type='method'><a href="module-current-user.UserDataStoreNamespace.html#getKeys">getKeys</a></li><li data-type='method'><a href="module-current-user.UserDataStoreNamespace.html#set">set</a></li><li data-type='method'><a href="module-current-user.UserDataStoreNamespace.html#update">update</a></li></ul></li><li><a href="module-current-user.UserSettings.html">UserSettings</a><ul class='methods'><li data-type='method'><a href="module-current-user.UserSettings.html#all">all</a></li><li data-type='method'><a href="module-current-user.UserSettings.html#get">get</a></li><li data-type='method'><a href="module-current-user.UserSettings.html#set">set</a></li></ul></li><li><a href="module-datastore.DataStore.html">DataStore</a><ul class='methods'><li data-type='method'><a href="module-datastore.DataStore.html#.getDataStore">getDataStore</a></li><li data-type='method'><a href="module-datastore.DataStore.html#create">create</a></li><li data-type='method'><a href="module-datastore.DataStore.html#delete">delete</a></li><li data-type='method'><a href="module-datastore.DataStore.html#get">get</a></li><li data-type='method'><a href="module-datastore.DataStore.html#getAll">getAll</a></li><li data-type='method'><a href="module-datastore.DataStore.html#has">has</a></li></ul></li><li><a href="module-datastore.DataStoreNamespace.html">DataStoreNamespace</a><ul class='methods'><li data-type='method'><a href="module-datastore.DataStoreNamespace.html#delete">delete</a></li><li data-type='method'><a href="module-datastore.DataStoreNamespace.html#get">get</a></li><li data-type='method'><a href="module-datastore.DataStoreNamespace.html#getKeys">getKeys</a></li><li data-type='method'><a href="module-datastore.DataStoreNamespace.html#getMetaData">getMetaData</a></li><li data-type='method'><a href="module-datastore.DataStoreNamespace.html#set">set</a></li><li data-type='method'><a href="module-datastore.DataStoreNamespace.html#update">update</a></li></ul></li><li><a href="module-i18n-I18n.html">I18n</a><ul class='methods'><li data-type='method'><a href="module-i18n-I18n.html#.getI18n">getI18n</a></li><li data-type='method'><a href="module-i18n-I18n.html#addSource">addSource</a></li><li data-type='method'><a href="module-i18n-I18n.html#addStrings">addStrings</a></li><li data-type='method'><a href="module-i18n-I18n.html#getTranslation">getTranslation</a></li><li data-type='method'><a href="module-i18n-I18n.html#getUntranslatedStrings">getUntranslatedStrings</a></li><li data-type='method'><a href="module-i18n-I18n.html#isTranslated">isTranslated</a></li><li data-type='method'><a href="module-i18n-I18n.html#load">load</a></li></ul></li><li><a href="module-model.Filter.html">Filter</a><ul class='methods'><li data-type='method'><a href="module-model.Filter.html#.getFilter">getFilter</a></li><li data-type='method'><a href="module-model.Filter.html#equals">equals</a></li><li data-type='method'><a href="module-model.Filter.html#ilike">ilike</a></li><li data-type='method'><a href="module-model.Filter.html#in">in</a></li><li data-type='method'><a href="module-model.Filter.html#like">like</a></li><li data-type='method'><a href="module-model.Filter.html#notEqual">notEqual</a></li><li data-type='method'><a href="module-model.Filter.html#notIn">notIn</a></li><li data-type='method'><a href="module-model.Filter.html#nToken">nToken</a></li><li data-type='method'><a href="module-model.Filter.html#on">on</a></li><li data-type='method'><a href="module-model.Filter.html#operator">operator</a></li><li data-type='method'><a href="module-model.Filter.html#token">token</a></li></ul></li><li><a href="module-model.Filters.html">Filters</a><ul class='methods'><li data-type='method'><a href="module-model.Filters.html#.getFilters">getFilters</a></li><li data-type='method'><a href="module-model.Filters.html#getFilterList">getFilterList</a></li><li data-type='method'><a href="module-model.Filters.html#getFilters">getFilters</a></li><li data-type='method'><a href="module-model.Filters.html#getQueryFilterValues">getQueryFilterValues</a></li><li data-type='method'><a href="module-model.Filters.html#list">list</a></li><li data-type='method'><a href="module-model.Filters.html#logicMode">logicMode</a></li><li data-type='method'><a href="module-model.Filters.html#on">on</a></li></ul></li><li><a href="module-model.Model.html">Model</a><ul class='methods'><li data-type='method'><a href="module-model.Model.html#.create">create</a></li></ul></li><li><a href="module-model.ModelBase.html">ModelBase</a><ul class='methods'><li data-type='method'><a href="module-model.ModelBase.html#create">create</a></li><li data-type='method'><a href="module-model.ModelBase.html#delete">delete</a></li><li data-type='method'><a href="module-model.ModelBase.html#getCollectionChildren">getCollectionChildren</a></li><li data-type='method'><a href="module-model.ModelBase.html#getCollectionChildrenPropertyNames">getCollectionChildrenPropertyNames</a></li><li data-type='method'><a href="module-model.ModelBase.html#getDirtyChildren">getDirtyChildren</a></li><li data-type='method'><a href="module-model.ModelBase.html#getDirtyPropertyNames">getDirtyPropertyNames</a></li><li data-type='method'><a href="module-model.ModelBase.html#getEmbeddedObjectCollectionPropertyNames">getEmbeddedObjectCollectionPropertyNames</a></li><li data-type='method'><a href="module-model.ModelBase.html#getReferenceProperties">getReferenceProperties</a></li><li data-type='method'><a href="module-model.ModelBase.html#hasDirtyChildren">hasDirtyChildren</a></li><li data-type='method'><a href="module-model.ModelBase.html#isDirty">isDirty</a></li><li data-type='method'><a href="module-model.ModelBase.html#resetDirtyState">resetDirtyState</a></li><li data-type='method'><a href="module-model.ModelBase.html#save">save</a></li><li data-type='method'><a href="module-model.ModelBase.html#toJSON">toJSON</a></li><li data-type='method'><a href="module-model.ModelBase.html#validate">validate</a></li></ul></li><li><a href="module-model.ModelCollection.html">ModelCollection</a><ul class='methods'><li data-type='method'><a href="module-model.ModelCollection.html#add">add</a></li><li data-type='method'><a href="module-model.ModelCollection.html#clear">clear</a></li><li data-type='method'><a href="module-model.ModelCollection.html#toArray">toArray</a></li></ul></li><li><a href="module-model.ModelCollectionProperty.html">ModelCollectionProperty</a><ul class='methods'><li data-type='method'><a href="module-model.ModelCollectionProperty.html#.create">create</a></li><li data-type='method'><a href="module-model.ModelCollectionProperty.html#add">add</a></li><li data-type='method'><a href="module-model.ModelCollectionProperty.html#isDirty">isDirty</a></li><li data-type='method'><a href="module-model.ModelCollectionProperty.html#remove">remove</a></li><li data-type='method'><a href="module-model.ModelCollectionProperty.html#resetDirtyState">resetDirtyState</a></li><li data-type='method'><a href="module-model.ModelCollectionProperty.html#save">save</a></li><li data-type='method'><a href="module-model.ModelCollectionProperty.html#updateDirty">updateDirty</a></li></ul></li><li><a href="module-model.ModelDefinition.html">ModelDefinition</a><ul class='methods'><li data-type='method'><a href="module-model.ModelDefinition.html#.createFromSchema">createFromSchema</a></li><li data-type='method'><a href="module-model.ModelDefinition.html#create">create</a></li><li data-type='method'><a href="module-model.ModelDefinition.html#delete">delete</a></li><li data-type='method'><a href="module-model.ModelDefinition.html#get">get</a></li><li data-type='method'><a href="module-model.ModelDefinition.html#getOwnedPropertyNames">getOwnedPropertyNames</a></li><li data-type='method'><a href="module-model.ModelDefinition.html#getTranslatableProperties">getTranslatableProperties</a></li><li data-type='method'><a href="module-model.ModelDefinition.html#getTranslatablePropertiesWithKeys">getTranslatablePropertiesWithKeys</a></li><li data-type='method'><a href="module-model.ModelDefinition.html#isTranslatable">isTranslatable</a></li><li data-type='method'><a href="module-model.ModelDefinition.html#list">list</a></li><li data-type='method'><a href="module-model.ModelDefinition.html#save">save</a></li></ul></li><li><a href="module-model.ModelDefinitions.html">ModelDefinitions</a><ul class='methods'><li data-type='method'><a href="module-model.ModelDefinitions.html#add">add</a></li><li data-type='method'><a href="module-model.ModelDefinitions.html#mapThroughDefinitions">mapThroughDefinitions</a></li></ul></li><li><a href="module-model.ModelValidation.html">ModelValidation</a><ul class='methods'><li data-type='method'><a href="module-model.ModelValidation.html#.getModelValidation">getModelValidation</a></li><li data-type='method'><a href="module-model.ModelValidation.html#validate">validate</a></li><li data-type='method'><a href="module-model.ModelValidation.html#validateAgainstSchema">validateAgainstSchema</a></li></ul></li><li><a href="module-model.Pager.html">Pager</a><ul class='methods'><li data-type='method'><a href="module-model.Pager.html#getNextPage">getNextPage</a></li><li data-type='method'><a href="module-model.Pager.html#getPreviousPage">getPreviousPage</a></li><li data-type='method'><a href="module-model.Pager.html#goToPage">goToPage</a></li><li data-type='method'><a href="module-model.Pager.html#hasNextPage">hasNextPage</a></li><li data-type='method'><a href="module-model.Pager.html#hasPreviousPage">hasPreviousPage</a></li></ul></li><li><a href="module-system.System.html">System</a><ul class='methods'><li data-type='method'><a href="module-system.System.html#.compareVersions">compareVersions</a></li><li data-type='method'><a href="module-system.System.html#.getSystem">getSystem</a></li><li data-type='method'><a href="module-system.System.html#.isVersionCompatible">isVersionCompatible</a></li><li data-type='method'><a href="module-system.System.html#.parseVersionString">parseVersionString</a></li><li data-type='method'><a href="module-system.System.html#installAppVersion">installAppVersion</a></li><li data-type='method'><a href="module-system.System.html#loadAppStore">loadAppStore</a></li><li data-type='method'><a href="module-system.System.html#loadInstalledApps">loadInstalledApps</a></li><li data-type='method'><a href="module-system.System.html#reloadApps">reloadApps</a></li><li data-type='method'><a href="module-system.System.html#setInstalledApps">setInstalledApps</a></li><li data-type='method'><a href="module-system.System.html#setSystemInfo">setSystemInfo</a></li><li data-type='method'><a href="module-system.System.html#uninstallApp">uninstallApp</a></li><li data-type='method'><a href="module-system.System.html#uploadApp">uploadApp</a></li></ul></li><li><a href="module-system.SystemConfiguration.html">SystemConfiguration</a><ul class='methods'><li data-type='method'><a href="module-system.SystemConfiguration.html#all">all</a></li><li data-type='method'><a href="module-system.SystemConfiguration.html#get">get</a></li></ul></li><li><a href="module-system.SystemSettings.html">SystemSettings</a><ul class='methods'><li data-type='method'><a href="module-system.SystemSettings.html#all">all</a></li><li data-type='method'><a href="module-system.SystemSettings.html#get">get</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-analytics.html">analytics</a></li><li><a href="module-api.html">api</a></li><li><a href="module-current-user.html">current-user</a></li><li><a href="module-d2.html">d2</a><ul class='members'><li data-type='member'><a href="module-d2.html#.config">config</a></li></ul><ul class='methods'><li data-type='method'><a href="module-d2.html#.getInstance">getInstance</a></li><li data-type='method'><a href="module-d2.html#.getManifest">getManifest</a></li><li data-type='method'><a href="module-d2.html#.init">init</a></li><li data-type='method'><a href="module-d2.html#~getUserSettings">getUserSettings</a></li></ul></li><li><a href="module-datastore.html">datastore</a></li><li><a href="module-i18n.html">i18n</a></li><li><a href="module-lib_check.html">lib/check</a><ul class='methods'><li data-type='method'><a href="module-lib_check.html#.checkDefined">checkDefined</a></li><li data-type='method'><a href="module-lib_check.html#.isValidUid">isValidUid</a></li></ul></li><li><a href="module-lib_utils.html">lib/utils</a><ul class='methods'><li data-type='method'><a href="module-lib_utils.html#.customEncodeURIComponent">customEncodeURIComponent</a></li><li data-type='method'><a href="module-lib_utils.html#.pick">pick</a></li></ul></li><li><a href="module-model.html">model</a></li><li><a href="module-period_generators.html">period/generators</a><ul class='methods'><li data-type='method'><a href="module-period_generators.html#.createPeriodGeneratorsForLocale">createPeriodGeneratorsForLocale</a></li></ul></li><li><a href="module-system.html">system</a></li><li><a href="module-uid.html">uid</a><ul class='methods'><li data-type='method'><a href="module-uid.html#.generateUid">generateUid</a></li><li data-type='method'><a href="module-uid.html#.isValidUid">isValidUid</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="module-d2.init-d2.html">d2</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-FAQ.html">FAQ</a></li><li><a href="tutorial-overview.html">overview</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addDataDimension">addDataDimension</a></li><li><a href="global.html#addDataFilter">addDataFilter</a></li><li><a href="global.html#addDimension">addDimension</a></li><li><a href="global.html#addFilter">addFilter</a></li><li><a href="global.html#addOrgUnitDimension">addOrgUnitDimension</a></li><li><a href="global.html#addOrgUnitFilter">addOrgUnitFilter</a></li><li><a href="global.html#addPeriodDimension">addPeriodDimension</a></li><li><a href="global.html#addPeriodFilter">addPeriodFilter</a></li><li><a href="global.html#byOrgUnit">byOrgUnit</a></li><li><a href="global.html#computeWeekBasedPeriod">computeWeekBasedPeriod</a></li><li><a href="global.html#getAll">getAll</a></li><li><a href="global.html">getGeoFeatures</a></li><li><a href="global.html">isValidDisplayName</a></li><li><a href="global.html">isValidOrgUnit</a></li><li><a href="global.html">isValidOrgUnitGroup</a></li><li><a href="global.html">isValidOrgUnitLevel</a></li><li><a href="global.html">isValidUserOrgUnit</a></li><li><a href="global.html#withAggregateData">withAggregateData</a></li><li><a href="global.html#withAggregationType">withAggregationType</a></li><li><a href="global.html#withApprovalLevel">withApprovalLevel</a></li><li><a href="global.html#withAsc">withAsc</a></li><li><a href="global.html#withBbox">withBbox</a></li><li><a href="global.html#withClusterSize">withClusterSize</a></li><li><a href="global.html#withCollapseDataDimensions">withCollapseDataDimensions</a></li><li><a href="global.html#withColumns">withColumns</a></li><li><a href="global.html#withCoordinateField">withCoordinateField</a></li><li><a href="global.html#withCoordinatesOnly">withCoordinatesOnly</a></li><li><a href="global.html#withDesc">withDesc</a></li><li><a href="global.html#withDisplayProperty">withDisplayProperty</a></li><li><a href="global.html#withEndDate">withEndDate</a></li><li><a href="global.html#withEventStatus">withEventStatus</a></li><li><a href="global.html#withFormat">withFormat</a></li><li><a href="global.html#withHideEmptyColumns">withHideEmptyColumns</a></li><li><a href="global.html#withHideEmptyRows">withHideEmptyRows</a></li><li><a href="global.html#withHierarchyMeta">withHierarchyMeta</a></li><li><a href="global.html#withIgnoreLimit">withIgnoreLimit</a></li><li><a href="global.html#withIncludeClusterPoints">withIncludeClusterPoints</a></li><li><a href="global.html#withIncludeMetadataDetails">withIncludeMetadataDetails</a></li><li><a href="global.html#withIncludeNumDen">withIncludeNumDen</a></li><li><a href="global.html#withInputIdScheme">withInputIdScheme</a></li><li><a href="global.html#withLimit">withLimit</a></li><li><a href="global.html#withMeasureCriteria">withMeasureCriteria</a></li><li><a href="global.html#withOuMode">withOuMode</a></li><li><a href="global.html#withOutputIdScheme">withOutputIdScheme</a></li><li><a href="global.html#withOutputType">withOutputType</a></li><li><a href="global.html#withPage">withPage</a></li><li><a href="global.html#withPageSize">withPageSize</a></li><li><a href="global.html#withParameters">withParameters</a></li><li><a href="global.html#withPath">withPath</a></li><li><a href="global.html#withPreAggregationMeasureCriteria">withPreAggregationMeasureCriteria</a></li><li><a href="global.html#withProgram">withProgram</a></li><li><a href="global.html#withProgramStatus">withProgramStatus</a></li><li><a href="global.html#withRelativePeriodDate">withRelativePeriodDate</a></li><li><a href="global.html#withRows">withRows</a></li><li><a href="global.html#withShowHierarchy">withShowHierarchy</a></li><li><a href="global.html#withSkipData">withSkipData</a></li><li><a href="global.html#withSkipMeta">withSkipMeta</a></li><li><a href="global.html#withSkipRounding">withSkipRounding</a></li><li><a href="global.html#withSortOrder">withSortOrder</a></li><li><a href="global.html#withStage">withStage</a></li><li><a href="global.html#withStartDate">withStartDate</a></li><li><a href="global.html#withTableLayout">withTableLayout</a></li><li><a href="global.html#withUserOrgUnit">withUserOrgUnit</a></li><li><a href="global.html#withValue">withValue</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="computeWeekBasedPeriod"><span class="type-signature">(constant) </span>computeWeekBasedPeriod<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="period_helpers.js.html">period/helpers.js</a>, <a href="period_helpers.js.html#line201">line 201</a>
</li></ul></dd>
</dl>
<div class="description">
<p>This function takes some general instructions for a period and returns a precise period containing
a start date and end date. It corrects for week 1 starting in a previous year and for week 53 in a
52 week year
It is used by the BiWeekly periodType and all flavors of Weekly PeriodTypes,
such as Weekly, weeklyWednessday, etc.</p>
</div>
<h5>Examples</h5>
<pre class="prettyprint"><code>for default scenario
computeWeekBasedPeriod({ year: 2019, week: 12})
// returns:
// {
// week: 12,
// year: 2019,
// startMonthName: 'June',
// startDayNumber: 3,
// endDayNumber: 9,
// startDate: '2019-06-03',
// endDate: '2019-06-09',
// }</code></pre>
<pre class="prettyprint"><code>for week 53 in 52 week year edge case
computeWeekBasedPeriod({ year: 2016, week: 53})
// returns:
// {
// week: 1,
// year: 2017,
// startMonthName: 'January',
// startDayNumber: 2,
// endDayNumber: 8,
// startDate: '2017-01-02',
// endDate: '2017-01-08',
// }</code></pre>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="addDataDimension"><span class="type-signature"></span>addDataDimension<span class="signature">(items<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestDimensionsMixin.js.html">analytics/AnalyticsRequestDimensionsMixin.js</a>, <a href="analytics_AnalyticsRequestDimensionsMixin.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds/updates the dx dimension to use in the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.addDataDimension(['fbfJHSPpUQD', 'cYeuwXTCPkU'])
.addDataDimension('BfMAe6Itzgt.REPORTING_RATE');
// dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU;BfMAe6Itzgt.REPORTING_RATE</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The dimension items to add to the dx dimension</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="addDataFilter"><span class="type-signature"></span>addDataFilter<span class="signature">(items<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestFiltersMixin.js.html">analytics/AnalyticsRequestFiltersMixin.js</a>, <a href="analytics_AnalyticsRequestFiltersMixin.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds/updates the dx dimension filter to use in the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.addDataFilter(['fbfJHSPpUQD', 'cYeuwXTCPkU'])
.addDataFilter('BfMAe6Itzgt.REPORTING_RATE');
// filter=dx:fbfJHSPpUQD;cYeuwXTCPkU;BfMAe6Itzgt.REPORTING_RATE</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The dimension items to add to the dx dimension filter</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="addDimension"><span class="type-signature"></span>addDimension<span class="signature">(dimension<span class="signature-attributes">non-null</span>, items)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestDimensionsMixin.js.html">analytics/AnalyticsRequestDimensionsMixin.js</a>, <a href="analytics_AnalyticsRequestDimensionsMixin.js.html#line91">line 91</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds a new dimension or updates an existing one to use in the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.addDimension('Bpx0589u8y0', ['oRVt7g429ZO', 'MAs88nJc9nL'])
.addDimension('qrur9Dvnyt5-Yf6UHoPkdS6');
// dimension=Bpx0589u8y0:oRVt7g429ZO;MAs88nJc9nL&dimension=qrur9Dvnyt5-Yf6UHoPkdS6</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dimension</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The dimension to add to the request</p></td>
</tr>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The dimension items to add to the dimension</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="addFilter"><span class="type-signature"></span>addFilter<span class="signature">(dimension<span class="signature-attributes">non-null</span>, items)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestFiltersMixin.js.html">analytics/AnalyticsRequestFiltersMixin.js</a>, <a href="analytics_AnalyticsRequestFiltersMixin.js.html#line91">line 91</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds a filter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.addFilter('Bpx0589u8y0', ['oRVt7g429ZO', 'MAs88nJc9nL'])
.addFilter('qrur9Dvnyt5-Yf6UHoPkdS6');
// filter=Bpx0589u8y0:oRVt7g429ZO;MAs88nJc9nL&filter=qrur9Dvnyt5-Yf6UHoPkdS6</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dimension</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The dimension to add as filter to the request</p></td>
</tr>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The dimension items to add to the dimension filter</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="addOrgUnitDimension"><span class="type-signature"></span>addOrgUnitDimension<span class="signature">(items<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestDimensionsMixin.js.html">analytics/AnalyticsRequestDimensionsMixin.js</a>, <a href="analytics_AnalyticsRequestDimensionsMixin.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds/updates the ou dimension to use in the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.addOrgUnitDimension(['O6uvpzGd5pu', 'lc3eMKXaEfw'])
.addOrgUnitDimension('OU_GROUP-w0gFTTmsUcF');
// dimension=ou:O6uvpzGd5pu;lc3eMKXaEfw;OU_GROUP-w0gFTTmsUcF</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The dimension items to add to the ou dimension</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="addOrgUnitFilter"><span class="type-signature"></span>addOrgUnitFilter<span class="signature">(items<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestFiltersMixin.js.html">analytics/AnalyticsRequestFiltersMixin.js</a>, <a href="analytics_AnalyticsRequestFiltersMixin.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds/updates the ou dimension filter to use in the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.addOrgUnitFilter(['O6uvpzGd5pu', 'lc3eMKXaEfw'])
.addOrgUnitFilter('OU_GROUP-w0gFTTmsUcF')
// filter=ou:O6uvpzGd5pu;lc3eMKXaEfw;OU_GROUP-w0gFTTmsUcF</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The dimension items to add to the ou dimension filter</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="addPeriodDimension"><span class="type-signature"></span>addPeriodDimension<span class="signature">(items<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestDimensionsMixin.js.html">analytics/AnalyticsRequestDimensionsMixin.js</a>, <a href="analytics_AnalyticsRequestDimensionsMixin.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds/updates the pe dimension to use in the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.addPeriodDimension(['201701', '201702'])
.addPeriodDimension('LAST_4_QUARTERS');
// dimension=pe:201701;201702;LAST_4_QUARTERS</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The dimension items to add to the pe dimension</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="addPeriodFilter"><span class="type-signature"></span>addPeriodFilter<span class="signature">(items<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestFiltersMixin.js.html">analytics/AnalyticsRequestFiltersMixin.js</a>, <a href="analytics_AnalyticsRequestFiltersMixin.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds/updates the pe dimension filter to use in the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.addPeriodFilter(['201701', '201702'])
.addPeriodFilter('LAST_4_QUARTERS')
// filter=pe:201701;201702;LAST_4_QUARTERS</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The dimension items to add to the pe dimension filter</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="byOrgUnit"><span class="type-signature"></span>byOrgUnit<span class="signature">(orgUnits)</span><span class="type-signature"> → {<a href="GeoFeatures.html">GeoFeatures</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="geofeatures_GeoFeatures.js.html">geofeatures/GeoFeatures.js</a>, <a href="geofeatures_GeoFeatures.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>orgUnits</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>Organisation units (UID, level, group, user org. unit) to include in the response.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="GeoFeatures.html">GeoFeatures</a></span>
</dd>
</dl>
<h4 class="name" id="byOrgUnit"><span class="type-signature"></span>byOrgUnit<span class="signature">(displayName)</span><span class="type-signature"> → {<a href="GeoFeatures.html">GeoFeatures</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="geofeatures_GeoFeatures.js.html">geofeatures/GeoFeatures.js</a>, <a href="geofeatures_GeoFeatures.js.html#line42">line 42</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>displayName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name property to display (NAME|SHORTNAME).</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="GeoFeatures.html">GeoFeatures</a></span>
</dd>
</dl>
<h4 class="name" id="getAll"><span class="type-signature"></span>getAll<span class="signature">(params)</span><span class="type-signature"> → {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="geofeatures_GeoFeatures.js.html">geofeatures/GeoFeatures.js</a>, <a href="geofeatures_GeoFeatures.js.html#line61">line 61</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>params</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Extra URL params to pass to the Web API endpoint.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>with an array of geofeatures.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getGeoFeatures"><span class="type-signature">(static) </span>getGeoFeatures<span class="signature">()</span><span class="type-signature"> → {<a href="GeoFeatures.html">GeoFeatures</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="geofeatures_GeoFeatures.js.html">geofeatures/GeoFeatures.js</a>, <a href="geofeatures_GeoFeatures.js.html#line165">line 165</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Get a new instance of the GeoFeatures object.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>Object with interaction properties</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="GeoFeatures.html">GeoFeatures</a></span>
</dd>
</dl>
<h4 class="name" id="isValidDisplayName"><span class="type-signature">(static) </span>isValidDisplayName<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="geofeatures_GeoFeatures.js.html">geofeatures/GeoFeatures.js</a>, <a href="geofeatures_GeoFeatures.js.html#line149">line 149</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Checks if the display name is valid.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if display name is valid</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isValidOrgUnit"><span class="type-signature">(static) </span>isValidOrgUnit<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="geofeatures_GeoFeatures.js.html">geofeatures/GeoFeatures.js</a>, <a href="geofeatures_GeoFeatures.js.html#line83">line 83</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Checks if the org. unit is valid (UID, level, group, user org. unit)</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if the org. unit is valid</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isValidOrgUnitGroup"><span class="type-signature">(static) </span>isValidOrgUnitGroup<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="geofeatures_GeoFeatures.js.html">geofeatures/GeoFeatures.js</a>, <a href="geofeatures_GeoFeatures.js.html#line118">line 118</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Checks if the org. unit group is valid.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if the org. unit group is valid</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isValidOrgUnitLevel"><span class="type-signature">(static) </span>isValidOrgUnitLevel<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="geofeatures_GeoFeatures.js.html">geofeatures/GeoFeatures.js</a>, <a href="geofeatures_GeoFeatures.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Checks if the org. unit level is valid.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if the org. unit level is valid</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isValidUserOrgUnit"><span class="type-signature">(static) </span>isValidUserOrgUnit<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="geofeatures_GeoFeatures.js.html">geofeatures/GeoFeatures.js</a>, <a href="geofeatures_GeoFeatures.js.html#line132">line 132</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Checks if the user org. unit is valid.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if the user org. unit is valid</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="withAggregateData"><span class="type-signature"></span>withAggregateData<span class="signature">(aggregateData<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line880">line 880</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the aggregateData query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withAggregateData();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>aggregateData</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The aggregateData value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withAggregationType"><span class="type-signature"></span>withAggregationType<span class="signature">(aggregationType)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the aggregationType query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withAggregationType('SUM');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>aggregationType</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The aggregationType value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withApprovalLevel"><span class="type-signature"></span>withApprovalLevel<span class="signature">(approvalLevel<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line395">line 395</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the approvalLevel query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withApprovalLevel('');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>approvalLevel</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The approvalLevel value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withAsc"><span class="type-signature"></span>withAsc<span class="signature">(value<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line661">line 661</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the asc query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withAsc('EVENTDATE');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The dimensions to be sorted ascending</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withBbox"><span class="type-signature"></span>withBbox<span class="signature">(bbox<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line932">line 932</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the bbox query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withBbox('11.1768827285209, 60.141691309755, 11.1694071634997, 60.287796722512');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>bbox</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The bounding box coordinates in the format "min lng, min lat, max lng, max lat"</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withClusterSize"><span class="type-signature"></span>withClusterSize<span class="signature">(clusterSize<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line896">line 896</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the clusterSize query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withClusterSize(1000);</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>clusterSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The size of cluster in meters</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withCollapseDataDimensions"><span class="type-signature"></span>withCollapseDataDimensions<span class="signature">(collapseDataDimensions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line848">line 848</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the collapseDataDimensions query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withCollapseDataDimensions();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>collapseDataDimensions</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The collapseDataDimensions value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withColumns"><span class="type-signature"></span>withColumns<span class="signature">(columns<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line452">line 452</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the columns query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withColumns('dx;ou');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>columns</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The dimensions identifiers (separated by ;)</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withCoordinateField"><span class="type-signature"></span>withCoordinateField<span class="signature">(coordinateField<span class="signature-attributes">opt, non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line915">line 915</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the coordinateField query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withCoordinateField('<attribute-id>');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>coordinateField</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>EVENT</code>
</td>
<td class="description last"><p>The field to base geospatial event analytics on</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withCoordinatesOnly"><span class="type-signature"></span>withCoordinatesOnly<span class="signature">(coordinatesOnly<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line699">line 699</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the coordinatesOnly query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withCoordinatesOnly();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>coordinatesOnly</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The coordinatesOnly value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withDesc"><span class="type-signature"></span>withDesc<span class="signature">(value<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line680">line 680</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the desc query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withDesc('OUNAME');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The dimensions to be sorted descending</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withDisplayProperty"><span class="type-signature"></span>withDisplayProperty<span class="signature">(displayProperty<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line329">line 329</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the displayProperty query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withDisplayProperty('SHORTNAME');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>displayProperty</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The displayProperty value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withEndDate"><span class="type-signature"></span>withEndDate<span class="signature">(endDate<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line509">line 509</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the endDate query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withEndDate('2017-12-31');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>endDate</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The endDate value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withEventStatus"><span class="type-signature"></span>withEventStatus<span class="signature">(eventStatus<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line567">line 567</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the eventStatus query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withEventStatus('COMPLETED');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>eventStatus</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The eventStatus value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withFormat"><span class="type-signature"></span>withFormat<span class="signature">(format<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Sets the response format for the request.
It appends the file extension to the request's path.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withFormat('xml');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>json</code>
</td>
<td class="description last"><p>The format of the response</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withHideEmptyColumns"><span class="type-signature"></span>withHideEmptyColumns<span class="signature">(hideEmptyColumns<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line265">line 265</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the hideEmptyColumns query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withHideEmptyColumns();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hideEmptyColumns</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The hideEmptyColumns value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withHideEmptyRows"><span class="type-signature"></span>withHideEmptyRows<span class="signature">(hideEmptyRows<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line249">line 249</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the hideEmptyRows query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withHideEmptyRows();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hideEmptyRows</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The hideEmptyRows value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withHierarchyMeta"><span class="type-signature"></span>withHierarchyMeta<span class="signature">(hierarchyMeta<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line201">line 201</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the hierarchyMeta query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withHierarchyMeta();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hierarchyMeta</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The hierarchyMeta value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withIgnoreLimit"><span class="type-signature"></span>withIgnoreLimit<span class="signature">(ignoreLimit<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line217">line 217</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the ignoreLimit query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withIgnoreLimit();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ignoreLimit</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The ignoreLimit value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withIncludeClusterPoints"><span class="type-signature"></span>withIncludeClusterPoints<span class="signature">(includeClusterPoints<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line951">line 951</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the includeClusterPoints query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withIncludeClusterPoints();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>includeClusterPoints</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The includeClusterPoints value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withIncludeMetadataDetails"><span class="type-signature"></span>withIncludeMetadataDetails<span class="signature">(includeMetadataDetails<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line313">line 313</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the includeMetadataDetails query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withIncludeMetadataDetails();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>includeMetadataDetails</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The includeMetadataDetails value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withIncludeNumDen"><span class="type-signature"></span>withIncludeNumDen<span class="signature">(includeNumDen<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line297">line 297</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the includeNumDen query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withIncludeNumDen();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>includeNumDen</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The includeNumDen value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withInputIdScheme"><span class="type-signature"></span>withInputIdScheme<span class="signature">(inputIdScheme<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line376">line 376</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the inputIdScheme query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withInputIdScheme('CODE');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>inputIdScheme</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The inputIdScheme value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withLimit"><span class="type-signature"></span>withLimit<span class="signature">(limit<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line795">line 795</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the limit query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withLimit('5000');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>limit</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The maximum number of records to return</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withMeasureCriteria"><span class="type-signature"></span>withMeasureCriteria<span class="signature">(measureCriteria<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line131">line 131</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the measureCriteria query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withMeasureCriteria('GE:10;LT:50');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>measureCriteria</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The measureCriteria value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withOuMode"><span class="type-signature"></span>withOuMode<span class="signature">(ouMode<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line633">line 633</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the ouMode query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withOuMode('CHILDREN');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ouMode</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The ouMode value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withOutputIdScheme"><span class="type-signature"></span>withOutputIdScheme<span class="signature">(displayProperty<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line357">line 357</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the displayProperty query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withDisplayProperty('SHORTNAME');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>displayProperty</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The displayProperty value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withOutputType"><span class="type-signature"></span>withOutputType<span class="signature">(outputType<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line816">line 816</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the outputType query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withOutputType('ENROLLMENT');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>outputType</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The output type</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withPage"><span class="type-signature"></span>withPage<span class="signature">(page<span class="signature-attributes">opt, non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line715">line 715</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the page query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withPage(2);</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>page</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>1</code>
</td>
<td class="description last"><p>The page number</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withPageSize"><span class="type-signature"></span>withPageSize<span class="signature">(size<span class="signature-attributes">opt, non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line731">line 731</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the pageSize query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withPageSize(10);</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>size</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>50</code>
</td>
<td class="description last"><p>The number of items per page</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withParameters"><span class="type-signature"></span>withParameters<span class="signature">(parameters<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Sets the query parameters of the request</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withParameters({ completedOnly: true, aggregationType: 'AVERAGE' });</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The query parameters to add/modify to the request</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withPath"><span class="type-signature"></span>withPath<span class="signature">(path<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line56">line 56</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Sets the URL path for the request.
It appends the given path to the request's URL.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withPath('aggregate');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The path of the response</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withPreAggregationMeasureCriteria"><span class="type-signature"></span>withPreAggregationMeasureCriteria<span class="signature">(preAggregationMeasureCriteria<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line150">line 150</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the preAggregationMeasureCriteria query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withPreAggregationMeasureCriteria('GE:10;LT:50');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>preAggregationMeasureCriteria</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The preAggregationMeasureCriteria value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withProgram"><span class="type-signature"></span>withProgram<span class="signature">(program<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line529">line 529</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Sets the program for the request.
It appends the program id to the request's path.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withProgram('eBAyeGv0exc');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>program</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The program id</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withProgramStatus"><span class="type-signature"></span>withProgramStatus<span class="signature">(programStatus<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line601">line 601</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the programStatus query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withProgramStatus('COMPLETED');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>programStatus</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The programStatus value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withRelativePeriodDate"><span class="type-signature"></span>withRelativePeriodDate<span class="signature">(relativePeriodDate<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line414">line 414</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the relativePeriodDate query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withRelativePeriodDate('LAST_12_MONTHS');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>relativePeriodDate</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The relativePeriodDate value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withRows"><span class="type-signature"></span>withRows<span class="signature">(rows<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line471">line 471</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the rows query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withRows('pe');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rows</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The dimensions identifiers (separated by ;)</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withShowHierarchy"><span class="type-signature"></span>withShowHierarchy<span class="signature">(showHierarchy<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line281">line 281</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the showHierarchy query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withShowHierarchy();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>showHierarchy</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The showHierarchy value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withSkipData"><span class="type-signature"></span>withSkipData<span class="signature">(skipData<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line185">line 185</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the skipData query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withSkipData();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>skipData</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The skipData value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withSkipMeta"><span class="type-signature"></span>withSkipMeta<span class="signature">(skipMeta<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line169">line 169</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the skipMeta query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withSkipMeta();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>skipMeta</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The skipMeta value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withSkipRounding"><span class="type-signature"></span>withSkipRounding<span class="signature">(skipRounding<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line864">line 864</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the skipRounding query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withSkipRounding();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>skipRounding</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The skipRounding value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withSortOrder"><span class="type-signature"></span>withSortOrder<span class="signature">(sortOrder<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line767">line 767</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the sortOrder query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withSortOrder('DESC');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sortOrder</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The sortOrder value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withStage"><span class="type-signature"></span>withStage<span class="signature">(stage<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line548">line 548</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the stage query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withStage('Zj7UnCAulEk');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stage</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The stage value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withStartDate"><span class="type-signature"></span>withStartDate<span class="signature">(startDate<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line490">line 490</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the startDate query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withStartDate('2017-11-28');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startDate</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The startDate value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withTableLayout"><span class="type-signature"></span>withTableLayout<span class="signature">(tableLayout<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line233">line 233</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the tableLayout query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withTableLayout();</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tableLayout</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>The tableLayout value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withUserOrgUnit"><span class="type-signature"></span>withUserOrgUnit<span class="signature">(userOrgUnit<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line433">line 433</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the userOrgUnit query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withUserOrgUnit('O6uvpzGd5pu');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>userOrgUnit</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The userOrgUnit value</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
<h4 class="name" id="withValue"><span class="type-signature"></span>withValue<span class="signature">(value<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {AnalyticsRequest}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="analytics_AnalyticsRequestPropertiesMixin.js.html">analytics/AnalyticsRequestPropertiesMixin.js</a>, <a href="analytics_AnalyticsRequestPropertiesMixin.js.html#line747">line 747</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Adds the value query parameter to the request.</p>
</div>
<h5>Example</h5>
<pre class="prettyprint"><code>const req = new d2.analytics.request()
.withValue('UXz7xuGCEhU');</code></pre>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>A data element or attribute identifier</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new instance of the class for chaining purposes</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">AnalyticsRequest</span>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Thu Nov 18 2021 08:51:53 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>