MapDataRequest

The following routes are available for this service:
All Verbs	/RestApi/Sitefinity/Analytics/GetMapData
All Verbs	/RestApi/GetMapData

"use strict";
export class MetricItemDTO {
    /** @param {{Name?:string,DisplayName?:string,Value?:number,Unit?:string,DenominatorMetricName?:string,NominatorMetricName?:string,ShowInSelector?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    DisplayName;
    /** @type {number} */
    Value;
    /** @type {string} */
    Unit;
    /** @type {string} */
    DenominatorMetricName;
    /** @type {string} */
    NominatorMetricName;
    /** @type {boolean} */
    ShowInSelector;
}
/** @typedef {'Browser'|'BrowserVersion'|'City'|'Continent'|'VisitCount'|'Country'|'Date'|'Day'|'DaysSinceLastSession'|'FlashVersion'|'Hostname'|'Hour'|'DeviceCategory'|'JavaEnabled'|'Language'|'Latitude'|'Longitude'|'Month'|'NetworkDomain'|'NetworkLocation'|'PageDepth'|'OperatingSystem'|'OperatingSystemVersion'|'Region'|'ScreenColors'|'ScreenResolution'|'SubContinent'|'UserDefinedValue'|'UserType'|'Week'|'Year'|'AdContent'|'AdGroup'|'AdSlot'|'Campaign'|'Keyword'|'Medium'|'ReferralPath'|'Source'|'ExitPagePath'|'LandingPagePath'|'PagePath'|'PageTitle'|'Affiliation'|'DaysToTransaction'|'ProductCategory'|'ProductName'|'ProductSku'|'TransactionId'|'SearchCategory'|'SearchDestinationPage'|'SearchKeyword'|'SearchKeywordRefinement'|'SearchStartPage'|'SearchUsed'|'EventCategory'|'EventAction'|'EventLabel'} */
export var Dimension;
(function (Dimension) {
    Dimension["Browser"] = "Browser"
    Dimension["BrowserVersion"] = "BrowserVersion"
    Dimension["City"] = "City"
    Dimension["Continent"] = "Continent"
    Dimension["VisitCount"] = "VisitCount"
    Dimension["Country"] = "Country"
    Dimension["Date"] = "Date"
    Dimension["Day"] = "Day"
    Dimension["DaysSinceLastSession"] = "DaysSinceLastSession"
    Dimension["FlashVersion"] = "FlashVersion"
    Dimension["Hostname"] = "Hostname"
    Dimension["Hour"] = "Hour"
    Dimension["DeviceCategory"] = "DeviceCategory"
    Dimension["JavaEnabled"] = "JavaEnabled"
    Dimension["Language"] = "Language"
    Dimension["Latitude"] = "Latitude"
    Dimension["Longitude"] = "Longitude"
    Dimension["Month"] = "Month"
    Dimension["NetworkDomain"] = "NetworkDomain"
    Dimension["NetworkLocation"] = "NetworkLocation"
    Dimension["PageDepth"] = "PageDepth"
    Dimension["OperatingSystem"] = "OperatingSystem"
    Dimension["OperatingSystemVersion"] = "OperatingSystemVersion"
    Dimension["Region"] = "Region"
    Dimension["ScreenColors"] = "ScreenColors"
    Dimension["ScreenResolution"] = "ScreenResolution"
    Dimension["SubContinent"] = "SubContinent"
    Dimension["UserDefinedValue"] = "UserDefinedValue"
    Dimension["UserType"] = "UserType"
    Dimension["Week"] = "Week"
    Dimension["Year"] = "Year"
    Dimension["AdContent"] = "AdContent"
    Dimension["AdGroup"] = "AdGroup"
    Dimension["AdSlot"] = "AdSlot"
    Dimension["Campaign"] = "Campaign"
    Dimension["Keyword"] = "Keyword"
    Dimension["Medium"] = "Medium"
    Dimension["ReferralPath"] = "ReferralPath"
    Dimension["Source"] = "Source"
    Dimension["ExitPagePath"] = "ExitPagePath"
    Dimension["LandingPagePath"] = "LandingPagePath"
    Dimension["PagePath"] = "PagePath"
    Dimension["PageTitle"] = "PageTitle"
    Dimension["Affiliation"] = "Affiliation"
    Dimension["DaysToTransaction"] = "DaysToTransaction"
    Dimension["ProductCategory"] = "ProductCategory"
    Dimension["ProductName"] = "ProductName"
    Dimension["ProductSku"] = "ProductSku"
    Dimension["TransactionId"] = "TransactionId"
    Dimension["SearchCategory"] = "SearchCategory"
    Dimension["SearchDestinationPage"] = "SearchDestinationPage"
    Dimension["SearchKeyword"] = "SearchKeyword"
    Dimension["SearchKeywordRefinement"] = "SearchKeywordRefinement"
    Dimension["SearchStartPage"] = "SearchStartPage"
    Dimension["SearchUsed"] = "SearchUsed"
    Dimension["EventCategory"] = "EventCategory"
    Dimension["EventAction"] = "EventAction"
    Dimension["EventLabel"] = "EventLabel"
})(Dimension || (Dimension = {}));
export class MapDataRequest {
    /** @param {{DashboardId?:string,RelatedDashboardId?:string,Metrics?:MetricItemDTO[],Filter?:string,Dimension?:Dimension,jsStartDate?:string,jsEndDate?:string,SelectedMetric?:string,Region?:string,SiteId?:string,StartDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DashboardId;
    /** @type {string} */
    RelatedDashboardId;
    /** @type {MetricItemDTO[]} */
    Metrics;
    /** @type {string} */
    Filter;
    /** @type {Dimension} */
    Dimension;
    /** @type {string} */
    jsStartDate;
    /** @type {string} */
    jsEndDate;
    /** @type {string} */
    SelectedMetric;
    /** @type {string} */
    Region;
    /** @type {string} */
    SiteId;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
}
export class DimensionItem {
    /** @param {{Value?:string,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Value;
    /** @type {string} */
    Name;
}
export class SingleSerie {
    /** @param {{MainMetric?:MetricItemDTO,CategoryFormat?:string,Batch?:boolean,IsCategory?:boolean,SeriesName?:string,SeriesDimensions?:DimensionItem[],RelatedDimension?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {MetricItemDTO} */
    MainMetric;
    /** @type {string} */
    CategoryFormat;
    /** @type {boolean} */
    Batch;
    /** @type {boolean} */
    IsCategory;
    /** @type {string} */
    SeriesName;
    /** @type {DimensionItem[]} */
    SeriesDimensions;
    /** @type {string} */
    RelatedDimension;
}
export class DashBoardControl {
    /** @param {{ControlType?:string,attributes?:{ [index: string]: string; },PlaceholderId?:string,DisplayName?:string,Series?:SingleSerie[],DimensionName?:string,RelatedDimension?:string[],SortbyField?:string,SortAsc?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ControlType;
    /** @type {{ [index: string]: string; }} */
    attributes;
    /** @type {string} */
    PlaceholderId;
    /** @type {string} */
    DisplayName;
    /** @type {SingleSerie[]} */
    Series;
    /** @type {string} */
    DimensionName;
    /** @type {string[]} */
    RelatedDimension;
    /** @type {string} */
    SortbyField;
    /** @type {boolean} */
    SortAsc;
}
export class KendoItem {
    /** @param {{category?:string,values?:{ [index: string]: number; },group?:string,tooltip?:string,Dimensions?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    category;
    /** @type {{ [index: string]: number; }} */
    values;
    /** @type {string} */
    group;
    /** @type {string} */
    tooltip;
    /** @type {{ [index: string]: string; }} */
    Dimensions;
}
export class GetDashboardData {
    /** @param {{Controls?:DashBoardControl[],LayoutTemplateName?:string,GroupBy?:string,MetricNames?:MetricItemDTO[],ErrorMessage?:string,NeedsGrouping?:boolean,IsDrillDown?:boolean,DateItems?:KendoItem[],NonDateItems?:KendoItem[],TotalsItem?:KendoItem,MapDataTable?:string[][],IsMapRequest?:boolean,SeriesSources?:{ [index: string]: string[]; },StatusCode?:number,SuppressMultipleSeries?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DashBoardControl[]} */
    Controls;
    /** @type {string} */
    LayoutTemplateName;
    /** @type {string} */
    GroupBy;
    /** @type {MetricItemDTO[]} */
    MetricNames;
    /** @type {string} */
    ErrorMessage;
    /** @type {boolean} */
    NeedsGrouping;
    /** @type {boolean} */
    IsDrillDown;
    /** @type {KendoItem[]} */
    DateItems;
    /** @type {KendoItem[]} */
    NonDateItems;
    /** @type {KendoItem} */
    TotalsItem;
    /** @type {string[][]} */
    MapDataTable;
    /** @type {boolean} */
    IsMapRequest;
    /** @type {{ [index: string]: string[]; }} */
    SeriesSources;
    /** @type {number} */
    StatusCode;
    /** @type {boolean} */
    SuppressMultipleSeries;
}

