Service to retrieve dialogue reporting data.
Example
define([
"blueconic/api/data/service/reporting/dialogueService"
], function(dialogueService) {
// ...
});
Properties
-
readonly AGGREGATION string
-
All possible values of the aggregation.
Properties:
Name Description DAILY Every day.
WEEKLY Every week.
MONTHLY Every month.
PERIOD Use data from a custom defined period.
OVERALL Use all data available.
-
readonly PERIOD string
-
All possible values of the selection period.
Properties:
Name Description DAILY Every day.
WEEKLY Every week.
MONTHLY Every month.
-
readonly TARGETMETRIC string
-
All possible values of the dialogue target metric.
Properties:
Name Description CLICKVIEWRATIO Number of clicks compared to the number of views.
CONVERSIONCLICKRATIO Number of conversions compared to the number of clicks.
CONVERSIONVIEWRATIO Number of conversions compared to the number of views.
LIFTCLICKVIEWRATIO Number of clicks compared to the number of views, compared to the control group.
LIFTCONVERSIONVIEWRATIO Number of conversions compared to the number of views, compared to the control group.
LIFTCONVERSIONCLICKRATIO Number of conversions compared to the number of clicks, compared to the control group.
Functions
-
getDialogueMetrics(options)dojo/Deferred
-
Returns the actual metrics (views, click, conversions etc.) for a set of Dialogue id's. This is the aggregated data for all variants in that dialogue.
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. dialogues blueconic.api.data.domain.Dialogue[] The dialogues that need to be retrieved. targetMetric TARGETMETRIC Metric of the target. Required when a target is supplied. target float Value of the target. targetPeriod PERIOD Period for the target. includeControlGroup boolean Include the control group in the actual dialogue metrics. addRatio String Additional ratios to include in the response, e.g. {@code TOTALCONVERSION_CLICK}. Returns:
Type Description dojo/Deferred Deferred containing the result set of type blueconic.api.data.domain.reporting.Dialogues. -
getDialoguesHistory(options)dojo/Deferred
-
Returns the historical reporting data for all selected dialogues.
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. dialogues blueconic.api.data.domain.Dialogue[] An array of dialogues that need to be retrieved. targetMetric TARGETMETRIC Metric of the target. Required when a target is supplied. target float Value of the target includeControlGroup boolean Include the control group in the data over all historical data of the specified dialogues. addRatio String Additional ratios to include in the response, e.g. {@code TOTALCONVERSION_CLICK}. Returns:
Type Description dojo/Deferred Deferred containing the result set of type blueconic.api.data.domain.reporting.DialogueHistoryData. -
getVariantOrTrackerHistory(options)dojo/Deferred
-
Returns the historical reporting data for one variant or tracker.
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. variant blueconic.api.data.domain.Variant The variant to get the historical data from. tracker blueconic.api.data.domain.Tracker The tracker to get the historical data from. aggregation AGGREGATION Aggregation of the results. periodInterval integer Number of units to retrieve data for, eg periodInterval of 30 and aggregation is daily, means 30 days in the past addRatio String Additional ratios to include in the response, e.g. {@code TOTALCONVERSION_CLICK}. Returns:
Type Description dojo/Deferred Deferred containing the result set of type blueconic.api.data.domain.reporting.VariantOrTrackerHistoryData. -
getVariantsHistory(options)dojo/Deferred
-
Returns the historical reporting data for all variants of an dialogue.
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. dialogue blueconic.api.data.domain.Dialogue The dialogue to retrieve the historical variants data from. aggregation AGGREGATION Aggregation of the results. periodInterval integer Number of units to retrieve data for, eg periodInterval of 30 and aggregation is daily, means 30 days in the past includeControlGroup boolean Include the control group in the dialogue data. addRatio String Additional ratios to include in the response, e.g. {@code TOTALCONVERSION_CLICK}. Returns:
Type Description dojo/Deferred Deferred containing the result set of type blueconic.api.data.domain.reporting.VariantHistoryData.