List Live Events | MediaKind Docs

{
  "supplemental": {
    "count": 1,
    "kind": "string",
    "operation": "string",
    "pagination": {
      "end": 1,
      "records": 1,
      "start": 1,
      "total": 1
    },
    "subscription": {
      "id": "string",
      "name": "string"
    }
  },
  "value": [
    {
      "kind": "string",
      "metadata": {
        "id": "string",
        "created": "2024-01-15T09:30:00Z",
        "createdBy": "string",
        "createdByEmail": "string",
        "displayName": "string",
        "labels": {
          "label1": "value1",
          "label2": "value2"
        },
        "name": "string",
        "updated": "2024-01-15T09:30:00Z",
        "updatedBy": "string",
        "updatedByEmail": "string"
      },
      "spec": {
        "inputs": [
          {
            "contentName": "channel-1",
            "flowName": "flow-1",
            "refiner": {
              "flow": {
                "name": "string"
              },
              "labelMatch": {
                "key": "string",
                "value": "string"
              }
            },
            "sourceName": "source-1",
            "transformInput": "encoding/input_1"
          }
        ],
        "outputs": [
          {
            "contentName": "string",
            "destinationName": "production-1",
            "refiner": {},
            "transformOutput": "encoding/output_1",
            "transport": {
              "maxConnections": 10
            }
          }
        ],
        "state": "Running",
        "transform": {
          "archiveWindowLength": "string",
          "assetName": "string",
          "assetPath": "string",
          "encodingLive": {
            "advancedSettingsName": "string",
            "configOverrides": {
              "operations": [
                {
                  "op": "add",
                  "path": "string",
                  "search": "string"
                }
              ],
              "type": "application/json-patch+json"
            },
            "configRef": {
              "name": "string",
              "version": "latest"
            },
            "configValues": {
              "audio1label": "Spanish",
              "audio1lang": "spa",
              "audio1pid": 257,
              "epochts": false
            }
          },
          "streamConditioning": {
            "advancedSettingsName": "string",
            "configOverrides": {
              "operations": [
                {
                  "op": "add",
                  "path": "string",
                  "search": "string"
                }
              ],
              "type": "application/json-patch+json"
            },
            "configRef": {
              "name": "string",
              "version": "latest"
            },
            "configValues": {
              "audio1label": "Spanish",
              "audio1lang": "spa",
              "audio1pid": 257,
              "epochts": false
            }
          },
          "type": "string"
        },
        "refiner": {},
        "siteName": "world"
      },
      "status": {
        "deviceDisplayName": "Device 1",
        "deviceName": "device-1",
        "info": "There was an issue with start due to a mismatch of Template inputs and configured inputs.",
        "inputs": [
          {
            "contentDisplayName": "Channel 1",
            "contentName": "channel-1",
            "deviceInterfaceName": "eth0",
            "networkDisplayName": "Internet",
            "networkName": "internet",
            "sourceDisplayName": "Channel 1 SRT",
            "sourceName": "channel-1-srt",
            "sourceShortId": "a1b2c3d4e5f6",
            "sourceUrl": "srt://10.10.10.1:6000",
            "upstreamFlowName": "channel-1-encode"
          }
        ],
        "metrics": {
          "mk_resource_status": [
            {
              "labels": {
                "mkio_stage": "encode"
              },
              "value": 0
            },
            {
              "labels": {
                "mkio_stage": "output"
              },
              "value": 0
            },
            {
              "labels": {
                "mkio_stage": "resource"
              },
              "value": 0
            }
          ]
        },
        "monitoring": {},
        "outputs": [
          {
            "contentDisplayName": "string",
            "contentName": "string",
            "destinationDisplayName": "production-1",
            "destinationUrl": "srt://10.10.10.2:6000",
            "deviceInterfaceName": "eth0",
            "downstreamFlowNames": [
              "string"
            ],
            "networkDisplayName": "Internet",
            "networkName": "internet",
            "transport": {
              "maxBitrate": 1,
              "latency": 10,
              "maxConnections": 10
            }
          }
        ],
        "shortId": "a1b2c3d4e5f6",
        "siteDisplayName": "World",
        "state": "Started",
        "transform": {
          "streamPersonalization": {
            "hostName": "string"
          }
        }
      }
    }
  ],
  "@odata.nextLink": "string"
}

List Live Events on the specified project.

Listing, Sorting and Filtering Live Events

This endpoint returns the list of Live Events in the specified project.

Sorting

The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas where each one can optionally specify asc or desc.

Sorting is valid on the following fields: created, createdBy, displayName, id, labels, name, spec/state, spec/transform/type, status/state, status/transformType, updated, updatedBy

Filtering

There are two ways to filter the set of returned Live Events from this endpoint - the first is to use the $filter query parameter, the second is to use the $label_key and $label query parameters.

The $filter query parameter allows for Live Events to be filtered on the basis of fields in the schema using OData query syntax. See this document for more details on the syntax used.

Filters are valid on the following fields: created, createdBy, createdByEmail, createdByName, displayName, id, labels, name, spec/inputs/content, spec/outputs/destination, spec/siteName, spec/state, spec/transform/type, status/deviceName, status/state, status/transformType, updated, updatedBy, updatedByEmail, updatedByName

$label_key and $label are specific to querying Live Events based on their labels. Labels are a set of key-value pairs that can be used to identify Live Events with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of Live Events.

Examples:

?$top=10 - Returns only the first 10 Live Events from the list.

?$orderby=name desc - Sorts Live Events by name in descending order.

?$filter=name eq 'descriptive name' - Returns Live Events that match the provided name.

?$orderby=created desc - Sorts Live Events by creation date in descending order.

?$filter=created ge 2021-01-01T00:00:00Z - Returns Live Events created after January 1, 2021.

?$label=studio=paravalley - Returns Live Events with the label studio set to paravalley.

?$label=release-date~2023 - Returns Live Events with the label release-date set to a value that contains 2023.

?$label_key=studio&label_key=release-date - Returns Live Events with any value set for the studio label and the release-date label.

RBAC Capability Required: transform.liveevent.get

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_namestringRequired

Query parameters

$orderbystringOptional

Specifies the key by which the result collection should be ordered.

$filterstringOptional

Restricts the set of items returned.

$topstringOptional

Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.

$skiptokenstringOptional

Specifies a start offset to support paginated results. Use @odata.nextLink in the result object to enumerate the collection - it will be present only if there's more than one page of entities.

$label_keystringOptional

Filters the set to the specified label key. If multiple $label_keys are specified, matching items must have all labels.

$labelstringOptional

Filters the set to the specified label key/value pair. Supports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.

$detailedStatusstringOptional

Include extra status information in the response.

Response

List of Live Events

supplementalobject

Supplemental info

valuelist of objects

A list of flows.

@odata.nextLinkstringOptionalRead-only

@odata.nextLink URL if the page length and number of items match.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error