| All Verbs | /RestApi/Sitefinity/Analytics/GetMapData | ||
|---|---|---|---|
| All Verbs | /RestApi/GetMapData |
namespace Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type MetricItemDTO() =
member val Name:String = null with get,set
member val DisplayName:String = null with get,set
member val Value:Double = new Double() with get,set
member val Unit:String = null with get,set
member val DenominatorMetricName:String = null with get,set
member val NominatorMetricName:String = null with get,set
member val ShowInSelector:Boolean = new Boolean() with get,set
type Dimension =
| Browser = 0
| BrowserVersion = 1
| City = 2
| Continent = 3
| VisitCount = 4
| Country = 5
| Date = 6
| Day = 7
| DaysSinceLastSession = 8
| FlashVersion = 9
| Hostname = 10
| Hour = 11
| DeviceCategory = 12
| JavaEnabled = 13
| Language = 14
| Latitude = 15
| Longitude = 16
| Month = 17
| NetworkDomain = 18
| NetworkLocation = 19
| PageDepth = 20
| OperatingSystem = 21
| OperatingSystemVersion = 22
| Region = 23
| ScreenColors = 24
| ScreenResolution = 25
| SubContinent = 26
| UserDefinedValue = 27
| UserType = 28
| Week = 29
| Year = 30
| AdContent = 31
| AdGroup = 32
| AdSlot = 33
| Campaign = 34
| Keyword = 35
| Medium = 36
| ReferralPath = 37
| Source = 38
| ExitPagePath = 39
| LandingPagePath = 40
| PagePath = 41
| PageTitle = 42
| Affiliation = 43
| DaysToTransaction = 44
| ProductCategory = 45
| ProductName = 46
| ProductSku = 47
| TransactionId = 48
| SearchCategory = 49
| SearchDestinationPage = 50
| SearchKeyword = 51
| SearchKeywordRefinement = 52
| SearchStartPage = 53
| SearchUsed = 54
| EventCategory = 55
| EventAction = 56
| EventLabel = 57
[<AllowNullLiteral>]
type MapDataRequest() =
member val DashboardId:Guid = new Guid() with get,set
member val RelatedDashboardId:Guid = new Guid() with get,set
member val Metrics:ResizeArray<MetricItemDTO> = new ResizeArray<MetricItemDTO>() with get,set
member val Filter:String = null with get,set
member val Dimension:Dimension = new Dimension() with get,set
member val jsStartDate:String = null with get,set
member val jsEndDate:String = null with get,set
member val SelectedMetric:String = null with get,set
member val Region:String = null with get,set
member val SiteId:Guid = new Guid() with get,set
member val StartDate:DateTime = new DateTime() with get,set
member val EndDate:DateTime = new DateTime() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type DimensionItem() =
[<DataMember>]
member val Value:String = null with get,set
[<DataMember>]
member val Name:String = null with get,set
[<AllowNullLiteral>]
type SingleSerie() =
member val MainMetric:MetricItemDTO = null with get,set
member val CategoryFormat:String = null with get,set
member val Batch:Boolean = new Boolean() with get,set
member val IsCategory:Boolean = new Boolean() with get,set
member val SeriesName:String = null with get,set
member val SeriesDimensions:ResizeArray<DimensionItem> = new ResizeArray<DimensionItem>() with get,set
member val RelatedDimension:String = null with get,set
[<AllowNullLiteral>]
type DashBoardControl() =
member val ControlType:String = null with get,set
member val attributes:Dictionary<String, String> = new Dictionary<String, String>() with get,set
member val PlaceholderId:String = null with get,set
member val DisplayName:String = null with get,set
member val Series:ResizeArray<SingleSerie> = new ResizeArray<SingleSerie>() with get,set
member val DimensionName:String = null with get,set
member val RelatedDimension:ResizeArray<String> = new ResizeArray<String>() with get,set
member val SortbyField:String = null with get,set
member val SortAsc:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type KendoItem() =
member val category:String = null with get,set
member val values:Dictionary<String, Double> = new Dictionary<String, Double>() with get,set
member val group:String = null with get,set
member val tooltip:String = null with get,set
member val Dimensions:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type GetDashboardData() =
member val Controls:ResizeArray<DashBoardControl> = new ResizeArray<DashBoardControl>() with get,set
member val LayoutTemplateName:String = null with get,set
member val GroupBy:String = null with get,set
member val MetricNames:ResizeArray<MetricItemDTO> = new ResizeArray<MetricItemDTO>() with get,set
member val ErrorMessage:String = null with get,set
member val NeedsGrouping:Boolean = new Boolean() with get,set
member val IsDrillDown:Boolean = new Boolean() with get,set
member val DateItems:ResizeArray<KendoItem> = new ResizeArray<KendoItem>() with get,set
member val NonDateItems:ResizeArray<KendoItem> = new ResizeArray<KendoItem>() with get,set
member val TotalsItem:KendoItem = null with get,set
member val MapDataTable:String[] = [||] with get,set
member val IsMapRequest:Boolean = new Boolean() with get,set
member val SeriesSources:Dictionary<String, List<String>> = new Dictionary<String, List<String>>() with get,set
member val StatusCode:Int32 = new Int32() with get,set
member val SuppressMultipleSeries:Boolean = new Boolean() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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}