YM REST Services

DashboardData

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/DashboardData	Return a data array of counts by day.

**DashboardData** Parameters:
Name	Parameter	Data Type	Required
BeginDate	query	DateTime	No
EndDate	query	DateTime	No
Interval	query	DashboardInterval	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**DashboardDataResponse** Parameters:
Name	Parameter	Data Type	Required
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

**DashboardDataItem** Parameters:
Name	Parameter	Data Type	Required
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DashboardDataList: 
	[
		{
			Date: 0001-01-01,
			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-01,
	EndDate: 0001-01-01,
	Interval: Day,
	UsingRedis: True,
	AppInitTime: 2024-05-03T08:16:06.0376213-04:00,
	ServerID: WS-5-31-738,
	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-03T08:41:47.3803972-04:00,
	Device: Desktop
}