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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<MapDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Infrastructure.Services.ServiceStackServices.Model">
  <DashboardId>00000000-0000-0000-0000-000000000000</DashboardId>
  <Dimension>Browser</Dimension>
  <Filter>String</Filter>
  <Metrics xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO">
    <d2p1:MetricItemDTO>
      <d2p1:DenominatorMetricName>String</d2p1:DenominatorMetricName>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NominatorMetricName>String</d2p1:NominatorMetricName>
      <d2p1:ShowInSelector>false</d2p1:ShowInSelector>
      <d2p1:Unit>String</d2p1:Unit>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:MetricItemDTO>
  </Metrics>
  <Region>String</Region>
  <RelatedDashboardId>00000000-0000-0000-0000-000000000000</RelatedDashboardId>
  <SelectedMetric>String</SelectedMetric>
  <SiteId>00000000-0000-0000-0000-000000000000</SiteId>
  <jsEndDate>String</jsEndDate>
  <jsStartDate>String</jsStartDate>
</MapDataRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDashboardData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Infrastructure.Services.ServiceStackServices.Model">
  <Controls xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO">
    <d2p1:DashBoardControl>
      <d2p1:ControlType>String</d2p1:ControlType>
      <d2p1:DimensionName>String</d2p1:DimensionName>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:PlaceholderId>String</d2p1:PlaceholderId>
      <d2p1:RelatedDimension xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:RelatedDimension>
      <d2p1:Series>
        <d2p1:SingleSerie>
          <d2p1:Batch>false</d2p1:Batch>
          <d2p1:CategoryFormat>String</d2p1:CategoryFormat>
          <d2p1:IsCategory>false</d2p1:IsCategory>
          <d2p1:MainMetric>
            <d2p1:DenominatorMetricName>String</d2p1:DenominatorMetricName>
            <d2p1:DisplayName>String</d2p1:DisplayName>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:NominatorMetricName>String</d2p1:NominatorMetricName>
            <d2p1:ShowInSelector>false</d2p1:ShowInSelector>
            <d2p1:Unit>String</d2p1:Unit>
            <d2p1:Value>0</d2p1:Value>
          </d2p1:MainMetric>
          <d2p1:RelatedDimension>String</d2p1:RelatedDimension>
          <d2p1:SeriesDimensions>
            <d2p1:DimensionItem i:nil="true" />
          </d2p1:SeriesDimensions>
          <d2p1:SeriesName>String</d2p1:SeriesName>
        </d2p1:SingleSerie>
      </d2p1:Series>
      <d2p1:SortAsc>false</d2p1:SortAsc>
      <d2p1:SortbyField>String</d2p1:SortbyField>
      <d2p1:attributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:attributes>
    </d2p1:DashBoardControl>
  </Controls>
  <DateItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO">
    <d2p1:KendoItem>
      <d2p1:Dimensions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Dimensions>
      <d2p1:category>String</d2p1:category>
      <d2p1:group>String</d2p1:group>
      <d2p1:tooltip>String</d2p1:tooltip>
      <d2p1:values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringdouble>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:KeyValueOfstringdouble>
      </d2p1:values>
    </d2p1:KendoItem>
  </DateItems>
  <ErrorMessage>String</ErrorMessage>
  <GroupBy>String</GroupBy>
  <IsDrillDown>false</IsDrillDown>
  <IsMapRequest>false</IsMapRequest>
  <LayoutTemplateName>String</LayoutTemplateName>
  <MapDataTable xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfstring>
      <d2p1:string>String</d2p1:string>
    </d2p1:ArrayOfstring>
  </MapDataTable>
  <MetricNames xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO">
    <d2p1:MetricItemDTO>
      <d2p1:DenominatorMetricName>String</d2p1:DenominatorMetricName>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NominatorMetricName>String</d2p1:NominatorMetricName>
      <d2p1:ShowInSelector>false</d2p1:ShowInSelector>
      <d2p1:Unit>String</d2p1:Unit>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:MetricItemDTO>
  </MetricNames>
  <NeedsGrouping>false</NeedsGrouping>
  <NonDateItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO">
    <d2p1:KendoItem>
      <d2p1:Dimensions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Dimensions>
      <d2p1:category>String</d2p1:category>
      <d2p1:group>String</d2p1:group>
      <d2p1:tooltip>String</d2p1:tooltip>
      <d2p1:values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringdouble>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:KeyValueOfstringdouble>
      </d2p1:values>
    </d2p1:KendoItem>
  </NonDateItems>
  <SeriesSources xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>String</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </SeriesSources>
  <StatusCode>0</StatusCode>
  <SuppressMultipleSeries>false</SuppressMultipleSeries>
  <TotalsItem xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO">
    <d2p1:Dimensions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Dimensions>
    <d2p1:category>String</d2p1:category>
    <d2p1:group>String</d2p1:group>
    <d2p1:tooltip>String</d2p1:tooltip>
    <d2p1:values xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringdouble>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>0</d3p1:Value>
      </d3p1:KeyValueOfstringdouble>
    </d2p1:values>
  </TotalsItem>
</GetDashboardData>