DigiOffice API Services Services

<back to all web services

GetAnalyticsReports


// @DataContract
export class RequestSummary
{
    // @DataMember(Order=1)
    public Name: string;

    // @DataMember(Order=2)
    public TotalRequests: number;

    // @DataMember(Order=3)
    public TotalRequestLength: number;

    // @DataMember(Order=4)
    public MinRequestLength: number;

    // @DataMember(Order=5)
    public MaxRequestLength: number;

    // @DataMember(Order=6)
    public TotalDuration: number;

    // @DataMember(Order=7)
    public MinDuration: number;

    // @DataMember(Order=8)
    public MaxDuration: number;

    // @DataMember(Order=9)
    public Status: { [index:number]: number; };

    // @DataMember(Order=10)
    public Durations: { [index:string]: number; };

    // @DataMember(Order=11)
    public Apis: { [index:string]: number; };

    // @DataMember(Order=12)
    public Users: { [index:string]: number; };

    // @DataMember(Order=13)
    public Ips: { [index:string]: number; };

    // @DataMember(Order=14)
    public ApiKeys: { [index:string]: number; };

    public constructor(init?: Partial<RequestSummary>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AnalyticsReports
{
    // @DataMember(Order=1)
    public Id: number;

    // @DataMember(Order=2)
    public Created: string;

    // @DataMember(Order=3)
    public Version: number;

    // @DataMember(Order=4)
    public Apis: { [index:string]: RequestSummary; };

    // @DataMember(Order=5)
    public Users: { [index:string]: RequestSummary; };

    // @DataMember(Order=6)
    public Tags: { [index:string]: RequestSummary; };

    // @DataMember(Order=7)
    public Status: { [index:string]: RequestSummary; };

    // @DataMember(Order=8)
    public Days: { [index:string]: RequestSummary; };

    // @DataMember(Order=9)
    public ApiKeys: { [index:string]: RequestSummary; };

    // @DataMember(Order=10)
    public Ips: { [index:string]: RequestSummary; };

    // @DataMember(Order=11)
    public Browsers: { [index:string]: RequestSummary; };

    // @DataMember(Order=12)
    public Devices: { [index:string]: RequestSummary; };

    // @DataMember(Order=13)
    public Bots: { [index:string]: RequestSummary; };

    // @DataMember(Order=14)
    public Durations: { [index:string]: number; };

    public constructor(init?: Partial<AnalyticsReports>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAnalyticsReportsResponse
{
    // @DataMember(Order=1)
    public Result: AnalyticsReports;

    // @DataMember(Order=2)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetAnalyticsReportsResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAnalyticsReports implements IGet
{
    // @DataMember(Order=1)
    public Month?: string;

    // @DataMember(Order=2)
    public Filter: string;

    // @DataMember(Order=3)
    public Value: string;

    // @DataMember(Order=4)
    public Force?: boolean;

    public constructor(init?: Partial<GetAnalyticsReports>) { (Object as any).assign(this, init); }
}

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