DigiOffice API Services Services

<back to all web services

GetAnalyticsReports

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ServiceStack.Admin;

namespace ServiceStack.Admin
{
    [DataContract]
    public partial class AnalyticsReports
    {
        [DataMember(Order=1)]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        public virtual DateTime Created { get; set; }

        [DataMember(Order=3)]
        public virtual decimal Version { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, RequestSummary> Apis { get; set; }

        [DataMember(Order=5)]
        public virtual Dictionary<string, RequestSummary> Users { get; set; }

        [DataMember(Order=6)]
        public virtual Dictionary<string, RequestSummary> Tags { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, RequestSummary> Status { get; set; }

        [DataMember(Order=8)]
        public virtual Dictionary<string, RequestSummary> Days { get; set; }

        [DataMember(Order=9)]
        public virtual Dictionary<string, RequestSummary> ApiKeys { get; set; }

        [DataMember(Order=10)]
        public virtual Dictionary<string, RequestSummary> Ips { get; set; }

        [DataMember(Order=11)]
        public virtual Dictionary<string, RequestSummary> Browsers { get; set; }

        [DataMember(Order=12)]
        public virtual Dictionary<string, RequestSummary> Devices { get; set; }

        [DataMember(Order=13)]
        public virtual Dictionary<string, RequestSummary> Bots { get; set; }

        [DataMember(Order=14)]
        public virtual Dictionary<string, long> Durations { get; set; }
    }

    [DataContract]
    public partial class GetAnalyticsReports
        : IGet
    {
        [DataMember(Order=1)]
        public virtual DateTime? Month { get; set; }

        [DataMember(Order=2)]
        public virtual string Filter { get; set; }

        [DataMember(Order=3)]
        public virtual string Value { get; set; }

        [DataMember(Order=4)]
        public virtual bool? Force { get; set; }
    }

    [DataContract]
    public partial class GetAnalyticsReportsResponse
    {
        [DataMember(Order=1)]
        public virtual AnalyticsReports Result { get; set; }

        [DataMember(Order=2)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class RequestSummary
    {
        [DataMember(Order=1)]
        public virtual string Name { get; set; }

        [DataMember(Order=2)]
        public virtual long TotalRequests { get; set; }

        [DataMember(Order=3)]
        public virtual long TotalRequestLength { get; set; }

        [DataMember(Order=4)]
        public virtual long MinRequestLength { get; set; }

        [DataMember(Order=5)]
        public virtual long MaxRequestLength { get; set; }

        [DataMember(Order=6)]
        public virtual double TotalDuration { get; set; }

        [DataMember(Order=7)]
        public virtual double MinDuration { get; set; }

        [DataMember(Order=8)]
        public virtual double MaxDuration { get; set; }

        [DataMember(Order=9)]
        public virtual Dictionary<int, long> Status { get; set; }

        [DataMember(Order=10)]
        public virtual Dictionary<string, long> Durations { get; set; }

        [DataMember(Order=11)]
        public virtual Dictionary<string, long> Apis { get; set; }

        [DataMember(Order=12)]
        public virtual Dictionary<string, long> Users { get; set; }

        [DataMember(Order=13)]
        public virtual Dictionary<string, long> Ips { get; set; }

        [DataMember(Order=14)]
        public virtual Dictionary<string, long> ApiKeys { get; set; }
    }

}

C# GetAnalyticsReports DTOs

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: test-do-services.klokgroep.nl 
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
		}
	}
}