DigiOffice API Services Services

<back to all web services

GetAnalyticsReports

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract
open class GetAnalyticsReports : IGet
{
    @DataMember(Order=1)
    open var Month:Date? = null

    @DataMember(Order=2)
    open var Filter:String? = null

    @DataMember(Order=3)
    open var Value:String? = null

    @DataMember(Order=4)
    open var Force:Boolean? = null
}

@DataContract
open class GetAnalyticsReportsResponse
{
    @DataMember(Order=1)
    open var Result:AnalyticsReports? = null

    @DataMember(Order=2)
    open var ResponseStatus:ResponseStatus? = null
}

@DataContract
open class AnalyticsReports
{
    @DataMember(Order=1)
    open var Id:Long? = null

    @DataMember(Order=2)
    open var Created:Date? = null

    @DataMember(Order=3)
    open var Version:BigDecimal? = null

    @DataMember(Order=4)
    open var Apis:HashMap<String,RequestSummary>? = null

    @DataMember(Order=5)
    open var Users:HashMap<String,RequestSummary>? = null

    @DataMember(Order=6)
    open var Tags:HashMap<String,RequestSummary>? = null

    @DataMember(Order=7)
    open var Status:HashMap<String,RequestSummary>? = null

    @DataMember(Order=8)
    open var Days:HashMap<String,RequestSummary>? = null

    @DataMember(Order=9)
    open var ApiKeys:HashMap<String,RequestSummary>? = null

    @DataMember(Order=10)
    open var Ips:HashMap<String,RequestSummary>? = null

    @DataMember(Order=11)
    open var Browsers:HashMap<String,RequestSummary>? = null

    @DataMember(Order=12)
    open var Devices:HashMap<String,RequestSummary>? = null

    @DataMember(Order=13)
    open var Bots:HashMap<String,RequestSummary>? = null

    @DataMember(Order=14)
    open var Durations:HashMap<String,Long>? = null
}

@DataContract
open class RequestSummary
{
    @DataMember(Order=1)
    open var Name:String? = null

    @DataMember(Order=2)
    open var TotalRequests:Long? = null

    @DataMember(Order=3)
    open var TotalRequestLength:Long? = null

    @DataMember(Order=4)
    open var MinRequestLength:Long? = null

    @DataMember(Order=5)
    open var MaxRequestLength:Long? = null

    @DataMember(Order=6)
    open var TotalDuration:Double? = null

    @DataMember(Order=7)
    open var MinDuration:Double? = null

    @DataMember(Order=8)
    open var MaxDuration:Double? = null

    @DataMember(Order=9)
    open var Status:HashMap<Int,Long>? = null

    @DataMember(Order=10)
    open var Durations:HashMap<String,Long>? = null

    @DataMember(Order=11)
    open var Apis:HashMap<String,Long>? = null

    @DataMember(Order=12)
    open var Users:HashMap<String,Long>? = null

    @DataMember(Order=13)
    open var Ips:HashMap<String,Long>? = null

    @DataMember(Order=14)
    open var ApiKeys:HashMap<String,Long>? = null
}

Kotlin GetAnalyticsReports DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GetAnalyticsReports HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Month":"0001-01-01T00:00:00.0000000","Filter":"String","Value":"String","Force":false}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Result":{"Id":0,"Created":"0001-01-01T00:00:00.0000000","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"}}}