Skip to main content
AskMe (beta)
Responses may be inaccurate. Learn more about AskMe.

%Api.InteropMetrics.v1.impl

class %Api.InteropMetrics.v1.impl extends %REST.Impl

Set of REST APIs for getting interop metrics
Business logic class defined by OpenAPI in %Api.InteropMetrics.v1.spec
Updated Nov 14, 2024 18:27:22

Method Inventory

Parameters

parameter ExposeServerExceptions = 0;
If ExposeServerExceptions is true, then details of internal errors will be exposed.

Methods

classmethod currentDatabaseImpact(start As %String, end As %String, database As %String) as %Stream.Object
Returns estimated size of data (in MB) created for each database for all currently active data.
The method arguments hold values for:
start, If specified, only data since start (inclusive) is included. The start parameter is a date or datetime in UTC that must specified in ODBC format YYYY-MM-DD[ HH:MM:SS]. If only YYYY-MM-DD is specified, HH:MM:SS is assumed to be 00:00:00.
end, If specified, only data until end (inclusive) is included. The end parameter is a date or datetime in UTC that must specified in ODBC format YYYY-MM-DD[ HH:MM:SS]. If only YYYY-MM-DD is specified, HH:MM:SS is assumed to be 23:59:59.
database, If specified, only data related to that database is included.
classmethod currentInterfaces(start As %String, end As %String, namespace As %String) as %Stream.Object
Returns information about all inbound, outbound, and web API interfaces for all currently active data.
The method arguments hold values for:
start, If specified, only data since start (inclusive) is included. The start parameter is a date or datetime in UTC that must specified in ODBC format YYYY-MM-DD[ HH:MM:SS]. If only YYYY-MM-DD is specified, HH:MM:SS is assumed to be 00:00:00.
end, If specified, only data until end (inclusive) is included. The end parameter is a date or datetime in UTC that must specified in ODBC format YYYY-MM-DD[ HH:MM:SS]. If only YYYY-MM-DD is specified, HH:MM:SS is assumed to be 23:59:59.
namespace, If specified, only data related to that namespace is included.
classmethod currentRange() as %Stream.Object
Returns the date of both the earliest and most recent currently active records. If no metrics data exist, an empty response is returned.
classmethod currentVolume(startDate As %String, endDate As %String, namespace As %String) as %Stream.Object
Returns the total inbound and outbound volume metrics per namespace for all currently active data.
The method arguments hold values for:
startDate, If specified, only data since startDate (inclusive) is included. The startDate parameter is a date in UTC that must specified in ODBC format YYYY-MM-DD.
endDate, If specified, only data until endDate (inclusive) is included. The endDate parameter is a date in UTC that must specified in ODBC format YYYY-MM-DD.
namespace, If specified, only data related to that namespace is included.
classmethod historicalDatabaseImpact(startmonth As %String, endmonth As %String, database As %String) as %Stream.Object
Returns estimated size of data (in MB) created for each database for all historical data.
The method arguments hold values for:
startmonth, If specified, only data since startmonth (inclusive) is included. The startmonth parameter is string of format YYYY-MM. Note that all times and dates are in UTC.
endmonth, If specified, only data until endmonth (inclusive) is included. The endmonth parameter is string of format YYYY-MM. Note that all times and dates are in UTC.
database, If specified, only data related to that database is included.
classmethod historicalInterfaces(startmonth As %String, endmonth As %String, namespace As %String) as %Stream.Object
Returns information about all inbound, outbound, and web API interfaces for all historical data
The method arguments hold values for:
startmonth, If specified, only data since startmonth (inclusive) is included. The startmonth parameter is string of format YYYY-MM. Note that all times and dates are in UTC.
endmonth, If specified, only data until endmonth (inclusive) is included. The endmonth parameter is string of format YYYY-MM. Note that all times and dates are in UTC.
namespace, If specified, only data related to that namespace is included.
classmethod historicalRange() as %Stream.Object
Returns the date of both the earliest and most recent historical data. If no metrics data exist, an empty response is returned.
classmethod historicalVolume(startmonth As %String, endmonth As %String, namespace As %String) as %Stream.Object
Returns the total inbound and outbound volume metrics per namespace for all historical data.
The method arguments hold values for:
startmonth, If specified, only data since startmonth (inclusive) is included. The startmonth parameter is string of format YYYY-MM. Note that all times and dates are in UTC.
endmonth, If specified, only data until endmonth (inclusive) is included. The endmonth parameter is string of format YYYY-MM. Note that all times and dates are in UTC.
namespace, If specified, only data related to that namespace is included.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab