GetDashboardDataMessage

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

"use strict";
export class GetDashboardDataMessage {
    /** @param {{DashboardId?:string,jsStartDate?:string,jsEndDate?:string,QueryStringFilters?:{ [index: string]: string; },StartDate?:string,EndDate?:string,GroupBy?:string,Dimensions?:{ [index: string]: string; },MaxValue?:string,SiteId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DashboardId;
    /** @type {string} */
    jsStartDate;
    /** @type {string} */
    jsEndDate;
    /** @type {{ [index: string]: string; }} */
    QueryStringFilters;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
    /** @type {string} */
    GroupBy;
    /** @type {{ [index: string]: string; }} */
    Dimensions;
    /** @type {string} */
    MaxValue;
    /** @type {string} */
    SiteId;
}
export class MetricItemDTO {
    /** @param {{Name?:string,DisplayName?:string,Value?:number,Unit?:string,DenominatorMetricName?:string,NominatorMetricName?:string,ShowInSelector?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    DisplayName;
    /** @type {number} */
    Value;
    /** @type {string} */
    Unit;
    /** @type {string} */
    DenominatorMetricName;
    /** @type {string} */
    NominatorMetricName;
    /** @type {boolean} */
    ShowInSelector;
}
export class DimensionItem {
    /** @param {{Value?:string,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Value;
    /** @type {string} */
    Name;
}
export class SingleSerie {
    /** @param {{MainMetric?:MetricItemDTO,CategoryFormat?:string,Batch?:boolean,IsCategory?:boolean,SeriesName?:string,SeriesDimensions?:DimensionItem[],RelatedDimension?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {MetricItemDTO} */
    MainMetric;
    /** @type {string} */
    CategoryFormat;
    /** @type {boolean} */
    Batch;
    /** @type {boolean} */
    IsCategory;
    /** @type {string} */
    SeriesName;
    /** @type {DimensionItem[]} */
    SeriesDimensions;
    /** @type {string} */
    RelatedDimension;
}
export class DashBoardControl {
    /** @param {{ControlType?:string,attributes?:{ [index: string]: string; },PlaceholderId?:string,DisplayName?:string,Series?:SingleSerie[],DimensionName?:string,RelatedDimension?:string[],SortbyField?:string,SortAsc?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ControlType;
    /** @type {{ [index: string]: string; }} */
    attributes;
    /** @type {string} */
    PlaceholderId;
    /** @type {string} */
    DisplayName;
    /** @type {SingleSerie[]} */
    Series;
    /** @type {string} */
    DimensionName;
    /** @type {string[]} */
    RelatedDimension;
    /** @type {string} */
    SortbyField;
    /** @type {boolean} */
    SortAsc;
}
export class KendoItem {
    /** @param {{category?:string,values?:{ [index: string]: number; },group?:string,tooltip?:string,Dimensions?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    category;
    /** @type {{ [index: string]: number; }} */
    values;
    /** @type {string} */
    group;
    /** @type {string} */
    tooltip;
    /** @type {{ [index: string]: string; }} */
    Dimensions;
}
export class GetDashboardData {
    /** @param {{Controls?:DashBoardControl[],LayoutTemplateName?:string,GroupBy?:string,MetricNames?:MetricItemDTO[],ErrorMessage?:string,NeedsGrouping?:boolean,IsDrillDown?:boolean,DateItems?:KendoItem[],NonDateItems?:KendoItem[],TotalsItem?:KendoItem,MapDataTable?:string[][],IsMapRequest?:boolean,SeriesSources?:{ [index: string]: string[]; },StatusCode?:number,SuppressMultipleSeries?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DashBoardControl[]} */
    Controls;
    /** @type {string} */
    LayoutTemplateName;
    /** @type {string} */
    GroupBy;
    /** @type {MetricItemDTO[]} */
    MetricNames;
    /** @type {string} */
    ErrorMessage;
    /** @type {boolean} */
    NeedsGrouping;
    /** @type {boolean} */
    IsDrillDown;
    /** @type {KendoItem[]} */
    DateItems;
    /** @type {KendoItem[]} */
    NonDateItems;
    /** @type {KendoItem} */
    TotalsItem;
    /** @type {string[][]} */
    MapDataTable;
    /** @type {boolean} */
    IsMapRequest;
    /** @type {{ [index: string]: string[]; }} */
    SeriesSources;
    /** @type {number} */
    StatusCode;
    /** @type {boolean} */
    SuppressMultipleSeries;
}

JavaScript GetDashboardDataMessage DTOs

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

HTTP + CSV

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/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}