DigiOffice API Services Services

<back to all web services

GetAnalyticsReports

import Foundation
import ServiceStack

// @DataContract
public class GetAnalyticsReports : IGet, Codable
{
    // @DataMember(Order=1)
    public var month:Date?

    // @DataMember(Order=2)
    public var filter:String

    // @DataMember(Order=3)
    public var value:String

    // @DataMember(Order=4)
    public var force:Bool?

    required public init(){}
}

// @DataContract
public class GetAnalyticsReportsResponse : Codable
{
    // @DataMember(Order=1)
    public var result:AnalyticsReports

    // @DataMember(Order=2)
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class AnalyticsReports : Codable
{
    // @DataMember(Order=1)
    public var id:Int

    // @DataMember(Order=2)
    public var created:Date

    // @DataMember(Order=3)
    public var version:Double

    // @DataMember(Order=4)
    public var apis:[String:RequestSummary]

    // @DataMember(Order=5)
    public var users:[String:RequestSummary]

    // @DataMember(Order=6)
    public var tags:[String:RequestSummary]

    // @DataMember(Order=7)
    public var status:[String:RequestSummary]

    // @DataMember(Order=8)
    public var days:[String:RequestSummary]

    // @DataMember(Order=9)
    public var apiKeys:[String:RequestSummary]

    // @DataMember(Order=10)
    public var ips:[String:RequestSummary]

    // @DataMember(Order=11)
    public var browsers:[String:RequestSummary]

    // @DataMember(Order=12)
    public var devices:[String:RequestSummary]

    // @DataMember(Order=13)
    public var bots:[String:RequestSummary]

    // @DataMember(Order=14)
    public var durations:[String:Int]

    required public init(){}
}

// @DataContract
public class RequestSummary : Codable
{
    // @DataMember(Order=1)
    public var name:String

    // @DataMember(Order=2)
    public var totalRequests:Int

    // @DataMember(Order=3)
    public var totalRequestLength:Int

    // @DataMember(Order=4)
    public var minRequestLength:Int

    // @DataMember(Order=5)
    public var maxRequestLength:Int

    // @DataMember(Order=6)
    public var totalDuration:Double

    // @DataMember(Order=7)
    public var minDuration:Double

    // @DataMember(Order=8)
    public var maxDuration:Double

    // @DataMember(Order=9)
    public var status:[Int:Int]

    // @DataMember(Order=10)
    public var durations:[String:Int]

    // @DataMember(Order=11)
    public var apis:[String:Int]

    // @DataMember(Order=12)
    public var users:[String:Int]

    // @DataMember(Order=13)
    public var ips:[String:Int]

    // @DataMember(Order=14)
    public var apiKeys:[String:Int]

    required public init(){}
}

Swift 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"}}}