{ "opencollection": "1.0.0", "info": { "name": "Wowza Video REST API Reference Documentation", "version": "v2.0" }, "items": [ { "info": { "name": "live_streams", "type": "folder" }, "items": [ { "info": { "name": "Fetch all live streams", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/live_streams", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index.\n\nFor valid filter operators and filter fields, see [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**filter[0][field]=state&filter[0][eq]=stopped**" }, { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "This operation shows limited details for all of your live streams. For detailed information, fetch a single live stream." }, { "info": { "name": "Create a live stream", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/live_streams", "body": { "type": "json", "data": "{}" } }, "docs": "This operation creates a live stream." }, { "info": { "name": "Fetch a live stream", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/live_streams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." } ] }, "docs": "This operation shows the details of a specific live stream." }, { "info": { "name": "Update a live stream", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/live_streams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates a live stream." }, { "info": { "name": "Delete a live stream", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/live_streams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." } ] }, "docs": "This operation deletes a live stream, including all assigned outputs and targets.

Note: You can't remove live streams that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. " }, { "info": { "name": "Start a live stream", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/live_streams/:id/start", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." } ] }, "docs": "This operation starts a live stream." }, { "info": { "name": "Stop a live stream", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/live_streams/:id/stop", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." } ] }, "docs": "This operation stops a live stream." }, { "info": { "name": "Reset a live stream", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/live_streams/:id/reset", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." } ] }, "docs": "This operation resets a live stream." }, { "info": { "name": "Regenerate the connection code for a live stream", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/live_streams/:id/regenerate_connection_code", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." } ] }, "docs": "This operation regenerates the connection code of a live stream." }, { "info": { "name": "Fetch the thumbnail URL of a live stream", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/live_streams/:id/thumbnail_url", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." } ] }, "docs": "This operation shows the thumbnail URL of a started live stream." }, { "info": { "name": "Fetch the state of a live stream", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/live_streams/:id/state", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." } ] }, "docs": "This operation shows the current state of a live stream." } ] }, { "info": { "name": "players", "type": "folder" }, "items": [ { "info": { "name": "Fetch all players", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/players", "params": [ { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\n\nThis operation shows limited details for all of your players. For detailed information, fetch a single player." }, { "info": { "name": "Fetch a player", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/players/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player." } ] }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\nThis operation shows details of a specific player." }, { "info": { "name": "Update a player", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/players/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\nThis operation updates a player." }, { "info": { "name": "Rebuild player code", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/players/:id/rebuild", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player." } ] }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\nThis operation rebuilds the player with the current configuration." }, { "info": { "name": "Fetch the state of a player", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/players/:id/state", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player." } ] }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\nThis operation shows the current state of a player." }, { "info": { "name": "Fetch all player URLs", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/players/:player_id/urls", "params": [ { "name": "player_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player." } ] }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\nThis operation shows the details of all player URLs." }, { "info": { "name": "Create a player URL", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/players/:player_id/urls", "params": [ { "name": "player_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\nThis operation creates a new player URL." }, { "info": { "name": "Fetch a player URL", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/players/:player_id/urls/:id", "params": [ { "name": "player_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player." }, { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player URL." } ] }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\nThis operation shows the details of a player URL." }, { "info": { "name": "Update a player URL", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/players/:player_id/urls/:id", "params": [ { "name": "player_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player." }, { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player URL." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\nThis operation updates a player URL." }, { "info": { "name": "Delete a player URL", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/players/:player_id/urls/:id", "params": [ { "name": "player_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player." }, { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the player URL." } ] }, "docs": "
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
\nThis operation deletes a player URL." } ] }, { "info": { "name": "assets", "type": "folder" }, "items": [ { "info": { "name": "Fetch all assets", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/assets", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Restricts the data that gets returned by filtering on one or more values associated with a field. For more information and examples, see the technical article [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**filter[0][field]=created_at&filter[0][gte]=2021-07-14T17:47:45.000Z**" }, { "name": "query", "value": "", "type": "query", "description": "Restricts the data that gets returned by querying on one or more values associated with a set of fields. For more information and examples, see the technical article [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**sort_direction=desc&sort_column=created_at&per_page=30&state=completed&query=sample**" }, { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation shows limited details for all of your assets. For detailed information, fetch a single asset." }, { "info": { "name": "Create an asset", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/assets", "body": { "type": "json", "data": "{}" } }, "docs": "
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation creates an asset. You can only upload MP4 format and H.264 and AAC encoded files. Any files with unsupported codecs are rejected." }, { "info": { "name": "Fetch an asset", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/assets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the asset." } ] }, "docs": "
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation shows the details of a specific asset.\n\nThe fields returned vary depending on when you send this request. For example, if a resource hasn't been created yet during the processing state, you won't see **available_renditions** in the response.\n\n**Tip**: If your original upload URL expired and you need a new one for an asset, send this request an" }, { "info": { "name": "Update an asset", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/assets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation updates an asset. Assets must be uploaded and complete processing before they can be updated.\n\nThe fields returned vary depending on when you send this request. For example, if a stream doesn't have unique viewer data, you won't see **unique_viewers** in the response." }, { "info": { "name": "Delete an asset", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/assets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the asset." } ] }, "docs": "
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation deletes an asset, including all assigned outputs and targets." }, { "info": { "name": "Restream an asset", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/assets/:id/live_streams", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the asset." } ] }, "docs": "
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation returns a live stream ID you can use to re-stream an uploaded asset." }, { "info": { "name": "Fetch all asset tags", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/asset_tags", "params": [ { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation retrieves a list of all of the tags that have been used previously by an organization." }, { "info": { "name": "Report asset as uploaded", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/assets/:id/upload_completed", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
\nThis operation reports that an asset was successfully uploaded to storage." }, { "info": { "name": "Report asset upload as failed", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/assets/:id/upload_failed", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation reports that an asset uploaded to storage failed. You can only upload MP4 format and H.264 and AAC encoded files. Any files with unsupported codecs are rejected." } ] }, { "info": { "name": "recordings", "type": "folder" }, "items": [ { "info": { "name": "Fetch all recordings", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/recordings", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index.\n\nFor valid filter operators and filter fields, see [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**filter[0][field]=state&filter[0][eq]=stopped**" }, { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
\nThis operation shows limited details for all of your recordings. For detailed information, fetch a single recording." }, { "info": { "name": "Fetch a recording", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/recordings/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the recording." } ] }, "docs": "
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
\nThis operation shows the details of a specific recording." }, { "info": { "name": "Delete a recording", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/recordings/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the recording." } ] }, "docs": "
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation deletes a recording.

