[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance

Get Metric Details

Description

Retrieves information related to a metric based upon filters provided.

Request

Request

URL

URL


get
https://{api_host}tcsa.host.com/v1/catalog/metrics
Copy

Query Parameters

Query Parameters

array of string
domain Optional

Domain the metric type belongs to.

domain example
[
	"5G"
]

integer
limit Optional

Maximum number of results per page.


array of string
metric_name Optional

Name of the metric

metric_name example
[
	"Active_Time_Dl"
]

array of string
metric_type Optional

Metric type to be fetched.

metric_type example
[
	"RRU"
]

integer
offset Optional

Offset from first result to fetch.


string
sort_by Optional

Sorting is allowed only on metric_type, domain and sub_domain fields, eg sort_by=metricType desc


array of string
sub_domains Optional

Sub-Domain the metric type belongs to.

sub_domains example
[
	"3GPP"
]

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns MetricDetails of type application/json
{
	"metric_details": [
		{
			"domain": "5G",
			"metricType": "RRU",
			"metrics": [
				{
					"datatype": null,
					"description": "the time duration that gNb used to receive bits from it's serving UEs",
					"max": null,
					"min": null,
					"name": "Active_Time_Ul",
					"range": null,
					"unit": "ms"
				}
			],
			"sub_domains": [
				"3GPP",
				"vRAN"
			]
		}
	],
	"page_count": 1,
	"total": 1
}
integer as int64
page_count Required

Total number of pages


integer as int64
total Required

Total number of entities


metric_details Optional
Errors

Errors

400

Invalid Request sent by the user


401

User authentication failed


403

Access to the requested resource/operation is forbidden


404

Cannot find requested resource


500

Internal server error

Code Samples

Code Samples

cURL Command

curl https://{api_host}tcsa.host.com/v1/catalog/metrics


[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Feedback

Was this page helpful?