DigiOffice API Services Services

<back to all web services

GetAnalyticsReports

namespace ServiceStack.Admin

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type RequestSummary() = 
        [<DataMember(Order=1)>]
        member val Name:String = null with get,set

        [<DataMember(Order=2)>]
        member val TotalRequests:Int64 = new Int64() with get,set

        [<DataMember(Order=3)>]
        member val TotalRequestLength:Int64 = new Int64() with get,set

        [<DataMember(Order=4)>]
        member val MinRequestLength:Int64 = new Int64() with get,set

        [<DataMember(Order=5)>]
        member val MaxRequestLength:Int64 = new Int64() with get,set

        [<DataMember(Order=6)>]
        member val TotalDuration:Double = new Double() with get,set

        [<DataMember(Order=7)>]
        member val MinDuration:Double = new Double() with get,set

        [<DataMember(Order=8)>]
        member val MaxDuration:Double = new Double() with get,set

        [<DataMember(Order=9)>]
        member val Status:Dictionary<Int32, Int64> = null with get,set

        [<DataMember(Order=10)>]
        member val Durations:Dictionary<String, Int64> = null with get,set

        [<DataMember(Order=11)>]
        member val Apis:Dictionary<String, Int64> = null with get,set

        [<DataMember(Order=12)>]
        member val Users:Dictionary<String, Int64> = null with get,set

        [<DataMember(Order=13)>]
        member val Ips:Dictionary<String, Int64> = null with get,set

        [<DataMember(Order=14)>]
        member val ApiKeys:Dictionary<String, Int64> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AnalyticsReports() = 
        [<DataMember(Order=1)>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember(Order=2)>]
        member val Created:DateTime = new DateTime() with get,set

        [<DataMember(Order=3)>]
        member val Version:Decimal = new Decimal() with get,set

        [<DataMember(Order=4)>]
        member val Apis:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=5)>]
        member val Users:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=6)>]
        member val Tags:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=7)>]
        member val Status:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=8)>]
        member val Days:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=9)>]
        member val ApiKeys:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=10)>]
        member val Ips:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=11)>]
        member val Browsers:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=12)>]
        member val Devices:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=13)>]
        member val Bots:Dictionary<String, RequestSummary> = null with get,set

        [<DataMember(Order=14)>]
        member val Durations:Dictionary<String, Int64> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetAnalyticsReportsResponse() = 
        [<DataMember(Order=1)>]
        member val Result:AnalyticsReports = null with get,set

        [<DataMember(Order=2)>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetAnalyticsReports() = 
        interface IGet
        [<DataMember(Order=1)>]
        member val Month:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=2)>]
        member val Filter:String = null with get,set

        [<DataMember(Order=3)>]
        member val Value:String = null with get,set

        [<DataMember(Order=4)>]
        member val Force:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# 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
		}
	}
}