Global

Members

(constant) computeWeekBasedPeriod

Source:

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.

Examples
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',
// }
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',
// }

Methods

addDataDimension(itemsnon-null) → {AnalyticsRequest}

Source:

Adds/updates the dx dimension to use in the request.

Example
const req = new d2.analytics.request()
   .addDataDimension(['fbfJHSPpUQD', 'cYeuwXTCPkU'])
   .addDataDimension('BfMAe6Itzgt.REPORTING_RATE');

// dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU;BfMAe6Itzgt.REPORTING_RATE
Parameters:
Name Type Description
items String | Array

The dimension items to add to the dx dimension
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

addDataFilter(itemsnon-null) → {AnalyticsRequest}

Source:

Adds/updates the dx dimension filter to use in the request.

Example
const req = new d2.analytics.request()
   .addDataFilter(['fbfJHSPpUQD', 'cYeuwXTCPkU'])
   .addDataFilter('BfMAe6Itzgt.REPORTING_RATE');

// filter=dx:fbfJHSPpUQD;cYeuwXTCPkU;BfMAe6Itzgt.REPORTING_RATE
Parameters:
Name Type Description
items String | Array

The dimension items to add to the dx dimension filter
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

addDimension(dimensionnon-null, items) → {AnalyticsRequest}

Source:

Adds a new dimension or updates an existing one to use in the request.

Example
const req = new d2.analytics.request()
   .addDimension('Bpx0589u8y0', ['oRVt7g429ZO', 'MAs88nJc9nL'])
   .addDimension('qrur9Dvnyt5-Yf6UHoPkdS6');

// dimension=Bpx0589u8y0:oRVt7g429ZO;MAs88nJc9nL&dimension=qrur9Dvnyt5-Yf6UHoPkdS6
Parameters:
Name Type Description
dimension String

The dimension to add to the request
items String | Array

The dimension items to add to the dimension
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

addFilter(dimensionnon-null, items) → {AnalyticsRequest}

Source:

Adds a filter to the request.

Example
const req = new d2.analytics.request()
   .addFilter('Bpx0589u8y0', ['oRVt7g429ZO', 'MAs88nJc9nL'])
   .addFilter('qrur9Dvnyt5-Yf6UHoPkdS6');

// filter=Bpx0589u8y0:oRVt7g429ZO;MAs88nJc9nL&filter=qrur9Dvnyt5-Yf6UHoPkdS6
Parameters:
Name Type Description
dimension String

The dimension to add as filter to the request
items String | Array

The dimension items to add to the dimension filter
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

addOrgUnitDimension(itemsnon-null) → {AnalyticsRequest}

Source:

Adds/updates the ou dimension to use in the request.

Example
const req = new d2.analytics.request()
   .addOrgUnitDimension(['O6uvpzGd5pu', 'lc3eMKXaEfw'])
   .addOrgUnitDimension('OU_GROUP-w0gFTTmsUcF');

// dimension=ou:O6uvpzGd5pu;lc3eMKXaEfw;OU_GROUP-w0gFTTmsUcF
Parameters:
Name Type Description
items String | Array

The dimension items to add to the ou dimension
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

addOrgUnitFilter(itemsnon-null) → {AnalyticsRequest}

Source:

Adds/updates the ou dimension filter to use in the request.

Example
const req = new d2.analytics.request()
   .addOrgUnitFilter(['O6uvpzGd5pu', 'lc3eMKXaEfw'])
   .addOrgUnitFilter('OU_GROUP-w0gFTTmsUcF')

// filter=ou:O6uvpzGd5pu;lc3eMKXaEfw;OU_GROUP-w0gFTTmsUcF
Parameters:
Name Type Description
items String | Array

The dimension items to add to the ou dimension filter
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

addPeriodDimension(itemsnon-null) → {AnalyticsRequest}

Source:

Adds/updates the pe dimension to use in the request.

Example
const req = new d2.analytics.request()
   .addPeriodDimension(['201701', '201702'])
   .addPeriodDimension('LAST_4_QUARTERS');

// dimension=pe:201701;201702;LAST_4_QUARTERS
Parameters:
Name Type Description
items String | Array

