<back to all web services

GetDashboardDataMessage

export class GetDashboardDataMessage
{
    public DashboardId: string;
    public jsStartDate: string;
    public jsEndDate: string;
    public QueryStringFilters: { [index: string]: string; };
    public StartDate: string;
    public EndDate: string;
    public GroupBy: string;
    public Dimensions: { [index: string]: string; };
    public MaxValue: string;
    public SiteId: string;

    public constructor(init?: Partial<GetDashboardDataMessage>) { (Object as any).assign(this, init); }
}

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); }
}

// @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 GetDashboardDataMessage DTOs

POST /RestApi/Sitefinity/Analytics/GetDashboardData 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 'GetDashboardDataMessage' 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}