<back to all web services

GetDashboardDataMessage

The following routes are available for this service:
All Verbs/RestApi/Sitefinity/Analytics/GetDashboardData
All Verbs/RestApi/GetDashboardData
GetDashboardDataMessage Parameters:
NameParameterData TypeRequiredDescription
DashboardIdqueryGuidNo
jsStartDatequerystringNo
jsEndDatequerystringNo
QueryStringFiltersqueryDictionary<string, string>No
StartDatequeryDateTimeNo
EndDatequeryDateTimeNo
GroupByquerystringNo
DimensionsqueryDictionary<string, string>No
MaxValuequerystringNo
SiteIdqueryGuidNo
GetDashboardData Parameters:
NameParameterData TypeRequiredDescription
ControlsformList<DashBoardControl>No
LayoutTemplateNameformstringNo
GroupByformstringNo
MetricNamesformList<MetricItemDTO>No
ErrorMessageformstringNo
NeedsGroupingformboolNo
IsDrillDownformboolNo
DateItemsformList<KendoItem>No
NonDateItemsformList<KendoItem>No
TotalsItemformKendoItemNo
MapDataTableformstring[]No
IsMapRequestformboolNo
SeriesSourcesformDictionary<string, List<String>>No
StatusCodeformintNo
SuppressMultipleSeriesformboolNo
DashBoardControl Parameters:
NameParameterData TypeRequiredDescription
ControlTypeformstringNo
attributesformDictionary<string, string>No
PlaceholderIdformstringNo
DisplayNameformstringNo
SeriesformList<SingleSerie>No
DimensionNameformstringNo
RelatedDimensionformList<string>No
SortbyFieldformstringNo
SortAscformboolNo
SingleSerie Parameters:
NameParameterData TypeRequiredDescription
MainMetricformMetricItemDTONo
CategoryFormatformstringNo
BatchformboolNo
IsCategoryformboolNo
SeriesNameformstringNo
SeriesDimensionsformList<DimensionItem>No
RelatedDimensionformstringNo
MetricItemDTO Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DisplayNameformstringNo
ValueformdoubleNo
UnitformstringNo
DenominatorMetricNameformstringNo
NominatorMetricNameformstringNo
ShowInSelectorformboolNo
DimensionItem Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
NameformstringNo
KendoItem Parameters:
NameParameterData TypeRequiredDescription
categoryformstringNo
valuesformDictionary<string, double>No
groupformstringNo
tooltipformstringNo
DimensionsformDictionary<string, string>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'GetDashboardDataMessage' using the custom 'other' filter}One or more errors occurred.
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}