segmentService

Service to retrieve segment reporting data.

Example
define([
  "blueconic/api/data/service/reporting/segmentService"
], function(segmentService) {
  // ...
});

Properties

readonly TARGETMETRIC string

All possible values of the segment target metric.

Properties:
Name Description
CLICKRATIO

Number of clicks compared to the number of views.
CONVERSIONRATIO

Number of conversions compared to the number of clicks.
VIEWCONVERSIONRATIO

Number of conversions compared to the number of views.

Functions

getSegmentHistory(options)dojo/Deferred

Returns the historical reporting data for the selected segment.

Name Type Description
options Object

Options will be used to filter the results.

Name Type Description
context blueconic.api.data.domain.DashboardContext The dashboard context.
segment blueconic.api.data.domain.Segment segment that need to be retrieved.
targetMetric TARGETMETRIC Metric of the target.
target float Value of the target
Returns:
Type Description
dojo/Deferred Deferred containing the result set of type blueconic.api.data.domain.reporting.SegmentHistoryData.