Stream Targets

Operations related to stream targets. A stream target is a destination for a stream. Stream targets can be Wowza Streaming Cloud edge resources; custom, external destinations; or ultra low latency target destinations.

Wowza CDN on Akamai Stream Targets

Wowza CDN on Akamai stream targets use the Wowza CDN to distribute streams to players. When you create a live stream in the API, a Wowza CDN on Akamai stream target is created automatically. In contrast, you can use /stream_targets/akamai endpoints to manually create Wowza CDN on Akamai stream targets and associate them with transcoders. With Wowza CDN on Akamai stream targets, you can use geo-blocking to control locations where your stream can be viewed, and you can use token authentication to restrict access to streams. Advanced properties are available for Wowza CDN on Akamai stream targets that deliver HLS streams through the akamai_cupertino provider.

Custom Stream Targets

Custom stream targets connect to external CDNs to deliver streams to viewers. You manually create custom stream targets and associate them to a transcoder. You can configure advanced properties for custom stream targets that deliver HLS streams through the akamai_cupertino provider.

Ultra Low Latency Stream Targets

Ultra low latency stream targets allow you to configure a source encoder to send a stream directly to a stream target and then onto a player or app for playback. You don't need to associate this type of stream target with live streams or transcoders. See Get started with ultra low latency streaming using the Wowza Streaming Cloud REST API to learn more.

Note: As of August 31, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

Wowza CDN on Fastly Stream Targets

Wowza CDN on Fastly stream targets leverage the Fastly CDN to distribute streams to players. A separate Fastly subscription isn't required because the Fastly CDN is integrated directly into Wowza Streaming Cloud.

Fetch all stream targets

This operation lists limited details for custom stream targets, ultra low latency stream targets, Wowza CDN on Akamai stream targets, and Wowza CDN on Fastly stream targets. For detailed information, fetch a single stream target of a specific type.

query Parameters
page
integer

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.

For more information and examples, see Get paginated query results with the Wowza Streaming Cloud REST API.

per_page
integer

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.

Responses

Response Schema: application/json
required
Array of objects (stream_targets)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets"

Response samples

Content type
application/json
{
  • "stream_targets": [
    ]
}

Create a custom stream target

This operation creates a custom stream target for an external, third-party destination.

Request Body schema: application/json

Provide the details of the custom stream target to create in the body of the request.

required
object (stream_target_custom)

Responses

Response Schema: application/json
object (stream_target_custom)

Request samples

Content type
application/json
{
  • "stream_target_custom": {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_custom": {
    }
}

Fetch all custom stream targets

This operation lists limited details for all of your custom stream targets. For detailed information, fetch a single custom stream target.

query Parameters
page
integer

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.

For more information and examples, see Get paginated query results with the Wowza Streaming Cloud REST API.

per_page
integer

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.

Responses

Response Schema: application/json
required
Array of objects (stream_targets_custom)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/custom"

Response samples

Content type
application/json
{
  • "stream_targets_custom": [
    ]
}

Fetch a custom stream target

This operation shows the details of a specific custom stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the custom stream target.

Responses

Response Schema: application/json
object (stream_target_custom)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/custom/2adffc17"

Response samples

Content type
application/json
{
  • "stream_target_custom": {
    }
}

Update a custom stream target

This operation updates a custom stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the custom stream target.

Request Body schema: application/json

Provide the details of the custom stream target to update in the body of the request.

required
object (stream_target_custom)

Responses

Response Schema: application/json
object (stream_target_custom)

Request samples

Content type
application/json
{
  • "stream_target_custom": {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_custom": {
    }
}

Delete a custom stream target

This operation deletes a custom stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the custom stream target.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/v1.6/stream_targets/custom/2adffc17"

Response samples

Content type
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    }
}

Create a Wowza CDN on Fastly stream target

(Available from version 1.4) This operation creates a Wowza CDN on Fastly stream target to deliver your stream using the Wowza CDN on Fastly.

Request Body schema: application/json

Provide the details of the Wowza CDN on Fastly stream target to create in the body of the request.

required
object (stream_target_fastly)

Responses

Response Schema: application/json
required
object (stream_target_fastly)

Request samples

Content type
application/json
{
  • "stream_target_fastly": {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_fastly": {
    }
}

Fetch all Wowza CDN on Fastly stream targets

(Available from version 1.4) This operation lists limited details for all of your Wowza CDN on Fastly stream targets. For detailed information, fetch a single target.

query Parameters
page
integer

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.

For more information and examples, see Get paginated query results with the Wowza Streaming Cloud REST API.

per_page
integer

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.

