Blazor Diffusion

<back to all web services

GetAnalyticsReports

GetAnalyticsReports Parameters:
NameParameterData TypeRequiredDescription
MonthqueryDateTime?No
FilterquerystringNo
ValuequerystringNo
Forcequerybool?No
GetAnalyticsReportsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformAnalyticsReportsNo
ResponseStatusformResponseStatusNo
AnalyticsReports Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
CreatedformDateTimeNo
VersionformdecimalNo
ApisformDictionary<string, RequestSummary>No
UsersformDictionary<string, RequestSummary>No
TagsformDictionary<string, RequestSummary>No
StatusformDictionary<string, RequestSummary>No
DaysformDictionary<string, RequestSummary>No
ApiKeysformDictionary<string, RequestSummary>No
IpsformDictionary<string, RequestSummary>No
BrowsersformDictionary<string, RequestSummary>No
DevicesformDictionary<string, RequestSummary>No
BotsformDictionary<string, RequestSummary>No
DurationsformDictionary<string, long>No
RequestSummary Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TotalRequestsformlongNo
TotalRequestLengthformlongNo
MinRequestLengthformlongNo
MaxRequestLengthformlongNo
TotalDurationformdoubleNo
MinDurationformdoubleNo
MaxDurationformdoubleNo
StatusformDictionary<int, long>No
DurationsformDictionary<string, long>No
ApisformDictionary<string, long>No
UsersformDictionary<string, long>No
IpsformDictionary<string, long>No
ApiKeysformDictionary<string, long>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.

POST /jsv/reply/GetAnalyticsReports HTTP/1.1 
Host: blazordiffusion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	month: 0001-01-01,
	filter: String,
	value: String,
	force: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		id: 0,
		created: 0001-01-01,
		version: 0,
		apis: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		users: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		tags: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		status: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		days: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		apiKeys: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		ips: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		browsers: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		devices: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		bots: 
		{
			String: 
			{
				name: String,
				totalRequests: 0,
				totalRequestLength: 0,
				minRequestLength: 0,
				maxRequestLength: 0,
				totalDuration: 0,
				minDuration: 0,
				maxDuration: 0,
				status: 
				{
					0: 0
				},
				durations: 
				{
					String: 0
				},
				apis: 
				{
					String: 0
				},
				users: 
				{
					String: 0
				},
				ips: 
				{
					String: 0
				},
				apiKeys: 
				{
					String: 0
				}
			}
		},
		durations: 
		{
			String: 0
		}
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}