Get Metric Details

Get Metric Details

Retrieves information related to a metric based upon filters provided.

Request
URI
GET
https://{api_host}/tcsa.host.com/v1/catalog/metrics
COPY
Query Parameters
string of array
metric_name
Optional

Name of the metric

metric_name example 
Active_Time_Dl
integer
offset
Optional

Offset from first result to fetch.

integer
limit
Optional

Maximum number of results per page.

string
sort_by
Optional

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

string of array
metric_type
Optional

Metric type to be fetched.

metric_type example 
RRU
string of array
domain
Optional

Domain the metric type belongs to.

domain example 
5G
string of array
sub_domains
Optional

Sub-Domain the metric type belongs to.

sub_domains example 
3GPP
Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

Total number of entities

integer As int64 As int64
page_count
Required

Total number of pages

array of MetricDetailsArray
metric_details
Optional

metric_details


400

Invalid Request sent by the user

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


401

User authentication failed

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


403

Access to the requested resource/operation is forbidden

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


404

Cannot find requested resource

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


500

Internal server error

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


On This Page
Catalog Operations
GET
Get Metric Details
GET
Get Metric Entities
GET
Get Metrics Model Metadata