Requires any of the roles: | admin, oauthadmin |
GET | /Ams/{ClientID}/DashboardData | Return a data array of counts by day. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BeginDate | query | DateTime | No | |
EndDate | query | DateTime | No | |
Interval | query | DashboardInterval | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UsingRedis | form | bool | No | |
AppInitTime | form | DateTime | No | |
ServerID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientID | form | int | No | |
ResponseStatus | form | ResponseStatus | No | |
BypassCache | form | bool | No | |
DateCached | form | DateTime | No | |
Device | form | Device | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DashboardDataList | form | List<DashboardDataItem> | No | |
PostCount | form | int | No | |
CommentCount | form | int | No | |
LikeCount | form | int | No | |
ShareCount | form | int | No | |
ConnectionCount | form | int | No | |
LoginCount | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Date | form | DateTime | No | |
PostCount | form | int | No | |
CommentCount | form | int | No | |
LikeCount | form | int | No | |
ShareCount | form | int | No | |
ConnectionCount | form | int | No | |
LoginCount | form | int | No |
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
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":"2025-01-15T06:19:47.4297411-05:00","ServerID":"WS-6-56-398","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":"2025-01-15T08:33:44.1756062-05:00","Device":"Desktop"}