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