GetDashboardDataMessage

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDashboardDataMessage:
    dashboard_id: Optional[str] = None
    js_start_date: Optional[str] = None
    js_end_date: Optional[str] = None
    query_string_filters: Optional[Dict[str, str]] = None
    start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    group_by: Optional[str] = None
    dimensions: Optional[Dict[str, str]] = None
    max_value: Optional[str] = None
    site_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MetricItemDTO:
    name: Optional[str] = None
    display_name: Optional[str] = None
    value: float = 0.0
    unit: Optional[str] = None
    denominator_metric_name: Optional[str] = None
    nominator_metric_name: Optional[str] = None
    show_in_selector: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DimensionItem:
    value: Optional[str] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SingleSerie:
    main_metric: Optional[MetricItemDTO] = None
    category_format: Optional[str] = None
    batch: bool = False
    is_category: bool = False
    series_name: Optional[str] = None
    series_dimensions: Optional[List[DimensionItem]] = None
    related_dimension: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashBoardControl:
    control_type: Optional[str] = None
    attributes: Optional[Dict[str, str]] = None
    placeholder_id: Optional[str] = None
    display_name: Optional[str] = None
    series: Optional[List[SingleSerie]] = None
    dimension_name: Optional[str] = None
    related_dimension: Optional[List[str]] = None
    sortby_field: Optional[str] = None
    sort_asc: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KendoItem:
    category: Optional[str] = None
    values: Optional[Dict[str, float]] = None
    group: Optional[str] = None
    tooltip: Optional[str] = None
    dimensions: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDashboardData:
    controls: Optional[List[DashBoardControl]] = None
    layout_template_name: Optional[str] = None
    group_by: Optional[str] = None
    metric_names: Optional[List[MetricItemDTO]] = None
    error_message: Optional[str] = None
    needs_grouping: bool = False
    is_drill_down: bool = False
    date_items: Optional[List[KendoItem]] = None
    non_date_items: Optional[List[KendoItem]] = None
    totals_item: Optional[KendoItem] = None
    map_data_table: Optional[List[str]] = None
    is_map_request: bool = False
    series_sources: Optional[Dict[str, List[str]]] = None
    status_code: int = 0
    suppress_multiple_series: bool = False

Python GetDashboardDataMessage DTOs

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}