Responses

Response Schema: application/json
required
Array of objects (stream_targets_fastly)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/fastly"

Response samples

Content type
application/json
{
  • "stream_targets_fastly": [
    ]
}

Fetch a Wowza CDN on Fastly stream target

(Available from version 1.4) This operation shows the details of a specific Wowza CDN on Fastly stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target_fastly)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/fastly/2adffc17"

Response samples

Content type
application/json
{
  • "stream_target_fastly": {
    }
}

Update a Wowza CDN on Fastly stream target

(Available from version 1.4) This operation updates a Wowza CDN on Fastly stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json

Provide the details of the Wowza CDN on Fastly stream target to update in the body of the request.

required
object (stream_target_fastly)

Responses

Response Schema: application/json
required
object (stream_target_fastly)

Request samples

Content type
application/json
{
  • "stream_target_fastly": {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_fastly": {
    }
}

Delete a Wowza CDN on Fastly stream target

(Available from version 1.4) This operation deletes a Wowza CDN on Fastly stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/v1.6/stream_targets/fastly/2adffc17"

Response samples

Content type
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    }
}

Fetch all VOD streams for a Fastly stream target

(Available from version 1.5) This operation shows the details of all VOD streams associated to a specific Fastly stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
Array of objects (vod_streams)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/fastly/2adffc17/vod_streams"

Response samples

Content type
application/json
{
  • "vod_streams": [
    ]
}

Create an ultra low latency stream target

This operation creates an ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of August 31, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

Request Body schema: application/json

Provide the details of the ultra low latency stream target to create in the body of the request.

required
object (stream_target_ull)

Responses

Response Schema: application/json
required
object (stream_target_ull)

Request samples

Content type
application/json
{
  • "stream_target_ull": {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_ull": {
    }
}

Fetch all ultra low latency stream targets

This operation lists limited details for all of your ultra low latency stream targets. For detailed information, fetch a single ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of August 31, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

query Parameters
page
integer

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.

For more information and examples, see Get paginated query results with the Wowza Streaming Cloud REST API.

per_page
integer

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.

Responses

Response Schema: application/json
required
Array of objects (stream_targets_ull)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/ull"

Response samples

Content type
application/json
{
  • "stream_targets_ull": [
    ]
}

Fetch all started ultra low latency stream targets

This operation lists limited details for all ultra low latency stream targets with a state of started.

Note: As of August 31, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

query Parameters
page
integer

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.

For more information and examples, see Get paginated query results with the Wowza Streaming Cloud REST API.

per_page
integer

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.

Responses

Response Schema: application/json
required
Array of objects (stream_targets_ull)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/ull/started"

Response samples

Content type
application/json
{
  • "stream_targets_ull": [
    ]
}

Fetch an ultra low latency stream target

This operation shows the details of a specific ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of August 31, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

path Parameters
id
required
string

The unique alphanumeric string that identifies the ultra low latency stream target.

Responses

Response Schema: application/json
required
object (stream_target_ull)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/ull/2adffc17"

Response samples

Content type
application/json
{
  • "stream_target_ull": {
    }
}

Update an ultra low latency stream target

This operation updates an ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of August 31, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

path Parameters
id
required
string

The unique alphanumeric string that identifies the ultra low latency stream target.

Request Body schema: application/json

Provide the details of the ultra low latency stream target to update in the body of the request.

required
object (stream_target_ull)

Responses

Response Schema: application/json
required
object (stream_target_ull)

Request samples

Content type
application/json
{
  • "stream_target_ull": {
    }
}

Response samples

Content type
application/json
{
  • "stream_target_ull": {
    }
}

Delete an ultra low latency stream target

This operation deletes an ultra low latency stream target.

Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

Note: As of August 31, 2021, the ultra low latency (ULL) feature will be sunset, and existing ULL targets will no longer function. Click here to learn more about Wowza’s future plans for low latency streaming.

path Parameters
id
required
string

The unique alphanumeric string that identifies the ultra low latency stream target.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/v1.6/stream_targets/ull/2adffc17"

Response samples

Content type
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    }
}

Create a Wowza CDN on Akamai stream target

This operation creates a Wowza CDN on Akamai stream target for a Wowza CDN.

Request Body schema: application/json

Provide the details of the Wowza stream target to create in the body of the request.

required
object (stream_target_akamai)

Responses

Response Schema: application/json
required
object (stream_target_akamai)

Request samples

Content type
application/json
{
  • "stream_target_akamai": {
    }
}

Response samples

Content type
application/json
{}

Fetch all Wowza CDN on Akamai stream targets