The dimension items to add to the pe dimension
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

addPeriodFilter(itemsnon-null) → {AnalyticsRequest}

Source:

Adds/updates the pe dimension filter to use in the request.

Example
const req = new d2.analytics.request()
   .addPeriodFilter(['201701', '201702'])
   .addPeriodFilter('LAST_4_QUARTERS')

// filter=pe:201701;201702;LAST_4_QUARTERS
Parameters:
Name Type Description
items String | Array

The dimension items to add to the pe dimension filter
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

byOrgUnit(displayName) → {GeoFeatures}

Source:
Parameters:
Name Type Description
displayName String

The name property to display (NAME|SHORTNAME).
Returns:
Type
GeoFeatures

byOrgUnit(orgUnits) → {GeoFeatures}

Source:
Parameters:
Name Type Description
orgUnits Array

Organisation units (UID, level, group, user org. unit) to include in the response.
Returns:
Type
GeoFeatures

getAll(params) → {Promise}

Source:
Parameters:
Name Type Description
params Object

Extra URL params to pass to the Web API endpoint.
Returns:

with an array of geofeatures.

Type
Promise

(static) getGeoFeatures() → {GeoFeatures}

Source:

Get a new instance of the GeoFeatures object.

Returns:

Object with interaction properties

Type
GeoFeatures

(static) isValidDisplayName() → {boolean}

Source:

Checks if the display name is valid.

Returns:

True if display name is valid

Type
boolean

(static) isValidOrgUnit() → {boolean}

Source:

Checks if the org. unit is valid (UID, level, group, user org. unit)

Returns:

True if the org. unit is valid

Type
boolean

(static) isValidOrgUnitGroup() → {boolean}

Source:

Checks if the org. unit group is valid.

Returns:

True if the org. unit group is valid

Type
boolean

(static) isValidOrgUnitLevel() → {boolean}

Source:

Checks if the org. unit level is valid.

Returns:

True if the org. unit level is valid

Type
boolean

(static) isValidUserOrgUnit() → {boolean}

Source:

Checks if the user org. unit is valid.

Returns:

True if the user org. unit is valid

Type
boolean

withAggregateData(aggregateDataopt) → {AnalyticsRequest}

Source:

Adds the aggregateData query parameter to the request.

Example
const req = new d2.analytics.request()
   .withAggregateData();
Parameters:
Name Type Attributes Default Description
aggregateData Boolean <optional>
 true

The aggregateData value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withAggregationType(aggregationType) → {AnalyticsRequest}

Source:

Adds the aggregationType query parameter to the request.

Example
const req = new d2.analytics.request()
   .withAggregationType('SUM');
Parameters:
Name Type Description
aggregationType String

The aggregationType value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withApprovalLevel(approvalLevelnon-null) → {AnalyticsRequest}

Source:

Adds the approvalLevel query parameter to the request.

Example
const req = new d2.analytics.request()
   .withApprovalLevel('');
Parameters:
Name Type Description
approvalLevel String

The approvalLevel value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withAsc(valuenon-null) → {AnalyticsRequest}

Source:

Adds the asc query parameter to the request.

Example
const req = new d2.analytics.request()
   .withAsc('EVENTDATE');
Parameters:
Name Type Description
value String

The dimensions to be sorted ascending
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withBbox(bboxnon-null) → {AnalyticsRequest}

Source:

Adds the bbox query parameter to the request.

Example
const req = new d2.analytics.request()
   .withBbox('11.1768827285209, 60.141691309755, 11.1694071634997, 60.287796722512');
Parameters:
Name Type Description
bbox String

The bounding box coordinates in the format "min lng, min lat, max lng, max lat"
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withClusterSize(clusterSizenon-null) → {AnalyticsRequest}

Source:

Adds the clusterSize query parameter to the request.

Example
const req = new d2.analytics.request()
   .withClusterSize(1000);
Parameters:
Name Type Description
clusterSize Number

The size of cluster in meters
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withCollapseDataDimensions(collapseDataDimensionsopt) → {AnalyticsRequest}

Source:

Adds the collapseDataDimensions query parameter to the request.

Example
const req = new d2.analytics.request()
   .withCollapseDataDimensions();
