DigiOffice API Services Services

<back to all web services

GetAnalyticsInfo

GetAnalyticsInfo Parameters:
NameParameterData TypeRequiredDescription
MonthqueryDateTime?No
TypequerystringNo
OpquerystringNo
ApiKeyquerystringNo
UserIdquerystringNo
IpquerystringNo
GetAnalyticsInfoResponse Parameters:
NameParameterData TypeRequiredDescription
MonthsformList<string>No
ResultformAnalyticsLogInfoNo
ResponseStatusformResponseStatusNo
AnalyticsLogInfo Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DateTimeformDateTimeNo
BrowserformstringNo
DeviceformstringNo
BotformstringNo
OpformstringNo
UserIdformstringNo
UserNameformstringNo
ApiKeyformstringNo
IpformstringNo

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/GetAnalyticsInfo HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Month: 0001-01-01,
	Type: String,
	Op: String,
	ApiKey: String,
	UserId: String,
	Ip: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Months: 
	[
		String
	],
	Result: 
	{
		Id: 0,
		DateTime: 0001-01-01,
		Browser: String,
		Device: String,
		Bot: String,
		Op: String,
		UserId: String,
		UserName: String,
		ApiKey: String,
		Ip: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}