Note: You can't remove recordings that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. " }, { "info": { "name": "Fetch the state of a recording", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/recordings/:id/state", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the recording." } ] }, "docs": "
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
\n\nThis operation shows the current state of a recording." } ] }, { "info": { "name": "schedules", "type": "folder" }, "items": [ { "info": { "name": "Fetch all schedules", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/schedules", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index.\n\nFor valid filter operators and filter fields, see [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**filter[0][field]=state&filter[0][eq]=stopped**" }, { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "This operation shows the details of all of your schedules." }, { "info": { "name": "Create a schedule", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/schedules", "body": { "type": "json", "data": "{}" } }, "docs": "This operation creates a schedule." }, { "info": { "name": "Fetch a schedule", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/schedules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the schedule." } ] }, "docs": "This operation shows the details of a specific schedule." }, { "info": { "name": "Update a schedule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/schedules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the schedule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates a schedule." }, { "info": { "name": "Delete a schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/schedules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the schedule." } ] }, "docs": "This operation deletes a schedule." }, { "info": { "name": "Enable a schedule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/schedules/:id/enable", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the schedule." } ] }, "docs": "This operation enables a schedule." }, { "info": { "name": "Disable a schedule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/schedules/:id/disable", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the schedule." } ] }, "docs": "This operation disables a schedule." }, { "info": { "name": "Fetch the state of a schedule", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/schedules/:id/state", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the schedule." } ] }, "docs": "This operation shows the current state of a schedule." } ] }, { "info": { "name": "stream_sources", "type": "folder" }, "items": [ { "info": { "name": "Fetch all stream sources", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_sources", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index.\n\nFor valid filter operators and filter fields, see [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**filter[0][field]=state&filter[0][eq]=stopped**" }, { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "This operation shows limited details for all of your stream sources. For detailed information, fetch a single stream source of the appropriate type." }, { "info": { "name": "Create a Wowza stream source", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/stream_sources/wowza", "body": { "type": "json", "data": "{}" } }, "docs": "(Available from version 1.4) This operation creates a Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection." }, { "info": { "name": "Fetch a Wowza stream source", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_sources/wowza/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the Wowza stream source." } ] }, "docs": "(Available from version 1.4) This operation shows details of a specific Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection." }, { "info": { "name": "Update a Wowza stream source", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/stream_sources/wowza/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the Wowza stream source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "(Available from version 1.4) This operation updates a Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection. " }, { "info": { "name": "Delete a Wowza stream source", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/stream_sources/wowza/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the Wowza stream source." } ] }, "docs": "(Available from version 1.4) This operation deletes a Wowza stream source." } ] }, { "info": { "name": "stream_targets", "type": "folder" }, "items": [ { "info": { "name": "Fetch all stream targets", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_targets", "params": [ { "name": "assignable", "value": "", "type": "query", "description": "Returns stream targets that are assignable to an output. \nIf **true**, all assignable stream targets are included in the response. \nIf the parameter isn't used, all assignable and unassignable stream targets are included in the response.\n\n\n\nA **primary_stream_target** is a single stream target that automatically \ngets created for all output renditions (the ABR ladder) created when you create a live stream \nthrough a live stream flow. **Primary_stream_targets** cannot be deleted or reassigned so they will not\nbe listed when using the assignable parameter.\n\n Example:\n **api.video.wowza.com/api/v2.0/stream_targets?assignable=true**" }, { "name": "filter", "value": "", "type": "query", "description": "Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index.\n\nFor valid filter operators and filter fields, see [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**filter[0][field]=state&filter[0][eq]=stopped**" }, { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "This operation lists limited details for custom stream targets and Wowza CDN stream targets. For detailed information, fetch a single stream target of a specific type." }, { "info": { "name": "Fetch a stream target", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." } ] }, "docs": "This operation shows the details of a specific stream target whether it be a Wowza CDN, custom, Facebook Live, or LinkedIn Live stream target." }, { "info": { "name": "Fetch all custom stream targets", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/custom", "params": [ { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "This operation lists limited details for all of your custom stream targets. For detailed information, fetch a single custom stream target." }, { "info": { "name": "Create a custom stream target", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/custom", "body": { "type": "json", "data": "{}" } }, "docs": "This operation creates a custom stream target for an external, third-party destination." }, { "info": { "name": "Fetch a custom stream target", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/custom/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the custom stream target." } ] }, "docs": "This operation shows the details of a specific custom stream target." }, { "info": { "name": "Update a custom stream target", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/custom/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the custom stream target." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates a custom stream target." }, { "info": { "name": "Delete a custom stream target", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/custom/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the custom stream target." }, { "name": "force", "value": "", "type": "query", "description": "When `true`, forces a hard delete by first disconnecting the stream target from any associated transcoder and then deleting it." } ] }, "docs": "This operation deletes a custom stream target.

Note: You can't remove stream targets that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. " }, { "info": { "name": "Fetch all Wowza CDN stream targets", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/wowza_cdn", "params": [ { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "(Available from version 1.4) This operation lists limited details for all of your Wowza CDN stream targets. For detailed information, fetch a single target." }, { "info": { "name": "Create a Wowza CDN stream target", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/wowza_cdn", "body": { "type": "json", "data": "{}" } }, "docs": "(Available from version 1.4) This operation creates a Wowza CDN stream target to deliver your stream using the Wowza CDN." }, { "info": { "name": "Fetch a Wowza CDN stream target", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/wowza_cdn/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." } ] }, "docs": "(Available from version 1.4) This operation shows the details of a specific Wowza CDN stream target." }, { "info": { "name": "Update a Wowza CDN stream target", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/wowza_cdn/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." } ], "body": { "type": "json", "data": "{}" } }, "docs": "(Available from version 1.4) This operation updates a Wowza CDN stream target." }, { "info": { "name": "Delete a Wowza CDN stream target", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/wowza_cdn/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." }, { "name": "force", "value": "", "type": "query", "description": "When `true`, forces a hard delete by first disconnecting the stream target from any associated transcoder and then deleting it." } ] }, "docs": "(Available from version 1.4) This operation deletes a Wowza CDN stream target.

Note: You can't remove stream targets that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. " }, { "info": { "name": "Regenerate the connection code for any stream target", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/:id/regenerate_connection_code", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." } ] }, "docs": "This operation regenerates the connection code of any kind of stream target." }, { "info": { "name": "Fetch all properties of a stream target", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/:stream_target_id/properties", "params": [ { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." } ] }, "docs": "This operation shows the details of all of the properties assigned to a specific stream target. The properties returned will depend on the *provider* you are using and are noted in the key descriptions below.\n\n\n For a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video\n REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api)." }, { "info": { "name": "Configure a property for a stream target", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/:stream_target_id/properties", "params": [ { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation configures a property for a stream target. The properties available will depend on the *provider* you are using and are noted in the key descriptions below. For example, if you are using the provider **Wowza CDN on Fastly**, look for that in the descriptions.\n\nFor a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api)" }, { "info": { "name": "Fetch a property of a stream target", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/:stream_target_id/properties/:id", "params": [ { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." }, { "name": "id", "value": "", "type": "path", "description": "The unique string that identifies the stream target property. The string contains the *section* and the *key*, connected by a dash. For example, **hls-chunkSize**." } ] }, "docs": "This operation shows the details of a specific property assigned to a specific stream target. The properties returned will depend on the *provider* you are using and are noted in the key descriptions below. \n\n\n For a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video\n REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api)." }, { "info": { "name": "Delete a stream target property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/stream_targets/:stream_target_id/properties/:id", "params": [ { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." }, { "name": "id", "value": "", "type": "path", "description": "The unique string that identifies the stream target property. The string contains the *section* and the *key*, connected by a dash. For example, **hls-chunkSize**." } ] }, "docs": "This operation removes a property from a stream target." } ] }, { "info": { "name": "transcoders", "type": "folder" }, "items": [ { "info": { "name": "Fetch all transcoders", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index.\n\nFor valid filter operators and filter fields, see [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**filter[0][field]=state&filter[0][eq]=stopped**" }, { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "This operation shows limited details for all of your transcoders. For detailed information, fetch a single transcoder." }, { "info": { "name": "Create a transcoder", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/transcoders", "body": { "type": "json", "data": "{}" } }, "docs": "This operation creates a transcoder." }, { "info": { "name": "Fetch a transcoder", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation shows the details of a specific transcoder." }, { "info": { "name": "Update a transcoder", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates a transcoder." }, { "info": { "name": "Delete a transcoder", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation deletes a transcoder, including all of its assigned output renditions and stream targets.

Note: You can't remove transcoders that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. " }, { "info": { "name": "Enable a transcoder's stream targets", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/enable_all_stream_targets", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation enables all of the stream targets assigned to a specific transcoder." }, { "info": { "name": "Disable a transcoder's stream targets", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/disable_all_stream_targets", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation disables all of the stream targets assigned to a specific transcoder." }, { "info": { "name": "Start a transcoder", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/start", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation starts a transcoder." }, { "info": { "name": "Stop a transcoder", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/stop", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation stops a transcoder." }, { "info": { "name": "Reset a transcoder", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/reset", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation resets a transcoder." }, { "info": { "name": "Start recording", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/start_recording", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation starts the recording of a transcoder after the transcoder has started.\nIf you want the recording to start and stop automatically when you start or stop the transcoder instead, set _recording_ to **true** when you create a transcoder or update a transcoder." }, { "info": { "name": "Stop recording", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/stop_recording", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation stops the recording of a transcoder before the transcoder has stopped. Wowza Video begins converting the recording to an MP4 file after the transcoder has stopped. You can use this operation to manually stop recording even if _recording_ is set to **true** on the transcoder, meaning the recording was automatically started at transcoder start.\nIf you want the recording to start and stop automatically when you start and stop the transcoder, set _recording_ to **true** when you creat" }, { "info": { "name": "Fetch a transcoder's recordings", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/recordings", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "
Deprecated in 2.0.
\nThis operation shows limited details of all of the recordings for a specific transcoder. For detailed information about a recording, use the recording ID to fetch a recording." }, { "info": { "name": "Fetch transcoder's schedules", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/schedules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation shows the details of all of the schedules for a specific transcoder." }, { "info": { "name": "Fetch the thumbnail URL of a transcoder", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/thumbnail_url", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation shows the thumbnail URL of a started transcoder." }, { "info": { "name": "Fetch the state and uptime ID of a transcoder", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/state", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation shows the current state and uptime ID of a transcoder." }, { "info": { "name": "Fetch all VOD streams for a transcoder", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:id/vod_streams", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "(Available from version 1.5) This operation shows the details of all VOD streams associated to a specific transcoder." }, { "info": { "name": "Fetch all uptime records for a transcoder", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/uptimes", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "page", "value": "", "type": "query", "description": "Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is **1**. \n\n For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api)." }, { "name": "per_page", "value": "", "type": "query", "description": "For use with the *page* parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is **1000**." } ] }, "docs": "This operation shows all of the uptime records for a specific transcoder. An *uptime record* identifies a specific transcoding session." }, { "info": { "name": "Fetch an uptime record", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/uptimes/:id", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the uptime record." } ] }, "docs": "This operation shows the details of a specific uptime record for a specific transcoder. An *uptime record* identifies a transcoding session." }, { "info": { "name": "Fetch all outputs of a transcoder", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation shows the details of all of the output renditions of a specific transcoder." }, { "info": { "name": "Create an output", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation creates an output rendition for a specific transcoder. You can create up to 10 outputs per transcoder." }, { "info": { "name": "Fetch an output", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:id", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." } ] }, "docs": "This operation shows the details of a specific output rendition for a specific transcoder." }, { "info": { "name": "Update an output", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:id", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates an output rendition." }, { "info": { "name": "Delete an output", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:id", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." } ] }, "docs": "This operation deletes an output, including all of its assigned targets." }, { "info": { "name": "Fetch all output stream targets of an output of a transcoder", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "output_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." } ] }, "docs": "This operation shows the details of all of the output stream targets of an output of a transcoder." }, { "info": { "name": "Create an output stream target", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "output_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation creates an output stream target, assigning the stream target to the specified output rendition. " }, { "info": { "name": "Fetch an output stream target", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_id", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "output_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." }, { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target.\n\n**Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target." } ] }, "docs": "This operation shows the details of an output stream target." }, { "info": { "name": "Update an output stream target", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_id", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "output_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." }, { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target.\n\n**Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates an output stream target." }, { "info": { "name": "Delete an output stream target", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_id", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "output_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." }, { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target.\n\n**Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target." } ] }, "docs": "This operation deletes an output stream target, including all of its assigned targets." }, { "info": { "name": "Enable an output stream target", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_id/enable", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "output_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." }, { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target.\n\n**Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target." } ] }, "docs": "This operation enables an output stream target." }, { "info": { "name": "Disable an output stream target", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_id/disable", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "output_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." }, { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target.\n\n**Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target." } ] }, "docs": "This operation disables an output stream target." }, { "info": { "name": "Restart an output stream target", "type": "http" }, "http": { "method": "PUT", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/outputs/:output_id/output_stream_targets/:stream_target_id/restart", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "output_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the output rendition." }, { "name": "stream_target_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target.\n\n**Tip:** If you're using both the primary and backup URL for a stream target, send *output_stream_target_id* in the path instead. *output_stream_target_id* was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target." } ] }, "docs": "This operation restarts an output stream target." }, { "info": { "name": "Fetch a transcoder's properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/properties", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ] }, "docs": "This operation shows all of the properties of a specific transcoder." }, { "info": { "name": "Configure a property for a transcoder", "type": "http" }, "http": { "method": "POST", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/properties", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation configures a single property or an array of properties for a transcoder.\n\nFor a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api)." }, { "info": { "name": "Fetch a property for a transcoder", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/properties/:id", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "id", "value": "", "type": "path", "description": "The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, **cupertino-aes128Secret**." } ] }, "docs": "This operation shows the details of a specific property for a specific transcoder." }, { "info": { "name": "Delete a transcoder's property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.video.wowza.com/api/v2.0/transcoders/:transcoder_id/properties/:id", "params": [ { "name": "transcoder_id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the transcoder." }, { "name": "id", "value": "", "type": "path", "description": "The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, **cupertino-aes128Secret**." } ] }, "docs": "This operation deletes a specific property from a specific transcoder." } ] }, { "info": { "name": "analytics_viewers", "type": "folder" }, "items": [ { "info": { "name": "Fetch viewer analytics data for an account", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/analytics/viewers/account", "params": [ { "name": "from", "value": "", "type": "query", "description": "Use this parameter, along with **to**, to return historic viewer data. \n\nThe start of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **from** query parameter without setting the **to** query parameter, the data returned will reflect 30 days starting at the from date, or data up to to the current day, whichever is shorter.\n\nExample:\n**2024-03-14T10:31:54.486Z**" }, { "name": "to", "value": "", "type": "query", "description": "Use this parameter, along with **from**, to return historic viewer data. \n\n\nThe end of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **to** query parameter without setting the **from** query parameter, the data returned will be from the past 30 days or from your last invoice date, whichever is shorter.\n\nExample:\n**2024-04-13T10:31:54.486Z**" }, { "name": "include", "value": "", "type": "query", "description": "Specify the data you want returned in the response. You can send a comma-separated list of values.\n\nValid values are: **countries**, **renditions**, **devices**, and **trend**.\n\nExample:\n**countries,trend**" }, { "name": "time_zone", "value": "", "type": "query", "description": "Specify the time zone you want the returned data to reflect. \n\n
Click to expand for the full list of valid values\n\n\n | Locations | Wowza Video time_zone value |\n |---|---|\n | International Date Line West | Etc/GMT+12 |\n | Midway Island | Pacific/Midway |\n | American Samoa | Pacific/Pago_Pago |\n | Hawaii | Pacific/Honolulu |\n | Alaska | America/Juneau |\n | Pacific Time (US & Canada) | America/Los_Angeles |\n | Tijuana | America/Tijuana |\n | Mountain Time (US & Canada) | America/Denver |\n | Arizona | America/Phoenix |\n | Chihuahua | America/Chihuahua |\n | Mazatlan | America/Mazatlan |\n | Central Time (US & Canada) | America/Chicago |\n | Saskatchewan | America/Regina |\n | Guadalajara | America/Mexico_City |\n | Mexico City | America/Mexico_City |\n | Monterrey | America/Monterrey |\n | Central America | America/Guatemala |\n | Eastern Time (US & Canada) | America/New_York |\n | Indiana (East) | America/Indiana/Indianapolis |\n | Bogota | America/Bogota |\n | Lima | America/Lima |\n | Quito | America/Lima |\n | Atlantic Time (Canada) | America/Halifax |\n | Caracas | America/Caracas |\n | La Paz | America/La_Paz |\n | Santiago | America/Santiago |\n | Newfoundland | America/St_Johns |\n | Brasilia | America/Sao_Paulo |\n | Buenos Aires | America/Argentina/Buenos_Aires |\n | Montevideo | America/Montevideo |\n | Georgetown | America/Guyana |\n | Puerto Rico | America/Puerto_Rico |\n | Greenland | America/Godthab |\n | Mid-Atlantic | Atlantic/South_Georgia |\n | Azores | Atlantic/Azores |\n | Cape Verde Is. | Atlantic/Cape_Verde |\n | Dublin | Europe/Dublin |\n | Edinburgh | Europe/London |\n | Lisbon | Europe/Lisbon |\n | London | Europe/London |\n | Casablanca | Africa/Casablanca |\n | Monrovia | Africa/Monrovia |\n | UTC | Etc/UTC |\n | Belgrade | Europe/Belgrade |\n | Bratislava | Europe/Bratislava |\n | Budapest | Europe/Budapest |\n | Ljubljana | Europe/Ljubljana |\n | Prague | Europe/Prague |\n | Sarajevo | Europe/Sarajevo |\n | Skopje | Europe/Skopje |\n | Warsaw | Europe/Warsaw |\n | Zagreb | Europe/Zagreb |\n | Brussels | Europe/Brussels |\n | Copenhagen | Europe/Copenhagen |\n | Madrid | Europe/Madrid |\n | Paris | Europe/Paris |\n | Amsterdam | Europe/Amsterdam |\n | Berlin | Europe/Berlin |\n | Bern | Europe/Zurich |\n | Zurich | Europe/Zurich |\n | Rome | Europe/Rome |\n | Stockholm | Europe/Stockholm |\n | Vienna | Europe/Vienna |\n | West Central Africa | Africa/Algiers |\n | Bucharest | Europe/Bucharest |\n | Cairo | Africa/Cairo |\n | Helsinki | Europe/Helsinki |\n | Kyiv | Europe/Kiev |\n | Riga | Europe/Riga |\n | Sofia | Europe/Sofia |\n | Tallinn | Europe/Tallinn |\n | Vilnius | Europe/Vilnius |\n | Athens | Europe/Athens |\n | Istanbul | Europe/Istanbul |\n | Minsk | Europe/Minsk |\n | Jerusalem | Asia/Jerusalem |\n | Harare | Africa/Harare |\n | Pretoria | Africa/Johannesburg |\n | Kaliningrad | Europe/Kaliningrad |\n | Moscow | Europe/Moscow |\n | St. Petersburg | Europe/Moscow |\n | Volgograd | Europe/Volgograd |\n | Samara | Europe/Samara |\n | Kuwait | Asia/Kuwait |\n | Riyadh | Asia/Riyadh |\n | Nairobi | Africa/Nairobi |\n | Baghdad | Asia/Baghdad |\n | Tehran | Asia/Tehran |\n | Abu Dhabi | Asia/Muscat |\n | Muscat | Asia/Muscat |\n | Baku | Asia/Baku |\n | Tbilisi | Asia/Tbilisi |\n | Yerevan | Asia/Yerevan |\n | Kabul | Asia/Kabul |\n | Ekaterinburg | Asia/Yekaterinburg |\n | Islamabad | Asia/Karachi |\n | Karachi | Asia/Karachi |\n | Tashkent | Asia/Tashkent |\n | Chennai | Asia/Kolkata |\n | Kolkata | Asia/Kolkata |\n | Mumbai | Asia/Kolkata |\n | New Delhi | Asia/Kolkata |\n | Kathmandu | Asia/Kathmandu |\n | Astana | Asia/Dhaka |\n | Dhaka | Asia/Dhaka |\n | Sri Jayawardenepura | Asia/Colombo |\n | Almaty | Asia/Almaty |\n | Novosibirsk | Asia/Novosibirsk |\n | Rangoon | Asia/Rangoon |\n | Bangkok | Asia/Bangkok |\n | Hanoi | Asia/Bangkok |\n | Jakarta | Asia/Jakarta |\n | Krasnoyarsk | Asia/Krasnoyarsk |\n | Beijing | Asia/Shanghai |\n | Chongqing | Asia/Chongqing |\n | Hong Kong | Asia/Hong_Kong |\n | Urumqi | Asia/Urumqi |\n | Kuala Lumpur | Asia/Kuala_Lumpur |\n | Singapore | Asia/Singapore |\n | Taipei | Asia/Taipei |\n | Perth | Australia/Perth |\n | Irkutsk | Asia/Irkutsk |\n | Ulaanbaatar | Asia/Ulaanbaatar |\n | Seoul | Asia/Seoul |\n | Osaka | Asia/Tokyo |\n | Sapporo | Asia/Tokyo |\n | Tokyo | Asia/Tokyo |\n | Yakutsk | Asia/Yakutsk |\n | Darwin | Australia/Darwin |\n | Adelaide | Australia/Adelaide |\n | Canberra | Australia/Melbourne |\n | Melbourne | Australia/Melbourne |\n | Sydney | Australia/Sydney |\n | Brisbane | Australia/Brisbane |\n | Hobart | Australia/Hobart |\n | Vladivostok | Asia/Vladivostok |\n | Guam | Pacific/Guam |\n | Port Moresby | Pacific/Port_Moresby |\n | Magadan | Asia/Magadan |\n | Srednekolymsk | Asia/Srednekolymsk |\n | Solomon Is. | Pacific/Guadalcanal |\n | New Caledonia | Pacific/Noumea |\n | Fiji | Pacific/Fiji |\n | Kamchatka | Asia/Kamchatka |\n | Marshall Is. | Pacific/Majuro |\n | Auckland | Pacific/Auckland |\n | Wellington | Pacific/Auckland |\n | Nuku'alofa | Pacific/Tongatapu |\n | Tokelau Is. | Pacific/Fakaofo |\n | Chatham Is. | Pacific/Chatham |\n | Samoa | Pacific/Apia |\n\n
\n\n**Default:** `Etc/UTC`\n\n**Example:** `America/New_York`" } ] }, "docs": "(Available from version 1.11) This operation returns live and historic viewer data for the account related to the JSON web token used for API authentication. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data. \n\n**Querying live data**\n\n1. To get data for currently live streams, do not send **from** and **to** values.\n2. Use the **include** query parameter to specify what data you want to return, including: countries, renditions, devices, and" }, { "info": { "name": "Fetch viewer analytics data for a live stream", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/analytics/viewers/live_streams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the live stream." }, { "name": "from", "value": "", "type": "query", "description": "Use this parameter, along with **to**, to return historic viewer data. \n\nThe start of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **from** query parameter without setting the **to** query parameter, the data returned will reflect 30 days starting at the **from** date, or data up to to the current day, whichever is shorter.\n\nExample:\n**2024-03-14T10:31:54.486Z**" }, { "name": "to", "value": "", "type": "query", "description": "Use this parameter, along with **from**, to return historic viewer data. \n\n\nThe end of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **to** query parameter without setting the **from** query parameter, the data returned will be from the past 30 days or from your last invoice date, whichever is shorter.\n\nExample:\n**2024-04-13T10:31:54.486Z**" }, { "name": "include", "value": "", "type": "query", "description": "Specify the data you want returned in the response. You can send a comma-separated list of values.\n\nValid values are: **countries**, **renditions**, **devices**, and **trend**.\n\nExample:\n**countries,trend**" }, { "name": "time_zone", "value": "", "type": "query", "description": "Specify the time zone you want the returned data to reflect. \n\n
Click to expand for the full list of valid values\n\n\n | Locations | Wowza Video time_zone value |\n |---|---|\n | International Date Line West | Etc/GMT+12 |\n | Midway Island | Pacific/Midway |\n | American Samoa | Pacific/Pago_Pago |\n | Hawaii | Pacific/Honolulu |\n | Alaska | America/Juneau |\n | Pacific Time (US & Canada) | America/Los_Angeles |\n | Tijuana | America/Tijuana |\n | Mountain Time (US & Canada) | America/Denver |\n | Arizona | America/Phoenix |\n | Chihuahua | America/Chihuahua |\n | Mazatlan | America/Mazatlan |\n | Central Time (US & Canada) | America/Chicago |\n | Saskatchewan | America/Regina |\n | Guadalajara | America/Mexico_City |\n | Mexico City | America/Mexico_City |\n | Monterrey | America/Monterrey |\n | Central America | America/Guatemala |\n | Eastern Time (US & Canada) | America/New_York |\n | Indiana (East) | America/Indiana/Indianapolis |\n | Bogota | America/Bogota |\n | Lima | America/Lima |\n | Quito | America/Lima |\n | Atlantic Time (Canada) | America/Halifax |\n | Caracas | America/Caracas |\n | La Paz | America/La_Paz |\n | Santiago | America/Santiago |\n | Newfoundland | America/St_Johns |\n | Brasilia | America/Sao_Paulo |\n | Buenos Aires | America/Argentina/Buenos_Aires |\n | Montevideo | America/Montevideo |\n | Georgetown | America/Guyana |\n | Puerto Rico | America/Puerto_Rico |\n | Greenland | America/Godthab |\n | Mid-Atlantic | Atlantic/South_Georgia |\n | Azores | Atlantic/Azores |\n | Cape Verde Is. | Atlantic/Cape_Verde |\n | Dublin | Europe/Dublin |\n | Edinburgh | Europe/London |\n | Lisbon | Europe/Lisbon |\n | London | Europe/London |\n | Casablanca | Africa/Casablanca |\n | Monrovia | Africa/Monrovia |\n | UTC | Etc/UTC |\n | Belgrade | Europe/Belgrade |\n | Bratislava | Europe/Bratislava |\n | Budapest | Europe/Budapest |\n | Ljubljana | Europe/Ljubljana |\n | Prague | Europe/Prague |\n | Sarajevo | Europe/Sarajevo |\n | Skopje | Europe/Skopje |\n | Warsaw | Europe/Warsaw |\n | Zagreb | Europe/Zagreb |\n | Brussels | Europe/Brussels |\n | Copenhagen | Europe/Copenhagen |\n | Madrid | Europe/Madrid |\n | Paris | Europe/Paris |\n | Amsterdam | Europe/Amsterdam |\n | Berlin | Europe/Berlin |\n | Bern | Europe/Zurich |\n | Zurich | Europe/Zurich |\n | Rome | Europe/Rome |\n | Stockholm | Europe/Stockholm |\n | Vienna | Europe/Vienna |\n | West Central Africa | Africa/Algiers |\n | Bucharest | Europe/Bucharest |\n | Cairo | Africa/Cairo |\n | Helsinki | Europe/Helsinki |\n | Kyiv | Europe/Kiev |\n | Riga | Europe/Riga |\n | Sofia | Europe/Sofia |\n | Tallinn | Europe/Tallinn |\n | Vilnius | Europe/Vilnius |\n | Athens | Europe/Athens |\n | Istanbul | Europe/Istanbul |\n | Minsk | Europe/Minsk |\n | Jerusalem | Asia/Jerusalem |\n | Harare | Africa/Harare |\n | Pretoria | Africa/Johannesburg |\n | Kaliningrad | Europe/Kaliningrad |\n | Moscow | Europe/Moscow |\n | St. Petersburg | Europe/Moscow |\n | Volgograd | Europe/Volgograd |\n | Samara | Europe/Samara |\n | Kuwait | Asia/Kuwait |\n | Riyadh | Asia/Riyadh |\n | Nairobi | Africa/Nairobi |\n | Baghdad | Asia/Baghdad |\n | Tehran | Asia/Tehran |\n | Abu Dhabi | Asia/Muscat |\n | Muscat | Asia/Muscat |\n | Baku | Asia/Baku |\n | Tbilisi | Asia/Tbilisi |\n | Yerevan | Asia/Yerevan |\n | Kabul | Asia/Kabul |\n | Ekaterinburg | Asia/Yekaterinburg |\n | Islamabad | Asia/Karachi |\n | Karachi | Asia/Karachi |\n | Tashkent | Asia/Tashkent |\n | Chennai | Asia/Kolkata |\n | Kolkata | Asia/Kolkata |\n | Mumbai | Asia/Kolkata |\n | New Delhi | Asia/Kolkata |\n | Kathmandu | Asia/Kathmandu |\n | Astana | Asia/Dhaka |\n | Dhaka | Asia/Dhaka |\n | Sri Jayawardenepura | Asia/Colombo |\n | Almaty | Asia/Almaty |\n | Novosibirsk | Asia/Novosibirsk |\n | Rangoon | Asia/Rangoon |\n | Bangkok | Asia/Bangkok |\n | Hanoi | Asia/Bangkok |\n | Jakarta | Asia/Jakarta |\n | Krasnoyarsk | Asia/Krasnoyarsk |\n | Beijing | Asia/Shanghai |\n | Chongqing | Asia/Chongqing |\n | Hong Kong | Asia/Hong_Kong |\n | Urumqi | Asia/Urumqi |\n | Kuala Lumpur | Asia/Kuala_Lumpur |\n | Singapore | Asia/Singapore |\n | Taipei | Asia/Taipei |\n | Perth | Australia/Perth |\n | Irkutsk | Asia/Irkutsk |\n | Ulaanbaatar | Asia/Ulaanbaatar |\n | Seoul | Asia/Seoul |\n | Osaka | Asia/Tokyo |\n | Sapporo | Asia/Tokyo |\n | Tokyo | Asia/Tokyo |\n | Yakutsk | Asia/Yakutsk |\n | Darwin | Australia/Darwin |\n | Adelaide | Australia/Adelaide |\n | Canberra | Australia/Melbourne |\n | Melbourne | Australia/Melbourne |\n | Sydney | Australia/Sydney |\n | Brisbane | Australia/Brisbane |\n | Hobart | Australia/Hobart |\n | Vladivostok | Asia/Vladivostok |\n | Guam | Pacific/Guam |\n | Port Moresby | Pacific/Port_Moresby |\n | Magadan | Asia/Magadan |\n | Srednekolymsk | Asia/Srednekolymsk |\n | Solomon Is. | Pacific/Guadalcanal |\n | New Caledonia | Pacific/Noumea |\n | Fiji | Pacific/Fiji |\n | Kamchatka | Asia/Kamchatka |\n | Marshall Is. | Pacific/Majuro |\n | Auckland | Pacific/Auckland |\n | Wellington | Pacific/Auckland |\n | Nuku'alofa | Pacific/Tongatapu |\n | Tokelau Is. | Pacific/Fakaofo |\n | Chatham Is. | Pacific/Chatham |\n | Samoa | Pacific/Apia |\n\n
\n\n**Default:** `Etc/UTC`\n\n**Example:** `America/New_York`" } ] }, "docs": "(Available from version 1.11) This operation returns the live and historic viewer data for a specific live stream. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data.\n\n**Querying live data**\n\n1. To get data for currently live streams, do not send **from** and **to** values.\n2. Use the **include** query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. \n\nIf you don't send any query p" }, { "info": { "name": "Fetch viewer analytics data for a VOD stream", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/analytics/viewers/vod_streams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the VOD stream." }, { "name": "from", "value": "", "type": "query", "description": "Use this parameter, along with **to**, to return historic viewer data. \n\nThe start of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **from** query parameter without setting the **to** query parameter, the data returned will reflect 30 days starting at the from date, or data up to to the current day, whichever is shorter.\n\nExample:\n**2024-03-14T10:31:54.486Z**" }, { "name": "to", "value": "", "type": "query", "description": "Use this parameter, along with **from**, to return historic viewer data. \n\n\nThe end of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **to** query parameter without setting the **from** query parameter, the data returned will be from the past 30 days or from your last invoice date, whichever is shorter.\n\nExample:\n**2024-04-13T10:31:54.486Z**" }, { "name": "include", "value": "", "type": "query", "description": "Specify the data you want returned in the response. You can send a comma-separated list of values.\n\nValid values are: **countries**, **renditions**, **devices**, and **trend**.\n\nExample:\n**countries,trend**" }, { "name": "time_zone", "value": "", "type": "query", "description": "Specify the time zone you want the returned data to reflect. \n\n
Click to expand for the full list of valid values\n\n\n | Locations | Wowza Video time_zone value |\n |---|---|\n | International Date Line West | Etc/GMT+12 |\n | Midway Island | Pacific/Midway |\n | American Samoa | Pacific/Pago_Pago |\n | Hawaii | Pacific/Honolulu |\n | Alaska | America/Juneau |\n | Pacific Time (US & Canada) | America/Los_Angeles |\n | Tijuana | America/Tijuana |\n | Mountain Time (US & Canada) | America/Denver |\n | Arizona | America/Phoenix |\n | Chihuahua | America/Chihuahua |\n | Mazatlan | America/Mazatlan |\n | Central Time (US & Canada) | America/Chicago |\n | Saskatchewan | America/Regina |\n | Guadalajara | America/Mexico_City |\n | Mexico City | America/Mexico_City |\n | Monterrey | America/Monterrey |\n | Central America | America/Guatemala |\n | Eastern Time (US & Canada) | America/New_York |\n | Indiana (East) | America/Indiana/Indianapolis |\n | Bogota | America/Bogota |\n | Lima | America/Lima |\n | Quito | America/Lima |\n | Atlantic Time (Canada) | America/Halifax |\n | Caracas | America/Caracas |\n | La Paz | America/La_Paz |\n | Santiago | America/Santiago |\n | Newfoundland | America/St_Johns |\n | Brasilia | America/Sao_Paulo |\n | Buenos Aires | America/Argentina/Buenos_Aires |\n | Montevideo | America/Montevideo |\n | Georgetown | America/Guyana |\n | Puerto Rico | America/Puerto_Rico |\n | Greenland | America/Godthab |\n | Mid-Atlantic | Atlantic/South_Georgia |\n | Azores | Atlantic/Azores |\n | Cape Verde Is. | Atlantic/Cape_Verde |\n | Dublin | Europe/Dublin |\n | Edinburgh | Europe/London |\n | Lisbon | Europe/Lisbon |\n | London | Europe/London |\n | Casablanca | Africa/Casablanca |\n | Monrovia | Africa/Monrovia |\n | UTC | Etc/UTC |\n | Belgrade | Europe/Belgrade |\n | Bratislava | Europe/Bratislava |\n | Budapest | Europe/Budapest |\n | Ljubljana | Europe/Ljubljana |\n | Prague | Europe/Prague |\n | Sarajevo | Europe/Sarajevo |\n | Skopje | Europe/Skopje |\n | Warsaw | Europe/Warsaw |\n | Zagreb | Europe/Zagreb |\n | Brussels | Europe/Brussels |\n | Copenhagen | Europe/Copenhagen |\n | Madrid | Europe/Madrid |\n | Paris | Europe/Paris |\n | Amsterdam | Europe/Amsterdam |\n | Berlin | Europe/Berlin |\n | Bern | Europe/Zurich |\n | Zurich | Europe/Zurich |\n | Rome | Europe/Rome |\n | Stockholm | Europe/Stockholm |\n | Vienna | Europe/Vienna |\n | West Central Africa | Africa/Algiers |\n | Bucharest | Europe/Bucharest |\n | Cairo | Africa/Cairo |\n | Helsinki | Europe/Helsinki |\n | Kyiv | Europe/Kiev |\n | Riga | Europe/Riga |\n | Sofia | Europe/Sofia |\n | Tallinn | Europe/Tallinn |\n | Vilnius | Europe/Vilnius |\n | Athens | Europe/Athens |\n | Istanbul | Europe/Istanbul |\n | Minsk | Europe/Minsk |\n | Jerusalem | Asia/Jerusalem |\n | Harare | Africa/Harare |\n | Pretoria | Africa/Johannesburg |\n | Kaliningrad | Europe/Kaliningrad |\n | Moscow | Europe/Moscow |\n | St. Petersburg | Europe/Moscow |\n | Volgograd | Europe/Volgograd |\n | Samara | Europe/Samara |\n | Kuwait | Asia/Kuwait |\n | Riyadh | Asia/Riyadh |\n | Nairobi | Africa/Nairobi |\n | Baghdad | Asia/Baghdad |\n | Tehran | Asia/Tehran |\n | Abu Dhabi | Asia/Muscat |\n | Muscat | Asia/Muscat |\n | Baku | Asia/Baku |\n | Tbilisi | Asia/Tbilisi |\n | Yerevan | Asia/Yerevan |\n | Kabul | Asia/Kabul |\n | Ekaterinburg | Asia/Yekaterinburg |\n | Islamabad | Asia/Karachi |\n | Karachi | Asia/Karachi |\n | Tashkent | Asia/Tashkent |\n | Chennai | Asia/Kolkata |\n | Kolkata | Asia/Kolkata |\n | Mumbai | Asia/Kolkata |\n | New Delhi | Asia/Kolkata |\n | Kathmandu | Asia/Kathmandu |\n | Astana | Asia/Dhaka |\n | Dhaka | Asia/Dhaka |\n | Sri Jayawardenepura | Asia/Colombo |\n | Almaty | Asia/Almaty |\n | Novosibirsk | Asia/Novosibirsk |\n | Rangoon | Asia/Rangoon |\n | Bangkok | Asia/Bangkok |\n | Hanoi | Asia/Bangkok |\n | Jakarta | Asia/Jakarta |\n | Krasnoyarsk | Asia/Krasnoyarsk |\n | Beijing | Asia/Shanghai |\n | Chongqing | Asia/Chongqing |\n | Hong Kong | Asia/Hong_Kong |\n | Urumqi | Asia/Urumqi |\n | Kuala Lumpur | Asia/Kuala_Lumpur |\n | Singapore | Asia/Singapore |\n | Taipei | Asia/Taipei |\n | Perth | Australia/Perth |\n | Irkutsk | Asia/Irkutsk |\n | Ulaanbaatar | Asia/Ulaanbaatar |\n | Seoul | Asia/Seoul |\n | Osaka | Asia/Tokyo |\n | Sapporo | Asia/Tokyo |\n | Tokyo | Asia/Tokyo |\n | Yakutsk | Asia/Yakutsk |\n | Darwin | Australia/Darwin |\n | Adelaide | Australia/Adelaide |\n | Canberra | Australia/Melbourne |\n | Melbourne | Australia/Melbourne |\n | Sydney | Australia/Sydney |\n | Brisbane | Australia/Brisbane |\n | Hobart | Australia/Hobart |\n | Vladivostok | Asia/Vladivostok |\n | Guam | Pacific/Guam |\n | Port Moresby | Pacific/Port_Moresby |\n | Magadan | Asia/Magadan |\n | Srednekolymsk | Asia/Srednekolymsk |\n | Solomon Is. | Pacific/Guadalcanal |\n | New Caledonia | Pacific/Noumea |\n | Fiji | Pacific/Fiji |\n | Kamchatka | Asia/Kamchatka |\n | Marshall Is. | Pacific/Majuro |\n | Auckland | Pacific/Auckland |\n | Wellington | Pacific/Auckland |\n | Nuku'alofa | Pacific/Tongatapu |\n | Tokelau Is. | Pacific/Fakaofo |\n | Chatham Is. | Pacific/Chatham |\n | Samoa | Pacific/Apia |\n\n
\n\n**Default:** `Etc/UTC`\n\n**Example:** `America/New_York`" } ] }, "docs": "(Available from version 1.11) This operation returns the live and historic viewer data for a specific VOD stream. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data.\n\n**Querying live data**\n\n1. To get data for currently live streams, do not send **from** and **to** values.\n2. Use the **include** query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. \n\nIf you don't send any query pa" }, { "info": { "name": "Fetch viewer analytics data for a stream target", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/analytics/viewers/stream_targets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the stream target." }, { "name": "from", "value": "", "type": "query", "description": "Use this parameter, along with **to**, to return historic viewer data. \n\nThe start of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **from** query parameter without setting the **to** query parameter, the data returned will reflect 30 days starting at the **from** date, or data up to to the current day, whichever is shorter.\n\nExample:\n**2024-03-14T10:31:54.486Z**" }, { "name": "to", "value": "", "type": "query", "description": "Use this parameter, along with **from**, to return historic viewer data. \n\n\nThe end of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **to** query parameter without setting the **from** query parameter, the data returned will be from the past 30 days or from your last invoice date, whichever is shorter.\n\nExample:\n**2024-04-13T10:31:54.486Z**" }, { "name": "include", "value": "", "type": "query", "description": "Specify the data you want returned in the response. You can send a comma-separated list of values.\n\nValid values are: **countries**, **renditions**, **devices**, and **trend**.\n\nExample:\n**countries,trend**" }, { "name": "time_zone", "value": "", "type": "query", "description": "Specify the time zone you want the returned data to reflect. \n\n
Click to expand for the full list of valid values\n\n\n | Locations | Wowza Video time_zone value |\n |---|---|\n | International Date Line West | Etc/GMT+12 |\n | Midway Island | Pacific/Midway |\n | American Samoa | Pacific/Pago_Pago |\n | Hawaii | Pacific/Honolulu |\n | Alaska | America/Juneau |\n | Pacific Time (US & Canada) | America/Los_Angeles |\n | Tijuana | America/Tijuana |\n | Mountain Time (US & Canada) | America/Denver |\n | Arizona | America/Phoenix |\n | Chihuahua | America/Chihuahua |\n | Mazatlan | America/Mazatlan |\n | Central Time (US & Canada) | America/Chicago |\n | Saskatchewan | America/Regina |\n | Guadalajara | America/Mexico_City |\n | Mexico City | America/Mexico_City |\n | Monterrey | America/Monterrey |\n | Central America | America/Guatemala |\n | Eastern Time (US & Canada) | America/New_York |\n | Indiana (East) | America/Indiana/Indianapolis |\n | Bogota | America/Bogota |\n | Lima | America/Lima |\n | Quito | America/Lima |\n | Atlantic Time (Canada) | America/Halifax |\n | Caracas | America/Caracas |\n | La Paz | America/La_Paz |\n | Santiago | America/Santiago |\n | Newfoundland | America/St_Johns |\n | Brasilia | America/Sao_Paulo |\n | Buenos Aires | America/Argentina/Buenos_Aires |\n | Montevideo | America/Montevideo |\n | Georgetown | America/Guyana |\n | Puerto Rico | America/Puerto_Rico |\n | Greenland | America/Godthab |\n | Mid-Atlantic | Atlantic/South_Georgia |\n | Azores | Atlantic/Azores |\n | Cape Verde Is. | Atlantic/Cape_Verde |\n | Dublin | Europe/Dublin |\n | Edinburgh | Europe/London |\n | Lisbon | Europe/Lisbon |\n | London | Europe/London |\n | Casablanca | Africa/Casablanca |\n | Monrovia | Africa/Monrovia |\n | UTC | Etc/UTC |\n | Belgrade | Europe/Belgrade |\n | Bratislava | Europe/Bratislava |\n | Budapest | Europe/Budapest |\n | Ljubljana | Europe/Ljubljana |\n | Prague | Europe/Prague |\n | Sarajevo | Europe/Sarajevo |\n | Skopje | Europe/Skopje |\n | Warsaw | Europe/Warsaw |\n | Zagreb | Europe/Zagreb |\n | Brussels | Europe/Brussels |\n | Copenhagen | Europe/Copenhagen |\n | Madrid | Europe/Madrid |\n | Paris | Europe/Paris |\n | Amsterdam | Europe/Amsterdam |\n | Berlin | Europe/Berlin |\n | Bern | Europe/Zurich |\n | Zurich | Europe/Zurich |\n | Rome | Europe/Rome |\n | Stockholm | Europe/Stockholm |\n | Vienna | Europe/Vienna |\n | West Central Africa | Africa/Algiers |\n | Bucharest | Europe/Bucharest |\n | Cairo | Africa/Cairo |\n | Helsinki | Europe/Helsinki |\n | Kyiv | Europe/Kiev |\n | Riga | Europe/Riga |\n | Sofia | Europe/Sofia |\n | Tallinn | Europe/Tallinn |\n | Vilnius | Europe/Vilnius |\n | Athens | Europe/Athens |\n | Istanbul | Europe/Istanbul |\n | Minsk | Europe/Minsk |\n | Jerusalem | Asia/Jerusalem |\n | Harare | Africa/Harare |\n | Pretoria | Africa/Johannesburg |\n | Kaliningrad | Europe/Kaliningrad |\n | Moscow | Europe/Moscow |\n | St. Petersburg | Europe/Moscow |\n | Volgograd | Europe/Volgograd |\n | Samara | Europe/Samara |\n | Kuwait | Asia/Kuwait |\n | Riyadh | Asia/Riyadh |\n | Nairobi | Africa/Nairobi |\n | Baghdad | Asia/Baghdad |\n | Tehran | Asia/Tehran |\n | Abu Dhabi | Asia/Muscat |\n | Muscat | Asia/Muscat |\n | Baku | Asia/Baku |\n | Tbilisi | Asia/Tbilisi |\n | Yerevan | Asia/Yerevan |\n | Kabul | Asia/Kabul |\n | Ekaterinburg | Asia/Yekaterinburg |\n | Islamabad | Asia/Karachi |\n | Karachi | Asia/Karachi |\n | Tashkent | Asia/Tashkent |\n | Chennai | Asia/Kolkata |\n | Kolkata | Asia/Kolkata |\n | Mumbai | Asia/Kolkata |\n | New Delhi | Asia/Kolkata |\n | Kathmandu | Asia/Kathmandu |\n | Astana | Asia/Dhaka |\n | Dhaka | Asia/Dhaka |\n | Sri Jayawardenepura | Asia/Colombo |\n | Almaty | Asia/Almaty |\n | Novosibirsk | Asia/Novosibirsk |\n | Rangoon | Asia/Rangoon |\n | Bangkok | Asia/Bangkok |\n | Hanoi | Asia/Bangkok |\n | Jakarta | Asia/Jakarta |\n | Krasnoyarsk | Asia/Krasnoyarsk |\n | Beijing | Asia/Shanghai |\n | Chongqing | Asia/Chongqing |\n | Hong Kong | Asia/Hong_Kong |\n | Urumqi | Asia/Urumqi |\n | Kuala Lumpur | Asia/Kuala_Lumpur |\n | Singapore | Asia/Singapore |\n | Taipei | Asia/Taipei |\n | Perth | Australia/Perth |\n | Irkutsk | Asia/Irkutsk |\n | Ulaanbaatar | Asia/Ulaanbaatar |\n | Seoul | Asia/Seoul |\n | Osaka | Asia/Tokyo |\n | Sapporo | Asia/Tokyo |\n | Tokyo | Asia/Tokyo |\n | Yakutsk | Asia/Yakutsk |\n | Darwin | Australia/Darwin |\n | Adelaide | Australia/Adelaide |\n | Canberra | Australia/Melbourne |\n | Melbourne | Australia/Melbourne |\n | Sydney | Australia/Sydney |\n | Brisbane | Australia/Brisbane |\n | Hobart | Australia/Hobart |\n | Vladivostok | Asia/Vladivostok |\n | Guam | Pacific/Guam |\n | Port Moresby | Pacific/Port_Moresby |\n | Magadan | Asia/Magadan |\n | Srednekolymsk | Asia/Srednekolymsk |\n | Solomon Is. | Pacific/Guadalcanal |\n | New Caledonia | Pacific/Noumea |\n | Fiji | Pacific/Fiji |\n | Kamchatka | Asia/Kamchatka |\n | Marshall Is. | Pacific/Majuro |\n | Auckland | Pacific/Auckland |\n | Wellington | Pacific/Auckland |\n | Nuku'alofa | Pacific/Tongatapu |\n | Tokelau Is. | Pacific/Fakaofo |\n | Chatham Is. | Pacific/Chatham |\n | Samoa | Pacific/Apia |\n\n
\n\n**Default:** `Etc/UTC`\n\n**Example:** `America/New_York`" } ] }, "docs": "(Available from version 1.11) This operation returns the live and historic viewer data for a specific stream target. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data.\n\n**Querying live data**\n\n1. To get data for currently live streams, do not send **from** and **to** values.\n2. Use the **include** query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. \n\nIf you don't send any query" }, { "info": { "name": "Fetch viewer analytics data for the most viewed live streams", "type": "http" }, "http": { "method": "GET", "url": "https://api.video.wowza.com/api/v2.0/analytics/viewers/live_streams", "params": [ { "name": "from", "value": "", "type": "query", "description": "Use this parameter, along with **to**, to return historic viewer data. \n\nThe start of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **from** query parameter without setting the **to** query parameter, the data returned will reflect 30 days starting at the from date, or data up to to the current day, whichever is shorter.\n\nExample:\n**2023-01-14T10:31:54.486Z**" }, { "name": "to", "value": "", "type": "query", "description": "Use this parameter, along with **from**, to return historic viewer data. \n\n\nThe end of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **to** query parameter without setting the **from** query parameter, the data returned will be from the past 30 days or from your last invoice date, whichever is shorter.\n\nExample:\n**2023-02-14T10:31:54.486Z**" } ] }, "docs": "(Available from version 1.11) This operation returns viewer data for the top 100 live streams in an account.\n\n**Querying data**\n\nTo get viewer data for the top 100 streams that ran previously, send **from** and **to** values.\n\nIf you do not send **from** and **to** values, the last five minutes' worth of live stream viewer data is returned.\n\nIf the time range between **from** and **to** query parameters is:\n\n