Parameters:
Name Type Attributes Default Description
collapseDataDimensions Boolean <optional>
 true

The collapseDataDimensions value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withColumns(columnsnon-null) → {AnalyticsRequest}

Source:

Adds the columns query parameter to the request.

Example
const req = new d2.analytics.request()
   .withColumns('dx;ou');
Parameters:
Name Type Description
columns String

The dimensions identifiers (separated by ;)
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withCoordinateField(coordinateFieldopt, non-null) → {AnalyticsRequest}

Source:

Adds the coordinateField query parameter to the request.

Example
const req = new d2.analytics.request()
   .withCoordinateField('<attribute-id>');
Parameters:
Name Type Attributes Default Description
coordinateField String <optional>
 EVENT

The field to base geospatial event analytics on
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withCoordinatesOnly(coordinatesOnlyopt) → {AnalyticsRequest}

Source:

Adds the coordinatesOnly query parameter to the request.

Example
const req = new d2.analytics.request()
   .withCoordinatesOnly();
Parameters:
Name Type Attributes Default Description
coordinatesOnly Boolean <optional>
 true

The coordinatesOnly value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withDesc(valuenon-null) → {AnalyticsRequest}

Source:

Adds the desc query parameter to the request.

Example
const req = new d2.analytics.request()
   .withDesc('OUNAME');
Parameters:
Name Type Description
value String

The dimensions to be sorted descending
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withDisplayProperty(displayPropertynon-null) → {AnalyticsRequest}

Source:

Adds the displayProperty query parameter to the request.

Example
const req = new d2.analytics.request()
   .withDisplayProperty('SHORTNAME');
Parameters:
Name Type Description
displayProperty String

The displayProperty value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withEndDate(endDatenon-null) → {AnalyticsRequest}

Source:

Adds the endDate query parameter to the request.

Example
const req = new d2.analytics.request()
   .withEndDate('2017-12-31');
Parameters:
Name Type Description
endDate String

The endDate value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withEventStatus(eventStatusnon-null) → {AnalyticsRequest}

Source:

Adds the eventStatus query parameter to the request.

Example
const req = new d2.analytics.request()
   .withEventStatus('COMPLETED');
Parameters:
Name Type Description
eventStatus String

The eventStatus value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withFormat(formatopt) → {AnalyticsRequest}

Source:

Sets the response format for the request. It appends the file extension to the request's path.

Example
const req = new d2.analytics.request()
   .withFormat('xml');
Parameters:
Name Type Attributes Default Description
format String <optional>
 json

The format of the response
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withHideEmptyColumns(hideEmptyColumnsopt) → {AnalyticsRequest}

Source:

Adds the hideEmptyColumns query parameter to the request.

Example
const req = new d2.analytics.request()
   .withHideEmptyColumns();
Parameters:
Name Type Attributes Default Description
hideEmptyColumns Boolean <optional>
 true

The hideEmptyColumns value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withHideEmptyRows(hideEmptyRowsopt) → {AnalyticsRequest}

Source:

Adds the hideEmptyRows query parameter to the request.

Example
const req = new d2.analytics.request()
   .withHideEmptyRows();
Parameters:
Name Type Attributes Default Description
hideEmptyRows Boolean <optional>
 true

The hideEmptyRows value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withHierarchyMeta(hierarchyMetaopt) → {AnalyticsRequest}

Source:

Adds the hierarchyMeta query parameter to the request.

Example
const req = new d2.analytics.request()
   .withHierarchyMeta();
Parameters:
Name Type Attributes Default Description
hierarchyMeta Boolean <optional>
 true

The hierarchyMeta value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withIgnoreLimit(ignoreLimitopt) → {AnalyticsRequest}

Source:

Adds the ignoreLimit query parameter to the request.

Example
const req = new d2.analytics.request()
   .withIgnoreLimit();
Parameters:
Name Type Attributes Default Description
ignoreLimit Boolean <optional>
 true

The ignoreLimit value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withIncludeClusterPoints(includeClusterPointsopt) → {AnalyticsRequest}

Source:

Adds the includeClusterPoints query parameter to the request.

Example
const req = new d2.analytics.request()
   .withIncludeClusterPoints();
