DigiOffice API Services Services

<back to all web services

GetAnalyticsReports

"use strict";
export class RequestSummary {
    /** @param {{Name?:string,TotalRequests?:number,TotalRequestLength?:number,MinRequestLength?:number,MaxRequestLength?:number,TotalDuration?:number,MinDuration?:number,MaxDuration?:number,Status?:{ [index:number]: number; },Durations?:{ [index:string]: number; },Apis?:{ [index:string]: number; },Users?:{ [index:string]: number; },Ips?:{ [index:string]: number; },ApiKeys?:{ [index:string]: number; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {number} */
    TotalRequests;
    /** @type {number} */
    TotalRequestLength;
    /** @type {number} */
    MinRequestLength;
    /** @type {number} */
    MaxRequestLength;
    /** @type {number} */
    TotalDuration;
    /** @type {number} */
    MinDuration;
    /** @type {number} */
    MaxDuration;
    /** @type {{ [index:number]: number; }} */
    Status;
    /** @type {{ [index:string]: number; }} */
    Durations;
    /** @type {{ [index:string]: number; }} */
    Apis;
    /** @type {{ [index:string]: number; }} */
    Users;
    /** @type {{ [index:string]: number; }} */
    Ips;
    /** @type {{ [index:string]: number; }} */
    ApiKeys;
}
export class AnalyticsReports {
    /** @param {{Id?:number,Created?:string,Version?:number,Apis?:{ [index:string]: RequestSummary; },Users?:{ [index:string]: RequestSummary; },Tags?:{ [index:string]: RequestSummary; },Status?:{ [index:string]: RequestSummary; },Days?:{ [index:string]: RequestSummary; },ApiKeys?:{ [index:string]: RequestSummary; },Ips?:{ [index:string]: RequestSummary; },Browsers?:{ [index:string]: RequestSummary; },Devices?:{ [index:string]: RequestSummary; },Bots?:{ [index:string]: RequestSummary; },Durations?:{ [index:string]: number; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Created;
    /** @type {number} */
    Version;
    /** @type {{ [index:string]: RequestSummary; }} */
    Apis;
    /** @type {{ [index:string]: RequestSummary; }} */
    Users;
    /** @type {{ [index:string]: RequestSummary; }} */
    Tags;
    /** @type {{ [index:string]: RequestSummary; }} */
    Status;
    /** @type {{ [index:string]: RequestSummary; }} */
    Days;
    /** @type {{ [index:string]: RequestSummary; }} */
    ApiKeys;
    /** @type {{ [index:string]: RequestSummary; }} */
    Ips;
    /** @type {{ [index:string]: RequestSummary; }} */
    Browsers;
    /** @type {{ [index:string]: RequestSummary; }} */
    Devices;
    /** @type {{ [index:string]: RequestSummary; }} */
    Bots;
    /** @type {{ [index:string]: number; }} */
    Durations;
}
export class GetAnalyticsReportsResponse {
    /** @param {{Result?:AnalyticsReports,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AnalyticsReports} */
    Result;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetAnalyticsReports {
    /** @param {{Month?:string,Filter?:string,Value?:string,Force?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    Month;
    /** @type {string} */
    Filter;
    /** @type {string} */
    Value;
    /** @type {?boolean} */
    Force;
}

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