Item Service Metrics
Metrics available#
The Item Service supports the following Metrics Service APIs:
- NamedUserCollectionCount
- NamedUserCollectionVersionCount
- NamedUserCollectionVersionSize
- NamedUserCollectionRelatedItemsCount
- NamedFIleCollectionCount
- NamedFileCollectionVersionCount
- NamedFileCollectionVersionSize
- NamedFileCollectionRelatedItemsCount
- NamedTelemetryCollectionCount
- NamedTelemetryCollectionVersionCount
- NamedTelemetryCollectionVersionSize
- NamedTelemetryCollectionRelatedItemsCount
- NamedTelemetryCollectionTimeSeriesCollectionSize
- ScriptCount
- ScriptVersionCount
- ScriptVersionSize
- UserConfigCount
- UserConfigVersionCount
- UserConfigVersionSize
- NamedCompositeItemCount
- NamedCompositeItemVersionCount
- NamedCompositeItemSize
- NamedCompositeItemVersionSize
- NamedCompositeItemRelatedCollectionCount
NamedUserCollectionCount#
This API call returns the number of named user collections in a namespace, typically a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedUserCollectionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedUserCollectionCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
Body#
Example:
This example shows a request to return the NamedUserCollectionCount for the namespace called digitaltwin_XYZ
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedUserCollectionCount/by-dimension;namespace=digitaltwin_XYZResponse#
This example response shows that the NamedUserCollectionCount in the digitaltwin_XYZ namespace was counted as 517 at 14:00 on 25th July, and 620 at 04:00 on 26th July.
{ "metricName": "dtplatform.itemsvc.NamedUserCollectionCount", "dimensions": { "namespace": "digitaltwin_XYZ" }, "metrics": [ { "timestamp": "2024-07-25T14:00:00Z", "value": 517 }, { "timestamp": "2024-07-26T04:00:00Z", "value": 620 } ]}NamedUserCollectionVersionCount#
This API call returns the number of named user collection versions in a namespace, (typically a workspace namespace) for a particular collection or for the namespace as a whole.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedUserCollectionVersionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedUserCollectionVersionCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by collection user item ID | Optional |
NamedUserCollectionVersionSize#
This API call returns the size (in bytes) on disk of a named user collection version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedUserCollectionVersionSize?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedUserCollectionVersionSize/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by collection user item ID | Optional |
version | String | Filter by version number of the named user collection | Optional |
NamedUserCollectionRelatedItemsCount#
This API call returns the number of related items per named user collection version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedUserCollectionRelatedItemsCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedUserCollectionRelatedItemsCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by collection user item ID | Optional |
version | String | Filter by version number of the named user collection | Optional |
NamedFileCollectionCount#
This API call returns the number of named file collections in a namespace, typically a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedFileCollectionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedFileCollectionCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
NamedFileCollectionVersionCount#
This API call returns the number of named file collection versions in a namespace, (typically a workspace namespace) for a particular collection or for the namespace as a whole.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedFileCollectionVersionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedFileCollectionVersionCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by file collection version ID | Optional |
NamedFileCollectionVersionSize#
This API call returns the size (in bytes) on disk of a named file collection version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedFileCollectionVersionSize?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedFileCollectionVersionSize/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by file collection version ID | Optional |
version | String | Filter by version number of the named file collection | Optional |
NamedFileCollectionRelatedItemsCount#
This API call returns the number of related items per named file collection version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedFileCollectionRelatedItemsCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedFileCollectionRelatedItemsCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by file collection version ID | Optional |
version | String | Filter by version number of the named file collection | Optional |
NamedTelemetryCollectionCount#
This API call returns the number of named telemetry collections in a namespace, typically a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
NamedTelemetryCollectionVersionCount#
This API call returns the number of named telemetry collection versions in a namespace, (typically a workspace namespace) for a particular telemetry collection or for the namespace as a whole.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionVersionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionVersionCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by telemetry collection user item ID | Optional |
NamedTelemetryCollectionVersionSize#
This API call returns the size (in bytes) on disk of a named telemetry collection version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionVersionSize?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionVersionSize/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by telemetry collection user item ID | Optional |
version | String | Filter by version number of the named telemetry collection | Optional |
NamedTelemetryCollectionRelatedItemsCount#
This API call returns the number of related items per named telemetry collection version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionRelatedItemsCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionRelatedItemsCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by telemetry collection user item ID | Optional |
version | String | Filter by version number of the named telemetry collection | Optional |
NamedTelemetryCollectionRelatedItemsCount#
This API call returns the number of related items per named telemetry collection version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionRelatedItemsCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionRelatedItemsCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by telemetry collection user item ID | Optional |
version | String | Filter by version number of the named telemetry collection | Optional |
NamedTelemetryCollectionTimeSeriesCollectionSize#
This API call returns the size (in bytes) on disk of the time series of the named telemetry collection version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionTimeSeriesCollectionSize?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedTelemetryCollectionTimeSeriesCollectionSize/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
collection | String | Filter by telemetry collection user item ID | Optional |
version | String | Filter by version number of the named telemetry collection | Optional |
ScriptCount#
This API call returns the number of scripts in a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.ScriptCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.ScriptCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
ScriptVersionCount#
This API call returns the number of script versions in a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.ScriptVersionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.ScriptVersionCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
item | String | Filter by script user item ID | Optional |
ScriptVersionSize#
This API call returns the size on disk of a script version in a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.ScriptVersionSize?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.ScriptVersionSize/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
item | String | Filter by script user item ID | Optional |
version | String | Filter by version number of the script | Optional |
UserConfigCount#
This API call returns the number of named user configurations in a namespace, typically a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.UserConfigCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.UserConfigCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
UserConfigVersionCount#
This API call returns the number of versions of a user configuration in a namespace, typically a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.UserConfigVersionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.UserConfigVersionCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
item | String | Filter by user configuration item ID | Optional |
UserConfigVersionSize#
This API call returns the size (in bytes) on disk of a user configuration version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.UserConfigVersionSize?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.UserConfigVersionSize/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
item | String | Filter by user configuration item ID | Optional |
version | String | Filter by version number of the user configuration | Optional |
NamedCompositeItemCount#
This API call returns the number of named composite items in a namespace, typically a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
NamedCompositeItemVersionCount#
This API call returns the number of named composite item versions in a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemVersionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemVersionCount/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
item | String | Filter by script user item ID | Optional |
NamedCompositeItemSize#
This API call returns the size (in bytes) on disk of a named composite item.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemSize?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemSize/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
item | String | Filter by named composite item ID | Optional |
NamedCompositeItemVersionSize#
This API call returns the size (in bytes) on disk of a named composite item version.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemVersionSize?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemVersionSize/by-dimension;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
item | String | Filter by user configuration item ID | Optional |
version | String | Filter by version number of the named composite item | Optional |
NamedCompositeItemRelatedCollectionCount#
This API call returns the number of named composite item related collections in a namespace, typically a workspace namespace.
Endpoints#
Two forms of endpoints are available:
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemRelatedCollectionCount?{dimensions}
GET /metricsvc/api/v1/metrics/dtplatform.itemsvc.NamedCompositeItemRelatedCollectionCount;{dimensions}?{period parameters}
Request#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
namespace | String | Filter by workspace namespace | Required |
item | String | Filter by named composite item ID | Optional |
|