メインコンテンツまでスキップ

Get live metrics

GET 
/bv/cms/v1/lives/:id/metrics

Return the live metrics.

  • Return a 404/NotFound error if the requested resource is not found.

Request​

Path Parameters

    id stringrequired

    Required. The unique id of the live.

Query Parameters

    start_time date-timerequired

    Required. The time stamp indicating the earliest data to be returned. The time range cannot be over 8 hours.

    end_time date-timerequired

    Required. The time stamp indicating the latest data to be returned. The time range cannot be over 8 hours.

    types string[]

    Possible values: [LIVE_METRIC_TYPE_NETWORK_IN, LIVE_METRIC_TYPE_FRAME_RATE, LIVE_METRIC_TYPE_CONCURRENT_USER]

    Optional. The live metrics types. It will request for all types of metrics if empty.

    • LIVE_METRIC_TYPE_NETWORK_IN: The rate of traffic coming into the streaming server. Unit: Mbps.
    • LIVE_METRIC_TYPE_FRAME_RATE: The frame rate of the input content. Unit: fps
    • LIVE_METRIC_TYPE_CONCURRENT_USER: The concurrent user of the input content. Unit: number of users

Header Parameters

    x-bv-org-id stringrequired

    To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

Responses​

A successful response.

Schema
    metrics object[]
  • Array [
    • type - LIVE_METRIC_TYPE_NETWORK_IN: The rate of traffic coming into the streaming server. Unit: Mbps. - LIVE_METRIC_TYPE_FRAME_RATE: The frame rate of the input content. Unit: fps - LIVE_METRIC_TYPE_CONCURRENT_USER: The concurrent user of the input content. Unit: number of users (string)

    Possible values: [LIVE_METRIC_TYPE_NETWORK_IN, LIVE_METRIC_TYPE_FRAME_RATE, LIVE_METRIC_TYPE_CONCURRENT_USER]

    The metric type requested.

    dimension string

    Optional. The dimension for the metric.

    datapoints object[]

    The datapoints for the metric.

  • Array [
    • time date-time

    The timestamp for the datapoint.

    value object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

    value string

    The decimal value, as a string.

    The string representation consists of an optional sign, + (U+002B) or - (U+002D), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent.

    The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand.

    The exponent consists of the character e (U+0065) or E (U+0045) followed by one or more decimal digits.

    Services should normalize decimal values before storing them by:

    • Removing an explicitly-provided + sign (+2.5 -> 2.5).
    • Replacing a zero-length integer value with 0 (.5 -> 0.5).
    • Coercing the exponent character to lower-case (2.5E8 -> 2.5e8).
    • Removing an explicitly-provided zero exponent (2.5e0 -> 2.5).

    Services may perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: 2.5e-1 <-> 0.25). Additionally, services may preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so.

    Note that only the . character is supported to divide the integer and the fraction; , should not be supported regardless of locale. Additionally, thousand separators should not be supported. If a service does support them, values must be normalized.

    The ENBF grammar is:

    DecimalString =
      [Sign] Significand [Exponent];

    Sign = '+' | '-';

    Significand =
      Digits ['.'] [Digits] | [Digits] '.' Digits;

    Exponent = ('e' | 'E') [Sign] Digits;

    Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };

    Services should clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values.

    Services may choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and should round the value to fit the supported scale. Alternatively, the service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if precision would be lost.

    Services should error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if the service receives a value outside of the supported range.

  • ]
  • ]
Loading...