Skip to main content
Version: v5.0

IafUsageMetrics

Use the IafUsageMetrics API to retrieve metrics information.

getFileCount#

Gets file count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of files

getFileCountGraphics#

Gets graphics file count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of graphics files

getFileVersionCount#

Gets file version count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of file versions

getFileVersionCountGraphics#

Gets graphics file version count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of graphics file versions

getFileVersionSize#

Gets file version size for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - size of file versions

getFileVersionSizeGraphics#

Gets graphics file version size for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - size of graphics file versions

getGeneralMetrics#

Gets general metrics from a particular application and/or workspace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Object - metrics object

Examples
{   metrics: [{     metricName: "dtplatform.passportsvc.WorkspaceCount",     value: 12   },{     metricName: "dtplatform.passportsvc.UserGroupCount",     value: 32},{     metricName: "dtplatform.passportsvc.UserConfigCount",     value: 32}]}

getNamedFileCollectionCount#

Gets named file collection count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of named file collections

getNamedFileCollectionRelatedItemCount#

Gets named file collection related item count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of named file collection related items

getNamedFileCollectionVersionCount#

Gets named file collection version count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of named file collection versions

getNamedFileCollectionVersionSize#

Gets named file collection version size for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - size of named file collection versions

getNamedTelemetryCollectionCount#

Gets named telemetry collection count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of named telemetry collections

getNamedTelemetryCollectionRelatedItemCount#

Gets named telemetry collection related item count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of named telemetry collection related items

getNamedTelemetryCollectionTimeSeriesSize#

Gets named telemetry collection time series collection size for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - size of named telemetry collection time series collections

getNamedTelemetryCollectionVersionCount#

Gets named telemetry collection version count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of named telemetry collection versions

getNamedTelemetryCollectionVersionSize#

Gets named telemetry collection version size for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - size of named telemetry collection versions

getNamedUserCollectionCount#

Gets named user collection count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of named user collections

getNamedUserCollectionRelatedItemCount#

Gets named user collection related item count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of named user collection related items

getNamedUserCollectionVersionCount#

Gets named user collection version count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of named user collection versions

getNamedUserCollectionVersionSize#

Gets named user collection version size for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - size of named user collection versions

getPreviewImageFileSize#

Gets preview image file size for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - size of preview image files

getScriptCount#

Gets script count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of scripts

getScriptVersionSize#

Gets script version size for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - size of script versions

getUserConfigCount#

Gets user config count for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of user configs

getUserConfigVersionSize#

Gets user config version size for a particular namespace.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - size of user config versions

getUsergroupCountByApplication#

Gets user group count for a particular application.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of user groups

getWorkspaceCountByApplication#

Gets workspace count from a particular application.

ParameterRequiredTypeDescription
ctxNoCtxContext storage that contains data, such as authorization token requirements, namespaces, or session storage.
Returns

Number - number of workspaces