Parameters:
Name Type Attributes Default Description
includeClusterPoints Boolean <optional>
 true

The includeClusterPoints value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withIncludeMetadataDetails(includeMetadataDetailsopt) → {AnalyticsRequest}

Source:

Adds the includeMetadataDetails query parameter to the request.

Example
const req = new d2.analytics.request()
   .withIncludeMetadataDetails();
Parameters:
Name Type Attributes Default Description
includeMetadataDetails Boolean <optional>
 true

The includeMetadataDetails value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withIncludeNumDen(includeNumDenopt) → {AnalyticsRequest}

Source:

Adds the includeNumDen query parameter to the request.

Example
const req = new d2.analytics.request()
   .withIncludeNumDen();
Parameters:
Name Type Attributes Default Description
includeNumDen Boolean <optional>
 true

The includeNumDen value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withInputIdScheme(inputIdSchemenon-null) → {AnalyticsRequest}

Source:

Adds the inputIdScheme query parameter to the request.

Example
const req = new d2.analytics.request()
   .withInputIdScheme('CODE');
Parameters:
Name Type Description
inputIdScheme String

The inputIdScheme value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withLimit(limitnon-null) → {AnalyticsRequest}

Source:

Adds the limit query parameter to the request.

Example
const req = new d2.analytics.request()
   .withLimit('5000');
Parameters:
Name Type Description
limit Number

The maximum number of records to return
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withMeasureCriteria(measureCriterianon-null) → {AnalyticsRequest}

Source:

Adds the measureCriteria query parameter to the request.

Example
const req = new d2.analytics.request()
   .withMeasureCriteria('GE:10;LT:50');
Parameters:
Name Type Description
measureCriteria String

The measureCriteria value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withOuMode(ouModenon-null) → {AnalyticsRequest}

Source:

Adds the ouMode query parameter to the request.

Example
const req = new d2.analytics.request()
   .withOuMode('CHILDREN');
Parameters:
Name Type Description
ouMode String

The ouMode value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withOutputIdScheme(displayPropertynon-null) → {AnalyticsRequest}

Source:

Adds the displayProperty query parameter to the request.

Example
const req = new d2.analytics.request()
   .withDisplayProperty('SHORTNAME');
Parameters:
Name Type Description
displayProperty String

The displayProperty value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withOutputType(outputTypenon-null) → {AnalyticsRequest}

Source:

Adds the outputType query parameter to the request.

Example
const req = new d2.analytics.request()
   .withOutputType('ENROLLMENT');
Parameters:
Name Type Description
outputType String

The output type
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withPage(pageopt, non-null) → {AnalyticsRequest}

Source:

Adds the page query parameter to the request.

Example
const req = new d2.analytics.request()
   .withPage(2);
Parameters:
Name Type Attributes Default Description
page Number <optional>
 1

The page number
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withPageSize(sizeopt, non-null) → {AnalyticsRequest}

Source:

Adds the pageSize query parameter to the request.

Example
const req = new d2.analytics.request()
   .withPageSize(10);
Parameters:
Name Type Attributes Default Description
size Number <optional>
 50

The number of items per page
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withParameters(parametersnon-null) → {AnalyticsRequest}

Source:

Sets the query parameters of the request

Example
const req = new d2.analytics.request()
  .withParameters({ completedOnly: true, aggregationType: 'AVERAGE' });
Parameters:
Name Type Description
parameters Object

The query parameters to add/modify to the request
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withPath(pathnon-null) → {AnalyticsRequest}

Source:

Sets the URL path for the request. It appends the given path to the request's URL.

Example
const req = new d2.analytics.request()
   .withPath('aggregate');
Parameters:
Name Type Description
path String

The path of the response
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withPreAggregationMeasureCriteria(preAggregationMeasureCriterianon-null) → {AnalyticsRequest}

Source:

Adds the preAggregationMeasureCriteria query parameter to the request.

Example
const req = new d2.analytics.request()
   .withPreAggregationMeasureCriteria('GE:10;LT:50');
Parameters:
Name Type Description
preAggregationMeasureCriteria String

The preAggregationMeasureCriteria value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withProgram(programnon-null) → {AnalyticsRequest}

Source:

Sets the program for the request. It appends the program id to the request's path.

Example
const req = new d2.analytics.request()
   .withProgram('eBAyeGv0exc');
Parameters:
Name Type Description
program String

The program id
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withProgramStatus(programStatusnon-null) → {AnalyticsRequest}

Source:

Adds the programStatus query parameter to the request.

Example
const req = new d2.analytics.request()
   .withProgramStatus('COMPLETED');
Parameters:
Name Type Description
programStatus String

The programStatus value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withRelativePeriodDate(relativePeriodDatenon-null) → {AnalyticsRequest}

Source:

Adds the relativePeriodDate query parameter to the request.

Example
const req = new d2.analytics.request()
   .withRelativePeriodDate('LAST_12_MONTHS');
Parameters:
Name Type Description
relativePeriodDate String

The relativePeriodDate value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withRows(rowsnon-null) → {AnalyticsRequest}

Source:

Adds the rows query parameter to the request.

Example
const req = new d2.analytics.request()
   .withRows('pe');
Parameters:
Name Type Description
rows String

The dimensions identifiers (separated by ;)
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withShowHierarchy(showHierarchyopt) → {AnalyticsRequest}

Source:

Adds the showHierarchy query parameter to the request.

Example
const req = new d2.analytics.request()
   .withShowHierarchy();
Parameters:
Name Type Attributes Default Description
showHierarchy Boolean <optional>
 true

The showHierarchy value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withSkipData(skipDataopt) → {AnalyticsRequest}

Source:

Adds the skipData query parameter to the request.

Example
const req = new d2.analytics.request()
   .withSkipData();
Parameters:
Name Type Attributes Default Description
skipData Boolean <optional>
 true

The skipData value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withSkipMeta(skipMetaopt) → {AnalyticsRequest}

Source:

Adds the skipMeta query parameter to the request.

Example
const req = new d2.analytics.request()
   .withSkipMeta();
Parameters:
Name Type Attributes Default Description
skipMeta Boolean <optional>
 true

The skipMeta value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withSkipRounding(skipRoundingopt) → {AnalyticsRequest}

Source:

Adds the skipRounding query parameter to the request.

Example
const req = new d2.analytics.request()
   .withSkipRounding();
Parameters:
Name Type Attributes Default Description
skipRounding Boolean <optional>
 true

The skipRounding value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withSortOrder(sortOrdernon-null) → {AnalyticsRequest}

Source:

Adds the sortOrder query parameter to the request.

Example
const req = new d2.analytics.request()
   .withSortOrder('DESC');
Parameters:
Name Type Description
sortOrder String

The sortOrder value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withStage(stagenon-null) → {AnalyticsRequest}

Source:

Adds the stage query parameter to the request.

Example
const req = new d2.analytics.request()
   .withStage('Zj7UnCAulEk');
Parameters:
Name Type Description
stage String

The stage value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withStartDate(startDatenon-null) → {AnalyticsRequest}

Source:

Adds the startDate query parameter to the request.

Example
const req = new d2.analytics.request()
   .withStartDate('2017-11-28');
Parameters:
Name Type Description
startDate String

The startDate value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withTableLayout(tableLayoutopt) → {AnalyticsRequest}

Source:

Adds the tableLayout query parameter to the request.

Example
const req = new d2.analytics.request()
   .withTableLayout();
Parameters:
Name Type Attributes Default Description
tableLayout Boolean <optional>
 true

The tableLayout value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withUserOrgUnit(userOrgUnitnon-null) → {AnalyticsRequest}

Source:

Adds the userOrgUnit query parameter to the request.

Example
const req = new d2.analytics.request()
   .withUserOrgUnit('O6uvpzGd5pu');
Parameters:
Name Type Description
userOrgUnit String

The userOrgUnit value
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest

withValue(valuenon-null) → {AnalyticsRequest}

Source:

Adds the value query parameter to the request.

Example
const req = new d2.analytics.request()
   .withValue('UXz7xuGCEhU');
Parameters:
Name Type Description
value String

A data element or attribute identifier
Returns:

A new instance of the class for chaining purposes

Type
AnalyticsRequest