This operation lists limited details for all of your Wowza CDN on Akamai stream targets. For detailed information, fetch a single Wowza CDN on Akamai stream target.

query Parameters
page
integer

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.

For more information and examples, see Get paginated query results with the Wowza Streaming Cloud REST API.

per_page
integer

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.

Responses

Response Schema: application/json
required
Array of objects (stream_targets_akamai)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/akamai"

Response samples

Content type
application/json
{
  • "stream_targets_akamai": [
    ]
}

Fetch a Wowza CDN on Akamai stream target

This operation shows the details of a specific Wowza CDN on Akamai stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target_akamai)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/akamai/2adffc17"

Response samples

Content type
application/json
{}

Update a Wowza CDN on Akamai stream target

This operation updates a Wowza CDN on Akamai stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json

Provide the details of the Wowza stream target to update in the body of the request.

required
object (stream_target_akamai)

Responses

Response Schema: application/json
required
object (stream_target_akamai)

Request samples

Content type
application/json
{
  • "stream_target_akamai": {
    }
}

Response samples

Content type
application/json
{}

Delete a Wowza CDN on Akamai stream target

This operation deletes a Wowza CDN on Akamai stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/v1.6/stream_targets/akamai/2adffc17"

Response samples

Content type
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    }
}

Regenerate the connection code for any stream target

This operation regenerates the connection code of any kind of stream target.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/v1.6/stream_targets/2adffc17/regenerate_connection_code"

Response samples

Content type
application/json
{
  • "stream_target": {
    }
}

Configure a property for a stream target

This operation configures a property for a stream target. Properties are available for a custom stream target or Wowza stream target whose provider is akamai_cupertino. Some properties, as noted in the key descriptions, can also be applied to Wowza CDN on Fastly stream targets. For more information see Set advanced properties with the Wowza Streaming Cloud REST API.

path Parameters
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json

Provide the details of the property to configure in the body of the request.

required
object (property)

Responses

Response Schema: application/json
required
object (stream_target_property)

Request samples

Content type
application/json
{
  • "property": {
    }
}

Response samples

Content type
application/json
{
  • "property": {
    }
}

Fetch all properties of a stream target

This operation shows the details of all of the properties assigned to a specific stream target. Properties can be applied to a custom stream target or to a Wowza stream target whose provider is akamai_cupertino. Some properties, as noted in the key descriptions, can also be applied to Wowza CDN on Fastly stream targets.

path Parameters
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
Array of objects (stream_target_property)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/2adffc17/properties"

Response samples

Content type
application/json
{
  • "properties": [
    ]
}

Fetch a property of a stream target

This operation shows the details of a specific property assigned to a specific stream target. Properties can be applied to a custom stream target or to a Wowza stream target whose provider is akamai_cupertino. Some properties, as noted in the key descriptions, can also be applied to Wowza CDN on Fastly stream targets.

path Parameters
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

id
required
string

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.

Responses

Response Schema: application/json
required
object (stream_target_property)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/2adffc17/properties/hls-chunkSize"

Response samples

Content type
application/json
{
  • "property": {
    }
}

Delete a stream target property

This operation removes a property from a stream target.

path Parameters
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

id
required
string

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.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/v1.6/stream_targets/2adffc17/properties/hls-chunkSize"

Response samples

Content type
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    }
}

Fetch current health metrics for an active ultra low latency stream target

This operation returns a snapshot of the current connection and throughput details for an active ultra low latency stream target. The interval for current metrics is 30 seconds from the moment of the query. #

<Note: Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
id
string

The unique alphanumeric string that identifies the stream target.

object (stream_target_metrics)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/2adffc17/metrics/current"

Response samples

Content type
application/json
{
  • "stream_target": {
    }
}

Fetch historic health metrics for an ultra low latency stream target

This operation shows historic connection and throughput details for an ultra low latency stream target. #

Note: Ultra low latency stream targets are available through subscription to Wowza Streaming Cloud with Ultra Low Latency.

path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

query Parameters
from
string

The start of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.

to
string

The end of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.

interval
string
Enum: "second" "minute" "hour" "day" "month" "#s" "#m" "#h" "#d"

The length of time for a block of metrics. The default is 10m (10 minutes).

Responses

Response Schema: application/json
id
string

The unique alphanumeric string that identifies the stream target.

interval
string

The length of time for a block of metrics. The default is 10m (10 minutes).

Array of objects (stream_target_metrics)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/stream_targets/2adffc17/metrics/historic"

Response samples

Content type
application/json
{
  • "stream_target": {
    }
}
➔ Next to Recordings