JavaScript MapDataRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /RestApi/Sitefinity/Analytics/GetMapData HTTP/1.1 
Host: www.asg.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'MapDataRequest' using the custom 'csv' filter}One or more errors occurred.

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Controls":[{"ControlType":"String","attributes":{"String":"String"},"PlaceholderId":"String","DisplayName":"String","Series":[{"MainMetric":{"Name":"String","DisplayName":"String","Value":0,"Unit":"String","DenominatorMetricName":"String","NominatorMetricName":"String","ShowInSelector":false},"CategoryFormat":"String","Batch":false,"IsCategory":false,"SeriesName":"String","SeriesDimensions":[{}],"RelatedDimension":"String"}],"DimensionName":"String","RelatedDimension":["String"],"SortbyField":"String","SortAsc":false}],"LayoutTemplateName":"String","GroupBy":"String","MetricNames":[{"Name":"String","DisplayName":"String","Value":0,"Unit":"String","DenominatorMetricName":"String","NominatorMetricName":"String","ShowInSelector":false}],"ErrorMessage":"String","NeedsGrouping":false,"IsDrillDown":false,"DateItems":[{"category":"String","values":{"String":0},"group":"String","tooltip":"String","Dimensions":{"String":"String"}}],"NonDateItems":[{"category":"String","values":{"String":0},"group":"String","tooltip":"String","Dimensions":{"String":"String"}}],"TotalsItem":{"category":"String","values":{"String":0},"group":"String","tooltip":"String","Dimensions":{"String":"String"}},"MapDataTable":[["String"]],"IsMapRequest":false,"SeriesSources":{"String":["String"]},"StatusCode":0,"SuppressMultipleSeries":false}