com.mux/mcp

[Fetch an animated GIF or WebP image](https://docs.mux.com/guides/get-images-from-a-video#get-an-animated-gif-from-a-video) from a video segment with optional transformations.

Cancels a direct upload and marks it as cancelled. If a pending upload finishes after this request, no asset will be created. This request will only succeed if the upload is still in the `waiting` state.

(Optional) End the live stream recording immediately instead of waiting for the reconnect_window. `EXT-X-ENDLIST` tag is added to the HLS manifest which notifies the player that this live stream is over. Mux does not close the encoder connection immediately. Encoders are often configured to re-establish connections immediately which would result in a new recorded asset. For this reason, Mux waits for 60s before closing the connection with the encoder. This 60s timeframe is meant to give encoder operators a chance to disconnect from their end.

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Creates a new annotation. # Response Schema ```json { $ref: '#/$defs/annotation_response', $defs: { annotation_response: { type: 'object', properties: { data: { $ref: '#/$defs/annotation' } }, required: [ 'data' ] }, annotation: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the annotation' }, date: { type: 'string', description: 'Datetime when the annotation applies', format: 'date-time' }, note: { type: 'string', description: 'The annotation note content' }, sub_property_id: { type: 'string', description: 'Customer-defined sub-property identifier' } }, required: [ 'id', 'date', 'note' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Creates a playback ID that can be used to stream the asset to a viewer. # Response Schema ```json { type: 'object', properties: { data: { $ref: '#/$defs/playback_id' } }, required: [ 'data' ], $defs: { playback_id: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the PlaybackID' }, policy: { $ref: '#/$defs/playback_policy' }, drm_configuration_id: { type: 'string', description: 'The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.' } }, required: [ 'id', 'policy' ] }, playback_policy: { type: 'string', description: '* `public` playback IDs are accessible by constructing an HLS URL like `https://stream.mux.com/${PLAYBACK_ID}`\n\n* `signed` playback IDs should be used with tokens `https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}`. See [Secure video playback](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens.\n\n* `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).', enum: [ 'public', 'signed', 'drm' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Create a new playback ID for this live stream, through which a viewer can watch the streamed content of the live stream. # Response Schema ```json { type: 'object', properties: { data: { $ref: '#/$defs/playback_id' } }, required: [ 'data' ], $defs: { playback_id: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the PlaybackID' }, policy: { $ref: '#/$defs/playback_policy' }, drm_configuration_id: { type: 'string', description: 'The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.' } }, required: [ 'id', 'policy' ] }, playback_policy: { type: 'string', description: '* `public` playback IDs are accessible by constructing an HLS URL like `https://stream.mux.com/${PLAYBACK_ID}`\n\n* `signed` playback IDs should be used with tokens `https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}`. See [Secure video playback](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens.\n\n* `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).', enum: [ 'public', 'signed', 'drm' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API. # Response Schema ```json { type: 'object', properties: { data: { $ref: '#/$defs/simulcast_target' } }, required: [ 'data' ], $defs: { simulcast_target: { type: 'object', properties: { id: { type: 'string', description: 'ID of the Simulcast Target' }, status: { type: 'string', description: 'The current status of the simulcast target. See Statuses below for detailed description.\n * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state.\n * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state.\n * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service.\n * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. When a simulcast target has this status it will have an `error_severity` field with more details about the error.', enum: [ 'idle', 'starting', 'broadcasting', 'errored' ] }, url: { type: 'string', description: 'The RTMP(s) or SRT endpoint for a simulcast destination.\n* For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: `rtmp://live.example.com/app`.\n* For SRT destinations, this should be a fully formed S…

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Creates a static rendition (i.e. MP4) for an asset # Response Schema ```json { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string', description: 'The ID of this static rendition, used in managing this static rendition. This field is only valid for `static_renditions`, not for `mp4_support`.' }, bitrate: { type: 'integer', description: 'The bitrate in bits per second' }, ext: { type: 'string', description: 'Extension of the static rendition file', enum: [ 'mp4', 'm4a' ] }, filesize: { type: 'string', description: 'The file size in bytes' }, height: { type: 'integer', description: 'The height of the static rendition\'s file in pixels' }, name: { type: 'string', description: 'Name of the static rendition file', enum: [ 'low.mp4', 'medium.mp4', 'high.mp4', 'highest.mp4', 'audio.m4a', 'capped-1080p.mp4', '2160p.mp4', '1440p.mp4', '1080p.mp4', '720p.mp4', '540p.mp4', '480p.mp4', '360p.mp4', '270p.mp4' ] }, passthrough: { type: 'string', description: 'Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.' }, resolution: { type: 'string', description: 'Indicates the resolution of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`.', enum: [ 'hig…

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. # Response Schema ```json { $ref: '#/$defs/signing_key_response', $defs: { signing_key_response: { type: 'object', properties: { data: { $ref: '#/$defs/signing_key' } }, required: [ 'data' ] }, signing_key: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Signing Key.' }, created_at: { type: 'string', description: 'Time at which the object was created. Measured in seconds since the Unix epoch.' }, private_key: { type: 'string', description: 'A Base64 encoded private key that can be used with the RS256 algorithm when creating a [JWT](https://jwt.io/). **Note that this value is only returned once when creating a URL signing key.**' } }, required: [ 'id', 'created_at' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Adds an asset track (for example, subtitles, or an alternate audio track) to an asset. Assets must be in the `ready` state before tracks can be added. # Response Schema ```json { type: 'object', properties: { data: { $ref: '#/$defs/track' } }, required: [ 'data' ], $defs: { track: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Track' }, closed_captions: { type: 'boolean', description: 'Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set tracks where `type` is `text` and `text_type` is `subtitles`.' }, duration: { type: 'number', description: 'The duration in seconds of the track media. This parameter is not set for `text` type tracks. This field is optional and may not be set. The top level `duration` field of an asset will always be set.' }, language_code: { type: 'string', description: 'The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is only set for `text` and `audio` track types.' }, max_channel_layout: { type: 'string', description: 'Only set for the `audio` type track.' }, max_channels: { type: 'integer', description: 'The maximum number of audio channels the track supports. Only set for the `audio` type track.' }, max_frame_rate: { type: 'number', description: 'The maximum frame rate available for the track. Only set for the `video` type track. This field may return `-1…

Create a new Mux Video asset.

Creates a new live stream. Once created, an encoder can connect to Mux via the specified stream key and begin streaming to an audience.

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Create a new Playback Restriction. # Response Schema ```json { $ref: '#/$defs/playback_restriction_response', $defs: { playback_restriction_response: { type: 'object', properties: { data: { $ref: '#/$defs/playback_restriction' } }, required: [ 'data' ] }, playback_restriction: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Playback Restriction. Max 255 characters.' }, created_at: { type: 'string', description: 'Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch).' }, referrer: { type: 'object', description: 'A list of domains allowed to play your videos.', properties: { allow_no_referrer: { type: 'boolean', description: 'A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests.' }, allowed_domains: { type: 'array', description: 'List of domains allowed to play videos. Possible values are\n * `[]` Empty Array indicates deny video playback requests for all domains\n * `["*"]` A Single Wildcard `*` entry means allow video playback requests from any domain\n * `["*.example.com", "foo.com"]` A list of up to 10 domains or valid dns-style wildcards\n', items: { type: 'string' } } } }, updated_at: { type: 'string',…

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Create a new Transcription Vocabulary. # Response Schema ```json { $ref: '#/$defs/transcription_vocabulary_response', $defs: { transcription_vocabulary_response: { type: 'object', properties: { data: { $ref: '#/$defs/transcription_vocabulary' } }, required: [ 'data' ] }, transcription_vocabulary: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Transcription Vocabulary' }, created_at: { type: 'string', description: 'Time the Transcription Vocabulary was created, defined as a Unix timestamp (seconds since epoch).' }, updated_at: { type: 'string', description: 'Time the Transcription Vocabulary was updated, defined as a Unix timestamp (seconds since epoch).' }, name: { type: 'string', description: 'The user-supplied name of the Transcription Vocabulary.' }, passthrough: { type: 'string', description: 'Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters.' }, phrases: { type: 'array', description: 'Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream\'s `generated_subtitles` configuration, the probability of successful speech recognition for these words or phrases is boosted.', items: { type: 'string', description: 'A phrase or word belonging to a Transcription Vocabulary.' } } }, required: [ 'id', 'created_at', 'updated_at' ] } } } ```

Creates a new direct upload, through which video content can be uploaded for ingest to Mux.

Deletes an annotation.

Deletes a live stream's static renditions settings for new assets. Further assets made via this live stream will not create static renditions unless re-added.

Deletes a playback ID, rendering it nonfunctional for viewing an asset's video content. Please note that deleting the playback ID removes access to the underlying asset; a viewer who started playback before the playback ID was deleted may be able to watch the entire video for a limited duration.

Deletes the playback ID for the live stream. This will not disable ingest (as the live stream still exists). New attempts to play back the live stream will fail immediately. However, current viewers will be able to continue watching the stream for some period of time.

Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.

Deletes a single static rendition for an asset

Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no JWTs can be signed using the key again.

Removes a text or additional audio track from an asset. Neither video nor the primary audio track can be removed.

Deletes a single Playback Restriction.

Deletes a Transcription Vocabulary. The Transcription Vocabulary's ID will be disassociated from any live streams using it. Transcription Vocabularies can be deleted while associated live streams are active. However, the words and phrases in the deleted Transcription Vocabulary will remain attached to those streams while they are active.

Disables a live stream, making it reject incoming RTMP streams until re-enabled. The API also ends the live stream recording immediately when active. Ending the live stream recording adds the `EXT-X-ENDLIST` tag to the HLS manifest which notifies the player that this live stream is over. Mux also closes the encoder connection immediately. Any attempt from the encoder to re-establish connection will fail till the live stream is re-enabled.

Enables a live stream, allowing it to accept an incoming RTMP stream.

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Generates subtitles (captions) for a given audio track. This API can be used for up to 7 days after an asset is created. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/track' } } }, required: [ 'data' ], $defs: { track: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Track' }, closed_captions: { type: 'boolean', description: 'Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set tracks where `type` is `text` and `text_type` is `subtitles`.' }, duration: { type: 'number', description: 'The duration in seconds of the track media. This parameter is not set for `text` type tracks. This field is optional and may not be set. The top level `duration` field of an asset will always be set.' }, language_code: { type: 'string', description: 'The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is only set for `text` and `audio` track types.' }, max_channel_layout: { type: 'string', description: 'Only set for the `audio` type track.' }, max_channels: { type: 'integer', description: 'The maximum number of audio channels the track supports. Only set for the `audio` type track.' }, max_frame_rate: { type: 'number', description: 'The maximum frame rate available for the track. Only set for the `video` type track. This fiel…

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { concurrent_viewers: { type: 'integer' }, metric_value: { type: 'number' }, negative_impact: { type: 'integer' }, starting_up_viewers: { type: 'integer' }, value: { type: 'string' }, display_value: { type: 'string' } }, required: [ 'concurrent_viewers', 'metric_value', 'negative_impact', 'starting_up_viewers', 'value' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { date: { type: 'string' }, values: { type: 'array', items: { type: 'object', properties: { concurrent_viewers: { type: 'integer' }, metric_value: { type: 'number' }, starting_up_viewers: { type: 'integer' }, value: { type: 'string' } }, required: [ 'concurrent_viewers', 'metric_value', 'starting_up_viewers', 'value' ] } } }, required: [ 'date', 'values' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Gets histogram timeseries information for a specific metric. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { average: { type: 'number' }, bucket_values: { type: 'array', items: { type: 'object', properties: { count: { type: 'integer' }, percentage: { type: 'number' } }, required: [ 'count', 'percentage' ] } }, max_percentage: { type: 'number' }, median: { type: 'number' }, p95: { type: 'number' }, sum: { type: 'integer' }, timestamp: { type: 'string' } }, required: [ 'average', 'bucket_values', 'max_percentage', 'median', 'p95', 'sum', 'timestamp' ] } }, meta: { type: 'object', properties: { bucket_unit: { type: 'string' }, buckets: { type: 'array', items: { type: 'object', properties: { end: { type: 'integer' }, start: { type: 'integer' } }, required: [ 'end', 'start' ] } } }, required: [ 'bucket_unit', 'buckets' ] }, timeframe: { type: 'array',…

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric. # Response Schema ```json { $ref: '#/$defs/insights_response', $defs: { insights_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { filter_column: { type: 'string' }, filter_value: { type: 'string' }, metric: { type: 'number' }, negative_impact_score: { type: 'number' }, total_playing_time: { type: 'integer' }, total_views: { type: 'integer' }, total_watch_time: { type: 'integer' } }, required: [ 'filter_column', 'filter_value', 'metric', 'negative_impact_score', 'total_playing_time', 'total_views', 'total_watch_time' ] } }, meta: { type: 'object', properties: { aggregation: { type: 'string' }, granularity: { type: 'string' } } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'meta', 'timeframe', 'total_row_count' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric. # Response Schema ```json { $ref: '#/$defs/overall_values_response', $defs: { overall_values_response: { type: 'object', properties: { data: { type: 'object', properties: { global_value: { type: 'number' }, total_playing_time: { type: 'integer' }, total_views: { type: 'integer' }, total_watch_time: { type: 'integer' }, value: { type: 'number' } }, required: [ 'global_value', 'total_playing_time', 'total_views', 'total_watch_time', 'value' ] }, meta: { type: 'object', properties: { aggregation: { type: 'string' }, granularity: { type: 'string' } } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'meta', 'timeframe', 'total_row_count' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value # Response Schema ```json { $ref: '#/$defs/metric_timeseries_data_response', $defs: { metric_timeseries_data_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'array', items: { anyOf: [ { type: 'string' }, { type: 'number' } ] } } }, meta: { type: 'object', properties: { aggregation: { type: 'string' }, granularity: { type: 'string' } } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'meta', 'timeframe', 'total_row_count' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Gets Time series information for a specific metric along with the number of concurrent viewers. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { concurrent_viewers: { type: 'integer' }, date: { type: 'string' }, value: { type: 'number' } }, required: [ 'concurrent_viewers', 'date', 'value' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } ```

Fetch an HLS (HTTP Live Streaming) playlist for the specified video asset, with optional query parameters to [modify playback behavior](https://docs.mux.com/guides/modify-playback-behavior).

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. List the breakdown values for a specific metric. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/breakdown_value' } }, meta: { type: 'object', properties: { aggregation: { type: 'string' }, granularity: { type: 'string' } } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'meta', 'timeframe', 'total_row_count' ], $defs: { breakdown_value: { type: 'object', properties: { field: { type: 'string' }, negative_impact: { type: 'integer' }, total_playing_time: { type: 'integer' }, total_watch_time: { type: 'integer' }, value: { type: 'number' }, views: { type: 'integer' } }, required: [ 'field', 'negative_impact', 'total_playing_time', 'total_watch_time', 'value', 'views' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns a list of annotations. # Response Schema ```json { $ref: '#/$defs/list_annotations_response', $defs: { list_annotations_response: { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/annotation' } }, total_row_count: { type: 'integer', description: 'Total number of annotations available' }, timeframe: { type: 'array', description: 'Start and end unix timestamps for the data range', items: { type: 'integer' } } }, required: [ 'data', 'total_row_count' ] }, annotation: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the annotation' }, date: { type: 'string', description: 'Datetime when the annotation applies', format: 'date-time' }, note: { type: 'string', description: 'The annotation note content' }, sub_property_id: { type: 'string', description: 'Customer-defined sub-property identifier' } }, required: [ 'id', 'date', 'note' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. List all available dimensions. Note: This API replaces the list-filters API call. # Response Schema ```json { $ref: '#/$defs/dimensions_response', $defs: { dimensions_response: { type: 'object', properties: { data: { type: 'object', properties: { advanced: { type: 'array', items: { type: 'string' } }, basic: { type: 'array', items: { type: 'string' } } }, required: [ 'advanced', 'basic' ] }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns a list of errors. # Response Schema ```json { $ref: '#/$defs/errors_response', $defs: { errors_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'integer', description: 'A unique identifier for this error.' }, code: { type: 'integer', description: 'The error code' }, count: { type: 'integer', description: 'The total number of views that experienced this error.' }, description: { type: 'string', description: 'Description of the error.' }, last_seen: { type: 'string', description: 'The last time this error was seen (ISO 8601 timestamp).' }, message: { type: 'string', description: 'The error message.' }, notes: { type: 'string', description: 'Notes that are attached to this error.' }, percentage: { type: 'number', description: 'The percentage of views that experienced this error.' }, player_error_code: { type: 'string', description: 'The string version of the error code' } }, required: [ 'id', 'code', 'count', 'description', 'last_seen', 'message', 'notes', 'percentage', 'player_error_co…

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns a list of incidents. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/incident' } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ], $defs: { incident: { type: 'object', properties: { id: { type: 'string' }, affected_views: { type: 'integer' }, affected_views_per_hour: { type: 'integer' }, affected_views_per_hour_on_open: { type: 'integer' }, breakdowns: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, name: { type: 'string' }, value: { type: 'string' } }, required: [ 'id', 'name', 'value' ] } }, description: { type: 'string' }, error_description: { type: 'string' }, impact: { type: 'string' }, incident_key: { type: 'string' }, measured_value: { type: 'number' }, measured_value_on_close: { type: 'number' }, measurement: { type: 'string' }, notification_rules: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' },…

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. List all of the values across every breakdown for a specific metric. # Response Schema ```json { $ref: '#/$defs/all_metric_values_response', $defs: { all_metric_values_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { name: { type: 'string' }, ended_views: { type: 'integer' }, items: { type: 'array', items: { type: 'object', properties: { metric: { type: 'string' }, name: { type: 'string' }, type: { type: 'string' }, value: { type: 'number' }, measurement: { type: 'string' } }, required: [ 'metric', 'name', 'type', 'value' ] } }, metric: { type: 'string' }, started_views: { type: 'integer' }, total_playing_time: { type: 'integer' }, type: { type: 'string' }, unique_viewers: { type: 'integer' }, value: { type: 'number' }, view_count: { type: 'integer'…

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns a list of video views which match the filters and have a `view_end` within the specified timeframe. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/abridged_video_view' } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ], $defs: { abridged_video_view: { type: 'object', properties: { id: { type: 'string' }, country_code: { type: 'string' }, error_type_id: { type: 'integer' }, playback_failure: { type: 'boolean' }, player_error_code: { type: 'string' }, player_error_message: { type: 'string' }, total_row_count: { type: 'integer' }, video_title: { type: 'string' }, view_end: { type: 'string' }, view_start: { type: 'string' }, viewer_application_name: { type: 'string' }, viewer_experience_score: { type: 'number' }, viewer_os_family: { type: 'string' }, watch_time: { type: 'integer' } }, required: [ 'id', 'country_code', 'error_type_id', 'playback_failure', 'player_error_code', 'player_error_message', 'total_row_count', 'video_title', 'view_end', 'view_start', 'viewer_application_name', 'viewer_experience_score', 'viewer_os_family', 'watch_time'…

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Lists available monitoring dimensions. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { display_name: { type: 'string' }, name: { type: 'string' } }, required: [ 'display_name', 'name' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Lists available real-time dimensions. This API is now deprecated, please use the `List Monitoring Dimensions` API. # Response Schema ```json { $ref: '#/$defs/real_time_dimensions_response', $defs: { real_time_dimensions_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { display_name: { type: 'string' }, name: { type: 'string' } }, required: [ 'display_name', 'name' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } } } ```

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Lists available real-time metrics. This API is now deprecated, please use the `List Monitoring Metrics` API. # Response Schema ```json { $ref: '#/$defs/real_time_metrics_response', $defs: { real_time_metrics_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { display_name: { type: 'string' }, name: { type: 'string' } }, required: [ 'display_name', 'name' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } } } ```