DigiOffice API Services Services

<back to all web services

GetAnalyticsReports

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
class RequestSummary implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var string|null */
        public ?string $Name=null,

        // @DataMember(Order=2)
        /** @var int */
        public int $TotalRequests=0,

        // @DataMember(Order=3)
        /** @var int */
        public int $TotalRequestLength=0,

        // @DataMember(Order=4)
        /** @var int */
        public int $MinRequestLength=0,

        // @DataMember(Order=5)
        /** @var int */
        public int $MaxRequestLength=0,

        // @DataMember(Order=6)
        /** @var float */
        public float $TotalDuration=0.0,

        // @DataMember(Order=7)
        /** @var float */
        public float $MinDuration=0.0,

        // @DataMember(Order=8)
        /** @var float */
        public float $MaxDuration=0.0,

        // @DataMember(Order=9)
        /** @var array<string,int>|null */
        public ?array $Status=null,

        // @DataMember(Order=10)
        /** @var array<string,int>|null */
        public ?array $Durations=null,

        // @DataMember(Order=11)
        /** @var array<string,int>|null */
        public ?array $Apis=null,

        // @DataMember(Order=12)
        /** @var array<string,int>|null */
        public ?array $Users=null,

        // @DataMember(Order=13)
        /** @var array<string,int>|null */
        public ?array $Ips=null,

        // @DataMember(Order=14)
        /** @var array<string,int>|null */
        public ?array $ApiKeys=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['TotalRequests'])) $this->TotalRequests = $o['TotalRequests'];
        if (isset($o['TotalRequestLength'])) $this->TotalRequestLength = $o['TotalRequestLength'];
        if (isset($o['MinRequestLength'])) $this->MinRequestLength = $o['MinRequestLength'];
        if (isset($o['MaxRequestLength'])) $this->MaxRequestLength = $o['MaxRequestLength'];
        if (isset($o['TotalDuration'])) $this->TotalDuration = $o['TotalDuration'];
        if (isset($o['MinDuration'])) $this->MinDuration = $o['MinDuration'];
        if (isset($o['MaxDuration'])) $this->MaxDuration = $o['MaxDuration'];
        if (isset($o['Status'])) $this->Status = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['int','int']), $o['Status']);
        if (isset($o['Durations'])) $this->Durations = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','int']), $o['Durations']);
        if (isset($o['Apis'])) $this->Apis = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','int']), $o['Apis']);
        if (isset($o['Users'])) $this->Users = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','int']), $o['Users']);
        if (isset($o['Ips'])) $this->Ips = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','int']), $o['Ips']);
        if (isset($o['ApiKeys'])) $this->ApiKeys = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','int']), $o['ApiKeys']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->TotalRequests)) $o['TotalRequests'] = $this->TotalRequests;
        if (isset($this->TotalRequestLength)) $o['TotalRequestLength'] = $this->TotalRequestLength;
        if (isset($this->MinRequestLength)) $o['MinRequestLength'] = $this->MinRequestLength;
        if (isset($this->MaxRequestLength)) $o['MaxRequestLength'] = $this->MaxRequestLength;
        if (isset($this->TotalDuration)) $o['TotalDuration'] = $this->TotalDuration;
        if (isset($this->MinDuration)) $o['MinDuration'] = $this->MinDuration;
        if (isset($this->MaxDuration)) $o['MaxDuration'] = $this->MaxDuration;
        if (isset($this->Status)) $o['Status'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['int','int']), $this->Status);
        if (isset($this->Durations)) $o['Durations'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','int']), $this->Durations);
        if (isset($this->Apis)) $o['Apis'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','int']), $this->Apis);
        if (isset($this->Users)) $o['Users'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','int']), $this->Users);
        if (isset($this->Ips)) $o['Ips'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','int']), $this->Ips);
        if (isset($this->ApiKeys)) $o['ApiKeys'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','int']), $this->ApiKeys);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class AnalyticsReports implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        /** @var DateTime */
        public DateTime $Created=new DateTime(),

        // @DataMember(Order=3)
        /** @var float */
        public float $Version=0.0,

        // @DataMember(Order=4)
        /** @var array<string,RequestSummary>|null */
        public ?array $Apis=null,

        // @DataMember(Order=5)
        /** @var array<string,RequestSummary>|null */
        public ?array $Users=null,

        // @DataMember(Order=6)
        /** @var array<string,RequestSummary>|null */
        public ?array $Tags=null,

        // @DataMember(Order=7)
        /** @var array<string,RequestSummary>|null */
        public ?array $Status=null,

        // @DataMember(Order=8)
        /** @var array<string,RequestSummary>|null */
        public ?array $Days=null,

        // @DataMember(Order=9)
        /** @var array<string,RequestSummary>|null */
        public ?array $ApiKeys=null,

        // @DataMember(Order=10)
        /** @var array<string,RequestSummary>|null */
        public ?array $Ips=null,

        // @DataMember(Order=11)
        /** @var array<string,RequestSummary>|null */
        public ?array $Browsers=null,

        // @DataMember(Order=12)
        /** @var array<string,RequestSummary>|null */
        public ?array $Devices=null,

        // @DataMember(Order=13)
        /** @var array<string,RequestSummary>|null */
        public ?array $Bots=null,

        // @DataMember(Order=14)
        /** @var array<string,int>|null */
        public ?array $Durations=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
        if (isset($o['Version'])) $this->Version = $o['Version'];
        if (isset($o['Apis'])) $this->Apis = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['Apis']);
        if (isset($o['Users'])) $this->Users = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['Users']);
        if (isset($o['Tags'])) $this->Tags = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['Tags']);
        if (isset($o['Status'])) $this->Status = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['Status']);
        if (isset($o['Days'])) $this->Days = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['Days']);
        if (isset($o['ApiKeys'])) $this->ApiKeys = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['ApiKeys']);
        if (isset($o['Ips'])) $this->Ips = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['Ips']);
        if (isset($o['Browsers'])) $this->Browsers = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['Browsers']);
        if (isset($o['Devices'])) $this->Devices = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['Devices']);
        if (isset($o['Bots'])) $this->Bots = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $o['Bots']);
        if (isset($o['Durations'])) $this->Durations = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','int']), $o['Durations']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
        if (isset($this->Version)) $o['Version'] = $this->Version;
        if (isset($this->Apis)) $o['Apis'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->Apis);
        if (isset($this->Users)) $o['Users'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->Users);
        if (isset($this->Tags)) $o['Tags'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->Tags);
        if (isset($this->Status)) $o['Status'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->Status);
        if (isset($this->Days)) $o['Days'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->Days);
        if (isset($this->ApiKeys)) $o['ApiKeys'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->ApiKeys);
        if (isset($this->Ips)) $o['Ips'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->Ips);
        if (isset($this->Browsers)) $o['Browsers'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->Browsers);
        if (isset($this->Devices)) $o['Devices'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->Devices);
        if (isset($this->Bots)) $o['Bots'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','RequestSummary']), $this->Bots);
        if (isset($this->Durations)) $o['Durations'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','int']), $this->Durations);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetAnalyticsReportsResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var AnalyticsReports|null */
        public ?AnalyticsReports $Result=null,

        // @DataMember(Order=2)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Result'])) $this->Result = JsonConverters::from('AnalyticsReports', $o['Result']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Result)) $o['Result'] = JsonConverters::to('AnalyticsReports', $this->Result);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetAnalyticsReports implements IGet, JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var DateTime|null */
        public ?DateTime $Month=null,

        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $Filter=null,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $Value=null,

        // @DataMember(Order=4)
        /** @var bool|null */
        public ?bool $Force=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Month'])) $this->Month = JsonConverters::from('DateTime', $o['Month']);
        if (isset($o['Filter'])) $this->Filter = $o['Filter'];
        if (isset($o['Value'])) $this->Value = $o['Value'];
        if (isset($o['Force'])) $this->Force = $o['Force'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Month)) $o['Month'] = JsonConverters::to('DateTime', $this->Month);
        if (isset($this->Filter)) $o['Filter'] = $this->Filter;
        if (isset($this->Value)) $o['Value'] = $this->Value;
        if (isset($this->Force)) $o['Force'] = $this->Force;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetAnalyticsReports DTOs

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

HTTP + OTHER

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

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

{"Month":"0001-01-01T00:00:00.0000000","Filter":"String","Value":"String","Force":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}