GetDashboardDataMessage

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

import Foundation
import ServiceStack

public class GetDashboardDataMessage : Codable
{
    public var dashboardId:String
    public var jsStartDate:String
    public var jsEndDate:String
    public var queryStringFilters:[String:String] = [:]
    public var startDate:Date
    public var endDate:Date
    public var groupBy:String
    public var dimensions:[String:String] = [:]
    public var maxValue:String
    public var siteId:String

    required public init(){}
}

public class GetDashboardData : Codable
{
    public var controls:[DashBoardControl] = []
    public var layoutTemplateName:String
    public var groupBy:String
    public var metricNames:[MetricItemDTO] = []
    public var errorMessage:String
    public var needsGrouping:Bool
    public var isDrillDown:Bool
    public var dateItems:[KendoItem] = []
    public var nonDateItems:[KendoItem] = []
    public var totalsItem:KendoItem
    public var mapDataTable:[[String]] = []
    public var isMapRequest:Bool
    public var seriesSources:[String:[String]] = [:]
    public var statusCode:Int
    public var suppressMultipleSeries:Bool

    required public init(){}
}

public class DashBoardControl : Codable
{
    public var controlType:String
    public var attributes:[String:String] = [:]
    public var placeholderId:String
    public var displayName:String
    public var series:[SingleSerie] = []
    public var dimensionName:String
    public var relatedDimension:[String] = []
    public var sortbyField:String
    public var sortAsc:Bool

    required public init(){}
}

public class SingleSerie : Codable
{
    public var mainMetric:MetricItemDTO
    public var categoryFormat:String
    public var batch:Bool
    public var isCategory:Bool
    public var seriesName:String
    public var seriesDimensions:[DimensionItem] = []
    public var relatedDimension:String

    required public init(){}
}

public class MetricItemDTO : Codable
{
    public var name:String
    public var displayName:String
    public var value:Double
    public var unit:String
    public var denominatorMetricName:String
    public var nominatorMetricName:String
    public var showInSelector:Bool

    required public init(){}
}

// @DataContract
public class DimensionItem : Codable
{
    // @DataMember
    public var value:String

    // @DataMember
    public var name:String

    required public init(){}
}

public class KendoItem : Codable
{
    public var category:String
    public var values:[String:Double] = [:]
    public var group:String
    public var tooltip:String
    public var dimensions:[String:String] = [:]

    required public init(){}
}

Swift GetDashboardDataMessage 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/GetDashboardData HTTP/1.1 
Host: www.asg.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDashboardDataMessage 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>
  <Dimensions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Dimensions>
  <GroupBy>String</GroupBy>
  <MaxValue>String</MaxValue>
  <QueryStringFilters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </QueryStringFilters>
  <SiteId>00000000-0000-0000-0000-000000000000</SiteId>
  <jsEndDate>String</jsEndDate>
  <jsStartDate>String</jsStartDate>
</GetDashboardDataMessage>

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>