YM REST Services

<back to all web services

DashboardData

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/DashboardDataReturn a data array of counts by day.
DashboardData Parameters:
NameParameterData TypeRequiredDescription
BeginDatequeryDateTimeNo
EndDatequeryDateTimeNo
IntervalqueryDashboardIntervalNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
DashboardDataResponse Parameters:
NameParameterData TypeRequiredDescription
DashboardDataListformList<DashboardDataItem>No
PostCountformintNo
CommentCountformintNo
LikeCountformintNo
ShareCountformintNo
ConnectionCountformintNo
LoginCountformintNo
DashboardDataItem Parameters:
NameParameterData TypeRequiredDescription
DateformDateTimeNo
PostCountformintNo
CommentCountformintNo
LikeCountformintNo
ShareCountformintNo
ConnectionCountformintNo
LoginCountformintNo

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 /Ams/{ClientID}/DashboardData HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DashboardDataList":[{"Date":"0001-01-01T00:00:00.0000000","PostCount":0,"CommentCount":0,"LikeCount":0,"ShareCount":0,"ConnectionCount":0,"LoginCount":0}],"PostCount":0,"CommentCount":0,"LikeCount":0,"ShareCount":0,"ConnectionCount":0,"LoginCount":0,"BeginDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Interval":"Day","UsingRedis":true,"AppInitTime":"2024-05-03T00:57:45.6092839-04:00","ServerID":"WS-5-59-079","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T03:14:00.8392193-04:00","Device":"Desktop"}