| All Verbs | /RestApi/Sitefinity/Analytics/GetMapData | ||
|---|---|---|---|
| All Verbs | /RestApi/GetMapData |
import java.math.*
import java.util.*
import net.servicestack.client.*
open class MapDataRequest
{
var DashboardId:UUID? = null
var RelatedDashboardId:UUID? = null
var Metrics:ArrayList<MetricItemDTO> = ArrayList<MetricItemDTO>()
var Filter:String? = null
var Dimension:Dimension? = null
var jsStartDate:String? = null
var jsEndDate:String? = null
var SelectedMetric:String? = null
var Region:String? = null
var SiteId:UUID? = null
var StartDate:Date? = null
var EndDate:Date? = null
}
open class MetricItemDTO
{
var Name:String? = null
var DisplayName:String? = null
var Value:Double? = null
var Unit:String? = null
var DenominatorMetricName:String? = null
var NominatorMetricName:String? = null
var ShowInSelector:Boolean? = null
}
enum class Dimension
{
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,
}
open class GetDashboardData
{
var Controls:ArrayList<DashBoardControl> = ArrayList<DashBoardControl>()
var LayoutTemplateName:String? = null
var GroupBy:String? = null
var MetricNames:ArrayList<MetricItemDTO> = ArrayList<MetricItemDTO>()
var ErrorMessage:String? = null
var NeedsGrouping:Boolean? = null
var IsDrillDown:Boolean? = null
var DateItems:ArrayList<KendoItem> = ArrayList<KendoItem>()
var NonDateItems:ArrayList<KendoItem> = ArrayList<KendoItem>()
var TotalsItem:KendoItem? = null
var MapDataTable:ArrayList<String>? = null
var IsMapRequest:Boolean? = null
var SeriesSources:HashMap<String,ArrayList<String>> = HashMap<String,ArrayList<String>>()
var StatusCode:Int? = null
var SuppressMultipleSeries:Boolean? = null
}
open class DashBoardControl
{
var ControlType:String? = null
var attributes:HashMap<String,String> = HashMap<String,String>()
var PlaceholderId:String? = null
var DisplayName:String? = null
var Series:ArrayList<SingleSerie> = ArrayList<SingleSerie>()
var DimensionName:String? = null
var RelatedDimension:ArrayList<String> = ArrayList<String>()
var SortbyField:String? = null
var SortAsc:Boolean? = null
}
open class SingleSerie
{
var MainMetric:MetricItemDTO? = null
var CategoryFormat:String? = null
var Batch:Boolean? = null
var IsCategory:Boolean? = null
var SeriesName:String? = null
var SeriesDimensions:ArrayList<DimensionItem> = ArrayList<DimensionItem>()
var RelatedDimension:String? = null
}
@DataContract
open class DimensionItem
{
@DataMember
var Value:String? = null
@DataMember
var Name:String? = null
}
open class KendoItem
{
var category:String? = null
var values:HashMap<String,Double> = HashMap<String,Double>()
var group:String? = null
var tooltip:String? = null
var Dimensions:HashMap<String,String> = HashMap<String,String>()
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>