"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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/GetAnalyticsReports HTTP/1.1
Host: blazordiffusion.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetAnalyticsReports xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Month>0001-01-01T00:00:00</Month>
<Filter>String</Filter>
<Value>String</Value>
<Force>false</Force>
</GetAnalyticsReports>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetAnalyticsReportsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Result> <Id>0</Id> <Created>0001-01-01T00:00:00</Created> <Version>0</Version> <Apis xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </Apis> <Users xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </Users> <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </Tags> <Status xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </Status> <Days xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </Days> <ApiKeys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </ApiKeys> <Ips xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </Ips> <Browsers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </Browsers> <Devices xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </Devices> <Bots xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringRequestSummaryEdXdwojR> <d3p1:Key>String</d3p1:Key> <d3p1:Value> <Name>String</Name> <TotalRequests>0</TotalRequests> <TotalRequestLength>0</TotalRequestLength> <MinRequestLength>0</MinRequestLength> <MaxRequestLength>0</MaxRequestLength> <TotalDuration>0</TotalDuration> <MinDuration>0</MinDuration> <MaxDuration>0</MaxDuration> <Status> <d3p1:KeyValueOfintlong> <d3p1:Key>0</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfintlong> </Status> <Durations> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> <Apis> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Apis> <Users> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Users> <Ips> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Ips> <ApiKeys> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </ApiKeys> </d3p1:Value> </d3p1:KeyValueOfstringRequestSummaryEdXdwojR> </Bots> <Durations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringlong> <d3p1:Key>String</d3p1:Key> <d3p1:Value>0</d3p1:Value> </d3p1:KeyValueOfstringlong> </Durations> </Result> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </GetAnalyticsReportsResponse>