Overview

Endpoint(s)

https://api.StreamTest.net-currently only available in https.

Call Format

Using a POST, send a query in this format:

https://api.StreamTest.net/methodname

Use this header, along with User-Agent:

Content-type: application/json; charset=utf-8

For the POST body, use the JSON string containing the parameters you would like to send to a method.

Return Formats

If a method is successfully executed, it will return a JSON string in the following format (where the return keys and values are the expected returns from the methods, as defined by the individual method calls' descriptions in this document):

{"Status":"Success","Data":{ "returnkey1":"returnvalue1","returnkey2":"returnvalue2",…}}

If a method fails for some reason, it will return a JSON string in the following format:

{"Status":"Failure","Error":"Error message here"}

1. LaunchTest

Launches user specified test

Syntax

public string LaunchTest 
( string accountKey, 
string TestUrl, 
string TestName, 
string regions, 
string TestDuration, 
string TestUsers, 
string startDate, 
string endDate, 
string resultsPublic, 
string providerName, 
string description
)

Parameters

Other-See Remarks
accountKey: GUID
TestUrl: String
TestName: String
regions: String
TestDuration: int
TestUsers: int
startDate: DateTime
endDate: DateTime
resultsPublic: bool
providerName: String
description: String

Return Values

TestID: GUID

Remarks

  • Requires a valid Account Key

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/LaunchTest
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c","streamUrl":"rtmp://173.obj.netromedia.net/ODExtreme/Extremists.flv", "isLive":"false","regions":"West US", "duration":"30","concurrency":"10","startDate":"2013-07-01 21:34 PM","endDate":"2013-07-01 22:34 PM","resultsPublic":"true","providerName":"Netromedia", "description":"Basic Test"}

2. GetTest

Returns single test record from database

Syntax

public string GetTest 
( string accountKey, 
string testID
)

Parameters

Other-See Remarks
accountKey: GUID
testID: GUID

Return Values

Test: Object

Remarks

  • Requires a valid Account Key

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/GetTest
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c","testID":"df4fc54d-462d-4468-9171-1bc6cf67ef00"

3. ListTests

Returns all tests items associated with the accountKey used

Syntax

public string ListTests 
( string accountKey
)

Parameters

Other-See Remarks
accountKey: GUID

Return Values

tests: Object

Remarks

  • Requires a valid Account Key

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/ListTests
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c"

4. ListTest

Returns a list of servers used in the test, along with their corresponding metrics.

Syntax

public string ListTest 
( string accountKey, 
string testID
)

Parameters

Other-See Remarks
accountKey: GUID
testID: GUID

Return Values

serverList: Object

Remarks

  • Requires a valid Account Key

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/ListTest
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c","testID":"df4fc54d-462d-4468-9171-1bc6cf67ef00"

5. ChangeTestName

Changes the default test name to a name passed to API

Syntax

public string ChangeTestName 
( string accountKey, 
string testID, 
string TestName
)

Parameters

Other-See Remarks
accountKey: GUID
testID: GUID
TestName: string

Return Values

serverList: Object

Remarks

  • Requires a valid Account Key

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/ChangeTestName
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c","testID":"df4fc54d-462d-4468-9171-1bc6cf67ef00","TestName":"SampleTest1"

6. ListUserResults

Returns a list of test user connections, along with their associated metrics.

Syntax

public string ListUserResults 
( string accountKey, 
string testID
)

Parameters

Other-See Remarks
accountKey: GUID
testID: GUID

Return Values

userList: Object

Remarks

  • Requires a valid Account Key

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/ListUserResults
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c","testID":"df4fc54d-462d-4468-9171-1bc6cf67ef00"

7. GetUserResult

Returns a specific test user connection, along with its associated metrics.

Syntax

public string GetUserResult 
( string accountKey, 
string testID, 
string userID
)

Parameters

Other-See Remarks
accountKey: GUID
testID: GUID
userID: GUID

Return Values

userList: Object

Remarks

  • Requires a valid Account Key
  • Requires Valid Test ID

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/GetUserResult
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c","testID":"df4fc54d-462d-4468-9171-1bc6cf67ef00","userID":"1"

8. GetUserResultWayPoints

Returns a list of user waypoints (waypointed every 10 second), along with their associated metrics.

Syntax

public string GetUserResultWayPoints 
( string accountKey, 
string testID
)

Parameters

Other-See Remarks
accountKey: GUID
testID: GUID

Return Values

wayPointList: Object

Remarks

  • Requires a valid Account Key, Account Secret, and Account ID

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/GetUserResultWayPoints
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c","testID":"df4fc54d-462d-4468-9171-1bc6cf67ef00"

9. GetXChartData

Returns an xChart formatted data string

Syntax

public string GetXChartData 
( string accountKey, 
string testID
)

Parameters

Other-See Remarks
accountKey: GUID
testID: GUID

Return Values

xScaleData: Object

Remarks

  • Requires a valid Account Key and testID

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/GetXChartData
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c","testID":"df4fc54d-462d-4468-9171-1bc6cf67ef00"

10. GetHighChartData

Returns an HighChart formatted data string

Syntax

public string GetHighChartData 
( string accountKey, 
string testID
)

Parameters

Other-See Remarks
accountKey: GUID
testID: GUID

Return Values

series: Object

Remarks

  • Requires a valid Account Key and testID

Example

HTTP Method:
POST
URL:
https://www.streamtest.net/api/GetHighChartData
Request Headers:
Content-type: application/json; charset=utf-8
Request Body:
{"accountKey":"5b251bdb-a880-4ad9-b0a2-3f27485db19c","testID":"df4fc54d-462d-4468-9171-1bc6cf67ef00"

Welcome

The StreamTest.net API lets you test streams.

REST

Using JSON structured parameters in your methods allows for improved readability over XML and allows you to more easily collect, transfer and process the return strings.

Adding the NetroMedia API to your product offerings brings a significant value-add proposition for broadcasters and content providers.

The primary implementation areas for this service are:

  • Integration with hardware or software encoders to pre-configure channel access
  • Automated provisioning of channels for IP Cameras
  • Channel creation and control for streaming service providers
  • Providing and monitoring User Generated Content
  • Programatic access to reporting data
  • Use our packetization system to access iOS, Android and BlackBerry devices
    • Contact NetroMedia at support@netromedia.com
      or 888-818-3846 x702 for access and support.

api.streamtest.net

    Overview
    Return Formats
  1. LaunchTest
  2. GetTest
  3. ListTests
  4. ListTest
  5. ChangeTestName
  6. ListUserResults
  7. GetUserResult
  8. GetUserResultWayPoints
  9. GetXChartData
  10. GetHighChartData