Trendsic Platform Service

<back to all web services

DashboardStatsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/DashboardStats
"use strict";
export class DashboardItem {
    /** @param {{ID?:number,Date?:string,Title?:string,Message?:string,Author?:string,Hyperlink?:string,ThumbnailImage?:string,StartDate?:string,EndDate?:string,Type?:string,SortKey?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {?string} */
    Date;
    /** @type {string} */
    Title;
    /** @type {string} */
    Message;
    /** @type {string} */
    Author;
    /** @type {string} */
    Hyperlink;
    /** @type {string} */
    ThumbnailImage;
    /** @type {?string} */
    StartDate;
    /** @type {?string} */
    EndDate;
    /** @type {string} */
    Type;
    /** @type {number} */
    SortKey;
}
export class DashboardItemResponse {
    /** @param {{ResponseStatus?:ResponseStatus,GeneralMessages?:DashboardItem[],PersonCallouts?:DashboardItem[],TipOfTheWeek?:DashboardItem[],NewsAndNotes?:DashboardItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {DashboardItem[]} */
    GeneralMessages = [];
    /** @type {DashboardItem[]} */
    PersonCallouts = [];
    /** @type {DashboardItem[]} */
    TipOfTheWeek = [];
    /** @type {DashboardItem[]} */
    NewsAndNotes = [];
}
export class DashboardStatsRequest {
    /** @param {{AgentId?:number,MTDStartDate?:string,YTDStartDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    MTDStartDate;
    /** @type {string} */
    YTDStartDate;
    /** @type {string} */
    EndDate;
}

JavaScript DashboardStatsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/DashboardStats HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"GeneralMessages":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}],"PersonCallouts":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}],"TipOfTheWeek":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}],"NewsAndNotes":[{"ID":0,"Date":"0001-01-01T00:00:00.0000000","Title":"String","Message":"String","Author":"String","Hyperlink":"String","ThumbnailImage":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Type":"String","SortKey":0}]}