NAV
Probe API

Introduction

Example request:

curl https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetLocation
  -H "apikey: <YourApiKey>"

Replace <YourApiKey> with correct values

All request headers must include apikey.

Header Value
apikey Your Kong account API Key

Sent data are in url parameters, JSON or headers. This will be stated in every endpoint description.

All responses are in JSON format and will be in property named “Result”, e.g. “GetLocationResult”, “GetClusteredProbesByAsnResult”, etc. If an error will occur this property will not be included. Instead of this a “Message” property will be there with error message. Correct response status will be set as well.

Get Countries

Get list of countries with number of active probes. Lists only countries with active probes.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetCountries
  -H "apikey: <YourApiKey>"
  -H 'Accept: application/json'

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetCountries

Request Data

No data needed

Response

Example JSON response:

{
  "GetCountriesResult": [
    {
      "CountryCode": "DZ",
      "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/dz.png",
      "CountryName": "Algeria",
      "ProbesCount": 44
    }, ...
  ]
}

Response includes array of country objects that include CountryCode, CountryFlag, CountryName and ProbesCount with number of available probes in country.

Get Networks By Country

Get list of networks in country with number of active probes. Lists only networks with active probes.

URL

Exmple request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetNetworksByCountry?countryCode=US
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetNetworksByCountry

Request Data

Format: URL parameters

Parameter Type Description
countryCode string ISO 3166-1 alpha-2 country code

Response

Example JSON response:

{
  "GetNetworksByCountryResult": [
    {
      "NetworkID": "15240",
      "NetworkName": "Telstra Internet",
      "ProbesCount": 75
    }, ...
  ]
}

Response includes array of network objects that include NetworkID, NetworkName and ProbesCount with number of available probes in network.

Get Probes By Country

Get active probes in country.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetProbesByCountry?countryCode=UA
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetProbesByCountry

Request Data

Format: URL parameters

Parameter Type Description
countryCode string ISO 3166-1 alpha-2 country code

Response

Example JSON response:

{
  "GetProbesByCountryResult": [
    {
      "ASN": {
        "AsnID": "AS3255",
        "AsnName": "UARNet"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/ua.png",
        "CountryName": "Ukraine",
        "State": null,
        "StateCode": null
      },
      "DateTimeStamp": null,
      "ID": 221415325,
      "Location": {
        "Latitude": 49.8407, "Longitude": 24.0305
      },
      "Network": {
        "CountryCode": null, 
        "LogoURL": null, 
        "NetworkID": "875", 
        "NetworkName": "UARNet"
      }
    }, ...
  ]
}

Response includes array of probe objects or empty array if there are no probes for specified country.

Get Probes By Network

Get active probes in network (ISP).

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetProbesByNetwork?networkID=875
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetProbesByNetwork

Request Data

Format: URL parameters

Parameter Type Description
networkID number ID of network

Response

Example JSON response:

{
  "GetProbesByNetworkResult": [
    {
      "ASN": {
        "AsnID": "AS3255",
        "AsnName": "UARNet"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": null,
        "StateCode": null
      },
      "DateTimeStamp": null,
      "ID": 221415325,
      "Location": {
        "Latitude": 49.8407,
        "Longitude": 24.0305
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "875",
        "NetworkName": "UARNet"
      }
    }, ...
  ]
}

Response includes array of probe objects or empty array if there are no probes for specified network.

Get Probes By ASN

Get active probes for ASN.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetProbesByASN?asnID=AS3255
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetProbesByAsn

Request Data

Format: URL parameters

Parameter Type Description
asnID string ID of an ASN

Response

Example JSON response:

{
  "GetProbesByASNResult": [
    {
      "ASN": {
        "AsnID": "AS3255",
        "AsnName": "UARNet"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": null,
        "StateCode": null
      },
      "DateTimeStamp": null,
      "ID": 221415325,
      "Location": {
        "Latitude": 49.8407,
        "Longitude": 24.0305
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "875",
        "NetworkName": "UARNet"
      }
    }, ...
  ]
}

Response includes array of probe objects or empty array if there are no probes for specified ASN.

Get Probes By Bounding Box

Get active probes in selected area.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetProbesByBoundingBox?maxLatitude=45&maxLongitude=35&minLatitude=43&minLongitude=28
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/GetProbesByBoundingBox

Request Data

Format: URL parameters

Parameter Type Description
maxLatitude number Latitude of north-east corner
maxLongitude number Longitude of north-east corner
minLatitude number Latitude of south-west corner
minLongitude number Longitude of south-west corner

Response

Example JSON response:

{
  "GetProbesByBoundingBoxResult": [
    {
      "ASN": {
        "AsnID": "AS47939",
        "AsnName": "TDV Teleradio company Yalta"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": null,
        "StateCode": null
      },
      "DateTimeStamp": null,
      "ID": 221973629,
      "Location": {
        "Latitude": 44.5001,
        "Longitude": 34.1615
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "17029",
        "NetworkName": "TDV Teleradio company Yalta"
      }
    }, ...
  ]
}

Response includes array of probe objects or empty array if there are no probes for specified bounding box.

Traceroute Test By Country

Start traceroute test from probes in selected countries.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartTracertTestByCountry?countryCode=UA&destination=translate.google.com&probeslimit=50
  -H "apikey: <YourApiKey>"
  -H 'Accept: application/json'

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartTracertTestByCountry

Request Data

Format: URL parameters

Parameter Type Description
bufferSize number Size of the packet data (default 32, max 65500)
commandTimeout number Ping timeout in milliseconds that one ping can take (default 1000ms)
count number Number of pings to each hop (default 3)
countryCode string Comma-separated list of country codes (ISO 3166, e.g. US for USA)
destination string Comma-separated list of IP addresses or hostnames that will be tested
fragment number Fragmentation of sending packets (default 1)
ipv4only number Force using IPv4. If no IPv4 IP address is returned will return error (default 0)
ipv6only number Force using IPv6. If no IPv6 IP address is returned will return error (default 0)
maxFailedHops number Stop the command execution after maximum errors in a row (e.g. stop after 5 ping timeouts, default 0)
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple countries probesLimit needs to be adjusted to be higher than actual number of tested countries
resolve number IP addresses will be resolved to domain names for each hop (default 0)
sleep number Sleep between pings in milliseconds (default 300ms)
stateCode string 2-letter state code (applies only when CountryCode=US)
timeout number Maximum time available to probes for testing in milliseconds (default 50000ms)
ttl number Max number of hops (default 128, max 255)
ttlStart number First Hop from which the trace route should start (default 1)

Timeout parameter may need increasing if your test does not contain all the hops up to the destination.

Response

Example JSON response:

{
  "StartTracertTestByCountryResult": [
    {
      "ASN": {
        "AsnID": "AS25229",
        "AsnName": "Kyivski Telekomunikatsiyni Merezhi LLC"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/ua.png",
        "CountryName": "Ukraine",
        "State": "L'vivs'ka Oblast'",
        "StateCode": null
      },
      "DateTimeStamp": "\/Date(1472483113561+0000)\/",
      "ID": 221486484,
      "Location": {
        "Latitude": 49.835213, 
        "Longitude": 24.040375
      },
      "Network": {
        "CountryCode": null, 
        "LogoURL": null, 
        "NetworkID": "1425", 
        "NetworkName": "Volia"
      },
      "TRACERoute": [
        {
          "Destination": "translate.google.com",
          "HostName": "translate.google.com",
          "IP": "173.194.113.215",
          "Tracert": [
            {
              "HostName": "",
              "IP": "10.253.0.1",
              "PingTimeArray": ["14", "11", "32"],
              "Ping1": "14",
              "Ping2": "11",
              "Ping3": "32",
              "Status": "OK"
            }, ...
          ]
        }, ...
      ]
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

Traceroute Test By Network

Start traceroute test from probes in selected network (ISP).

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartTracertTestByNetwork?networkID=1425&destination=translate.google.com&probeslimit=50
  -H "apikey: <YourApiKey>"
  -H 'Accept: application/json'

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartTracertTestByNetwork

Request Data

Format: URL parameters

Parameter Type Description
bufferSize number Size of the packet data (default 32, max 65500)
commandTimeout number Ping timeout in milliseconds that one ping can take (default 1000ms)
count number Number of pings to each hop (default 3)
destination string Comma-separated list of IP addresses or hostnames that will be tested
fragment number Fragmentation of sending packets (default 1)
ipv4only number Force using IPv4. If no IPv4 IP address is returned will return error (default 0)
ipv6only number Force using IPv6. If no IPv6 IP address is returned will return error (default 0)
maxFailedHops number Stop the command execution after maximum errors in a row (e.g. stop after 5 ping timeouts, default 0)
networkID string Comma-separated list of Network IDs
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple networks probesLimit needs to be adjusted to be higher than actual number of tested networks
resolve number IP addresses will be resolved to domain names for each hop (default 0)
sleep number Sleep between pings in milliseconds (default 300ms)
timeout number Maximum time available to probes for testing in milliseconds (default 50000ms)
ttl number Max number of hops (default 128, max 255)
ttlStart number First Hop from which the trace route should start (default 1)

Timeout parameter may need increasing if your test does not contain all the hops up to the destination.

Response

Example JSON response:

{
  "StartTracertTestByNetworkResult": [
    {
      "ASN": {
        "AsnID": "AS25229",
        "AsnName": "Kyivski Telekomunikatsiyni Merezhi LLC"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/ua.png",
        "CountryName": "Ukraine",
        "State": "Sums'ka Oblast'",
        "StateCode": null
      },
      "DateTimeStamp": "\/Date(1472483612186+0000)\/",
      "ID": 221492345,
      "Location": {
        "Latitude": 50.9216,
        "Longitude": 34.8003
      },
      "Network": {
        "CountryCode": null, 
        "LogoURL": null, 
        "NetworkID": "1425", 
        "NetworkName": "Volia"
      },
      "TRACERoute": [
        {
          "Destination": "translate.google.com",
          "HostName": "translate.google.com",
          "IP": "173.194.113.216",
          "Tracert": [
            {
              "HostName": "",
              "IP": "77.121.12.33",
              "PingTimeArray": ["0", "0", "0"],
              "Ping1": "0",
              "Ping2": "0",
              "Ping3": "0",
              "Status": "OK"
            }, ...
          ]
        }, ...
      ]
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

Traceroute Test By ASN

Start traceroute test from probes selected by ASN IDs.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartTracertTestByASN?asnID=AS3255&destination=translate.google.com&probeslimit=50
  -H "apikey: <YourApiKey>"
  -H 'Accept: application/json'

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartTracertTestByASN

Request Data

Format: URL parameters

Parameter Type Description
asnID string Comma-separated list of ASN IDs
bufferSize number Size of the packet data (default 32, max 65500)
commandTimeout number Ping timeout in milliseconds that one ping can take (default 1000ms)
count number Number of pings to each hop (default 3)
destination string Comma-separated list of IP addresses or hostnames that will be tested
fragment number Fragmentation of sending packets (default 1)
ipv4only number Force using IPv4. If no IPv4 IP address is returned will return error (default 0)
ipv6only number Force using IPv6. If no IPv6 IP address is returned will return error (default 0)
maxFailedHops number Stop the command execution after maximum errors in a row (e.g. stop after 5 ping timeouts, default 0)
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple ASNs, probesLimit needs to be adjusted to be higher than actual number of tested ASNs
resolve number IP addresses will be resolved to domain names for each hop (default 1 so it will resolve)
sleep number Sleep between pings in milliseconds (default 300ms)
timeout number Maximum time available to probes for testing in milliseconds (default 50000ms)
ttl number Max number of hops (default 128, max 255)
ttlStart number First Hop from which the trace route should start (default 1)

Timeout parameter may need increasing if your test does not contain all the hops up to the destination.

Response

Example JSON response:

{
  "StartTracertTestByASNResult": [
    {
      "ASN": {
        "AsnID": "AS3255", 
        "AsnName": "UARNet"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/ua.png",
        "CountryName": "Ukraine",
        "State": "",
        "StateCode": null
      },
      "DateTimeStamp": "\/Date(1472482306355+0000)\/",
      "ID": 221472162,
      "Location": {
        "Latitude": 50.45, 
        "Longitude": 30.5233
      },
      "Network": {
        "CountryCode": null, 
        "LogoURL": null, 
        "NetworkID": "27368", 
        "NetworkName": "Centurion"
      },
      "TRACERoute": [
        {
          "Destination": "translate.google.com",
          "HostName": "translate.google.com",
          "IP": "173.194.113.215",
          "Tracert": [
            {
              "HostName": "localgate-core-L3.gladiator.in.ua",
              "IP": "192.168.16.1",
              "PingTimeArray": ["2", "2", "2"],
              "Ping1": "2",
              "Ping2": "2",
              "Ping3": "2",
              "Status": "OK"
            }, ...
          ]
        }, ...
      ]
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

Traceroute Test By Bounding Box

Start traceroute test from probes in selected area.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartTracertTestByBoundingBox?maxLatitude=45&maxLongitude=35&minLatitude=43&minLongitude=28&destination=translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartTracertTestByBoundingBox

Request Data

Format: URL parameters

Parameter Type Description
bufferSize number Size of the packet data (default 32, max 65500)
commandTimeout number Ping timeout in milliseconds that one ping can take (default 1000ms)
count number Number of pings to each hop (default 3)
destination string Comma-separated list of IP addresses or hostnames that will be tested
fragment number Fragmentation of sending packets (default 1)
ipv4only number Force using IPv4. If no IPv4 IP address is returned will return error (default 0)
ipv6only number Force using IPv6. If no IPv6 IP address is returned will return error (default 0)
maxFailedHops number Stop the command execution after maximum errors in a row (e.g. stop after 5 ping timeouts, default 0)
maxLatitude number Latitude of north-east corner
maxLongitude number Longitude of north-east corner
minLatitude number Latitude of south-west corner
minLongitude number Longitude of south-west corner
probesLimit number Maximum number of probes that will be tested
resolve number IP addresses will be resolved to domain names for each hop (default 0)
sleep number Sleep between pings in milliseconds (default 300ms)
timeout number Maximum time available to probes for testing in milliseconds (default 50000ms)
ttl number Max number of hops (default 128, max 255)
ttlStart number First Hop from which the trace route should start (default 1)

Timeout parameter may need increasing if your test does not contain all the hops up to the destination.

Response

Example JSON response:

{
  "StartTracertTestByBoundingBoxResult": [
    {
      "ASN": {
        "AsnID": "AS49617",
        "AsnName": "Neapol Net LLC"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/ua.png",
        "CountryName": "Ukraine",
        "State": "Crimea",
        "StateCode": null
      },
      "DateTimeStamp": "\/Date(1472574363334+0000)\/",
      "ID": 222025110,
      "Location": {
        "Latitude": 44.5001,
        "Longitude": 34.1615
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "10872",
        "NetworkName": "Neapol Net LLC"
      },
      "TRACERoute": [
        {
          "Destination": "translate.google.com",
          "HostName": "translate.google.com",
          "IP": "216.58.209.174",
          "Tracert": [
            {
              "HostName": "",
              "IP": "91.215.60.1",
              "PingTimeArray": [
                "1",
                "1",
                "0"
              ],
              "Ping1": "1",
              "Ping2": "1",
              "Ping3": "0",
              "Status": "OK"
            }, ...
          ]
        }, ...
      ]
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

Ping Test By Country

Start ping test from probes in selected countries. Each probe (up to “probesLimit” parameter value) will execute multiple ping tests (default 3, can be changed in “count” parameter) with delay of 1s between each ping (can be changed in “sleep” parameter).

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPingTestByCountry?countryCode=CZ&destination=translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"
  -H 'Accept: application/json'

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPingTestByCountry

Request Data

Format: URL parameters

Parameter Type Description
bufferSize number Size of the packet data (default 32, max 65500)
commandTimeout number Ping timeout in milliseconds that one ping can take (default 1000ms)
count number Number of pings to run (default 3). If number of pings is changed, timeout parameter should be changed as well to ensure probe has time to execute all pings
countryCode string Comma-separated list of country codes (ISO 3166, e.g. US for USA)
destination string An IP address or hostname that will be pinged
fragment number Fragmentation of sending packets (default 1)
ipv4only number Force using IPv4. If no IPv4 IP address is returned will return error (default 0)
ipv6only number Force using IPv6. If no IPv6 IP address is returned will return error (default 0)
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple countries probesLimit needs to be adjusted to be higher than actual number of tested countries
resolve number IP addresses will be resolved to domain names for each hop (default 0)
sleep number Sleep between pings as executed on one probe in milliseconds (default 1000ms)
stateCode string 2-letter state code (applies only when CountryCode=US)
timeout number Amount of time in milliseconds in which API responds with result (default 6000). Timeout should be calculated in following way: Timeout = count * commandtimeout + (count-1) * sleep + 1000ms buffer for delay with API communication
ttl number Max allowed hops for packet (default 128, max 255)

Response

Example JSON response:

{
  "StartPingTestByCountryResult": [
    {
      "ASN": {
        "AsnID": "AS7922",
        "AsnName": "Comcast Cable Communications, Inc."
      },
      "Country": {
        "CountryCode": "US",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/us.png",
        "CountryName": "United States",
        "State": "New Jersey",
        "StateCode": null
      },
      "DateTimeStamp": "/Date(1472573325678+0000)/",
      "ID": 222018929,
      "Location": {
        "Latitude": 39.273838,
        "Longitude": -74.583026
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "217",
        "NetworkName": "Comcast Cable"
      },
      "Ping": [
        {
          "Status": "Timeout",
          "Destination": "translate.google.com",
          "HostName": "translate.google.com",
          "IP": "216.58.219.238",
          "PingTime": null,
          "PingTimeArray": [
            null,
            null,
            null
          ]
        }
      ]
    }, ...
  ]
}

Response includes ping results from multiple probes. Each probe result is calculated average of the individual pings executed from that particular probe.

Ping Test By Network

Start ping test from probes in selected network (ISP). Each probe (up to “probesLimit” parameter value) will execute multiple ping tests (default 3, can be changed in “count” parameter) with delay of 1s between each ping (can be changed in “sleep” parameter).

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPingTestByNetwork?networkID=1425&destination=translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPingTestByNetwork

Request Data

Format: URL parameters

Parameter Type Description
bufferSize number Size of the packet data (default 32, max 65500)
commandTimeout number Ping timeout in milliseconds that one ping can take (default 1000ms)
count number Number of pings to run (default 3). If number of pings is changed, timeout parameter should be changed as well to ensure probe has time to execute all pings
destination string An IP address or hostname that will be pinged
fragment number Fragmentation of sending packets (default 1)
ipv4only number Force using IPv4. If no IPv4 IP address is returned will return error (default 0)
ipv6only number Force using IPv6. If no IPv6 IP address is returned will return error (default 0)
networkID string Comma-separated list of Network IDs
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple networks probesLimit needs to be adjusted to be higher than actual number of tested networks
resolve number IP addresses will be resolved to domain names for each hop (default 0)
sleep number Sleep between pings as executed on one probe in milliseconds (default 1000ms)
timeout number Amount of time in milliseconds in which API responds with result (default 6000). Timeout should be calculated in following way: Timeout = count * commandtimeout + (count-1) * sleep + 1000ms buffer for delay with API communication
ttl number Max allowed hops for packet (default 128, max 255)

Response

Example JSON response:

{
  "StartPingTestByNetworkResult": [
    {
      "ASN": {
        "AsnID": "AS16814",
        "AsnName": "S.A."
      },
      "Country": {
        "CountryCode": "AR",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ar.png",
        "CountryName": "Argentina",
        "State": "Cordoba Province",
        "StateCode": null
      },
      "DateTimeStamp": "/Date(1472573589307+0000)/",
      "ID": 221645663,
      "Location": {
        "Latitude": -31.425,
        "Longitude": -64.175
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "143",
        "NetworkName": "NSS S.A."
      },
      "Ping": [
        {
          "Status": "OK",
          "Destination": "translate.google.com",
          "HostName": "translate.google.com",
          "IP": "216.58.222.46",
          "PingTime": 66,
          "PingTimeArray": [
            "69",
            "61",
            "70"
          ]
        }
      ],
      "PingTime": 66
    }, ...
  ]
}

Response includes ping results from multiple probes. Each probe result is calculated average of the individual pings executed from that particular probe.

Ping Test By ASN

Start ping test from probes selected by ASN. Each probe (up to “probesLimit” parameter value) will execute multiple ping tests (default 3, can be changed in “count” parameter) with delay of 1s between each ping (can be changed in “sleep” parameter).

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPingTestByASN?asnID=AS3255&destination=translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPingTestByASN

Request Data

Format: URL parameters

Parameter Type Description
asnID string Comma-separated list of ASN IDs
bufferSize number Size of the packet data (default 32, max 65500)
commandTimeout number Ping timeout in milliseconds that one ping can take (default 1000ms)
count number Number of pings to run (default 3). If number of pings is changed, timeout parameter should be changed as well to ensure probe has time to execute all pings
destination string An IP address or hostname that will be pinged
fragment number Fragmentation of sending packets (default 1)
ipv4only number Force using IPv4. If no IPv4 IP address is returned will return error (default 0)
ipv6only number Force using IPv6. If no IPv6 IP address is returned will return error (default 0)
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple ASNs, probesLimit needs to be adjusted to be higher than actual number of tested ASNs
resolve number IP addresses will be resolved to domain names for each hop (default 0)
sleep number Sleep between pings as executed on one probe in milliseconds (default 1000ms)
timeout number Amount of time in milliseconds in which API responds with result (default 6000). Timeout should be calculated in following way: Timeout = count * commandtimeout + (count-1) * sleep + 1000ms buffer for delay with API communication
ttl number Max allowed hops for packet (default 128, max 255)

Response

Example JSON response:

{
  "StartPingTestByASNResult": [
    {
      "ASN": {
        "AsnID": "AS3255",
        "AsnName": "UARNet"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": "",
        "StateCode": null
      },
      "DateTimeStamp": "/Date(1472571245057+0000)/",
      "ID": 222041404,
      "Location": {
        "Latitude": 49.8261717,
        "Longitude": 23.9851154
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "27368",
        "NetworkName": "Centurion"
      },
      "Ping": [
        {
          "Status": "Timeout",
          "Destination": "translate.google.com",
          "HostName": "translate.google.com",
          "IP": "173.194.113.215",
          "PingTime": null,
          "PingTimeArray": [
            null,
            null,
            null
          ]
        }
      ]
    }, ...
  ]
}

Response includes ping results from multiple probes. Each probe result is calculated average of the individual pings executed from that particular probe.

Ping Test By Bounding Box

Start ping test from probes in selected area. Each probe (up to “probeslimit” parameter value) will execute multiple ping tests (default 3, can be changed in “count” parameter) with delay of 1s between each ping (can be changed in “sleep” parameter).

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPingTestByBoundingBox?maxLatitude=45&maxLongitude=35&minLatitude=43&minLongitude=28&destination=translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPingTestByBoundingBox

Request Data

Format: URL parameters

Parameter Type Description
bufferSize number Size of the packet data (default 32, max 65500)
commandTimeout number Ping timeout in milliseconds that one ping can take (default 1000ms)
count number Number of pings to run (default 3). If number of pings is changed, timeout parameter should be changed as well to ensure probe has time to execute all pings
destination string An IP address or hostname that will be pinged
fragment number Fragmentation of sending packets (default 1)
ipv4only number Force using IPv4. If no IPv4 IP address is returned will return error (default 0)
ipv6only number Force using IPv6. If no IPv6 IP address is returned will return error (default 0)
maxLatitude number Latitude of north-east corner
maxLongitude number Longitude of north-east corner
minLatitude number Latitude of south-west corner
minLongitude number Longitude of south-west corner
probesLimit number Maximum number of probes that will be tested
resolve number IP addresses will be resolved to domain names for each hop (default 0)
sleep number Sleep between pings as executed on one probe in milliseconds (default 1000ms)
timeout number Amount of time in milliseconds in which API responds with result (default 6000). Timeout should be calculated in following way: Timeout = count * commandtimeout + (count-1) * sleep + 1000ms buffer for delay with API communication
ttl number Max allowed hops for packet (default 128, max 255)

Response

Example JSON response:

{
  "StartPingTestByBoundingBoxResult": [
    {
      "ASN": {
        "AsnID": "AS35816",
        "AsnName": "Lancom Ltd."
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": "Misto Sevastopol'",
        "StateCode": null
      },
      "DateTimeStamp": "/Date(1472574985114+0000)/",
      "ID": 222060502,
      "Location": {
        "Latitude": 44.5888,
        "Longitude": 33.5224
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "24517",
        "NetworkName": "Lancom Ltd, Russia, Sevastopol"
      },
      "Ping": [
        {
          "Status": "OK",
          "Destination": "translate.google.com",
          "HostName": "translate.google.com",
          "IP": "216.58.209.206",
          "PingTime": 30,
          "PingTimeArray": [
            "30",
            "30",
            "30"
          ]
        }
      ],
      "PingTime": 30
    }, ...
  ]
}

Response includes ping results from multiple probes. Each probe result is calculated average of the individual pings executed from that particular probe.

DIG Test By Country

Start DIG test from probes in selected countries. DNS query is using user’s DNS server as the DNS Resolver server and returns the “Query time” in milliseconds. Query type: A. Query class: IN. Cache:0. Recurse:0. Protocol:UDP. Tries:1. Time:2.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartDIGTestByCountry?countryCode=GB&destination=translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"
  -H 'Accept: text/plain'

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartDIGTestByCountry

Request Data

Format: URL parameters

Parameter Type Description
cache number Cache result in local cache, e.g. 0 means don’t cache results (default 0)
commandTimeout number DNS query timeout in milliseconds (default 1000ms)
countryCode string Comma-separated list of country codes (ISO 3166, e.g. US for USA)
destination string Comma-separated list of hostnames that will be resolved
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple countries probesLimit needs to be adjusted to be higher than actual number of tested countries
qClass string Query class (default IN)
qType string Query type (default A)
recurse number Set Recursion Desired flag (default 0)
retries number Total number of retries (default 0)
server string DNS server to use as a resolver, e.g. 8.8.8.8 (default, empty string, uses local DNS setting)
stateCode string 2-letter state code (applies only when CountryCode=US)
tcp number Use tcp as a transport, e.g. 0 means use UDP, both use port 53 (default 0)
time number Maximum time available to probes for testing in milliseconds (default 2000ms)
timeout number Timeout value in milliseconds (default 2000)
tries number Total number of tries, e.g. 1 means only one try will be done, no retries (default 1)

Response

Example JSON response:

{
  "StartDIGTestByCountryResult": [
    {
      "ASN": {
        "AsnID": "AS2856",
        "AsnName": "British Telecommunications PLC"
      },
      "Country": {
        "CountryCode": "GB",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/gb.png",
        "CountryName": "United Kingdom",
        "State": "England",
        "StateCode": null
      },
      "DIGDns": [
        {
          "Status": "FormErr",
          "Destination": "translate.google.com",
          "QueryTime": null
        }
      ],
      "DateTimeStamp": "/Date(1472637504391+0000)/",
      "ID": 222347929,
      "Location": {
        "Latitude": 53.534603,
        "Longitude": -2.217189
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "263",
        "NetworkName": "BT"
      }
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

DIG Test By Network

Start DIG test from probes in selected network (ISP). DNS query is using user’s DNS server as the DNS Resolver server and returns the “Query time” in milliseconds. Query type: A. Query class: IN. Cache:0. Recurse:0. Protocol:UDP. Tries:1. Time:2.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartDIGTestByNetwork?networkID=1425&destination=translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartDIGTestByNetwork

Request Data

Format: URL parameters

Parameter Type Description
cache number Cache result in local cache, e.g. 0 means don’t cache results (default 0)
commandTimeout number DNS query timeout in milliseconds (default 1000ms)
destination string Comma-separated list of hostnames that will be resolved
networkID string Comma-separated list of Network IDs
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple networks probesLimit needs to be adjusted to be higher than actual number of tested networks
qClass string Query class (default IN)
qType string Query type (default A)
recurse number Set Recursion Desired flag (default 0)
retries number Total number of retries (default 0)
server string DNS server to use as a resolver, e.g. 8.8.8.8 (default, empty string, uses local DNS setting)
tcp number Use tcp as a transport, e.g. 0 means use UDP, both use port 53 (default 0)
time number Maximum time available to probes for testing in milliseconds (default 2000ms)
timeout number Timeout value in milliseconds (default 2000)
tries number Total number of tries, e.g. 1 means only one try will be done, no retries (default 1)

Response

Example JSON response:

{
  "StartDIGTestByNetworkResult": [
    {
      "ASN": {
        "AsnID": "AS25229",
        "AsnName": "Kyivski Telekomunikatsiyni Merezhi LLC"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": "Volyns'ka Oblast'",
        "StateCode": null
      },
      "DIGDns": [
        {
          "Status": "OK",
          "Destination": "translate.google.com",
          "QueryTime": "15"
        }
      ],
      "DateTimeStamp": "/Date(1472638657778+0000)/",
      "ID": 222369657,
      "Location": {
        "Latitude": 50.7623591,
        "Longitude": 25.3596513
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "1425",
        "NetworkName": "Volia"
      }
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

DIG Test By ASN

Start DIG test from probes selected by ASN IDs. DNS query is using user’s DNS server as the DNS Resolver server and returns the “Query time” in milliseconds. Query type: A. Query class: IN. Cache:0. Recurse:0. Protocol:UDP. Tries:1. Time:2.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartDIGTestByASN?asnID=AS3255&destination=translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartDIGTestByASN

Request Data

Format: URL parameters

Parameter Type Description
asnID string Comma-separated list of ASN IDs
cache number Cache result in local cache, e.g. 0 means don’t cache results (default 0)
commandTimeout number DNS query timeout in milliseconds (default 1000ms)
destination string Comma-separated list of hostnames that will be resolved
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple ASNs, probesLimit needs to be adjusted to be higher than actual number of tested ASNs
qClass string Query class (default IN)
qType string Query type (default A)
recurse number Set Recursion Desired flag (default 0)
retries number Total number of retries (default 0)
server string DNS server to use as a resolver, e.g. 8.8.8.8 (default, empty string, uses local DNS setting)
tcp number Use tcp as a transport, e.g. 0 means use UDP, both use port 53 (default 0)
time number Maximum time available to probes for testing in milliseconds (default 2000ms)
timeout number Timeout value in milliseconds (default 2000)
tries number Total number of tries, e.g. 1 means only one try will be done, no retries (default 1)

Response

Example JSON response:

{
  "StartDIGTestByASNResult": [
    {
      "ASN": {
        "AsnID": "AS3255",
        "AsnName": "UARNet"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": "L'vivs'ka Oblast'",
        "StateCode": null
      },
      "DIGDns": [
        {
          "Status": "OK",
          "Destination": "translate.google.com",
          "QueryTime": "29"
        }
      ],
      "DateTimeStamp": "/Date(1472636794498+0000)/",
      "ID": 222359892,
      "Location": {
        "Latitude": 49.8407,
        "Longitude": 24.0305
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "875",
        "NetworkName": "UARNet"
      }
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

DIG Test By Bounding Box

Start DIG test from probes in selected area. DNS query is using user’s DNS server as the DNS Resolver server and returns the “Query time” in milliseconds. Query type: A. Query class: IN. Cache:0. Recurse:0. Protocol:UDP. Tries:1. Time:2.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartDIGTestByBoundingBox?maxLatitude=45&maxLongitude=35&minLatitude=43&minLongitude=33&destination=translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartDIGTestByBoundingBox

Request Data

Format: URL parameters

Parameter Type Description
cache number Cache result in local cache, e.g. 0 means don’t cache results (default 0)
commandTimeout number DNS query timeout in milliseconds (default 1000ms)
destination string Comma-separated list of hostnames that will be resolved
maxFailedHops number Stop the command execution after maximum errors in a row (e.g. stop after 5 ping timeouts, default 0)
maxLatitude number Latitude of north-east corner
maxLongitude number Longitude of north-east corner
minLatitude number Latitude of south-west corner
minLongitude number Longitude of south-west corner
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple ASNs, probesLimit needs to be adjusted to be higher than actual number of tested ASNs
qClass string Query class (default IN)
qType string Query type (default A)
recurse number Set Recursion Desired flag (default 0)
retries number Total number of retries (default 0)
server string DNS server to use as a resolver, e.g. 8.8.8.8 (default, empty string, uses local DNS setting)
tcp number Use tcp as a transport, e.g. 0 means use UDP, both use port 53 (default 0)
time number Maximum time available to probes for testing in milliseconds (default 2000ms)
timeout number Timeout value in milliseconds (default 2000)
tries number Total number of tries, e.g. 1 means only one try will be done, no retries (default 1)

Response

Example JSON response:

{
  "StartDIGTestByBoundingBoxResult": [
    {
      "ASN": {
        "AsnID": "AS35816",
        "AsnName": "Lancom Ltd."
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": "Misto Sevastopol'",
        "StateCode": null
      },
      "DIGDns": [
        {
          "Status": "OK",
          "Destination": "translate.google.com",
          "QueryTime": "4"
        }
      ],
      "DateTimeStamp": "/Date(1472637228959+0000)/",
      "ID": 222280073,
      "Location": {
        "Latitude": 44.5888,
        "Longitude": 33.5224
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "24517",
        "NetworkName": "Lancom Ltd, Russia, Sevastopol"
      }
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

Page Load Test By Country

Start page load test from probes in selected countries.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPageLoadTestByCountry?countryCode=CZ&destination=<url>translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPageLoadTestByCountry

Request Data

Format: URL parameters

Parameter Type Description
commandTimeout number Maximum allowed time for pageload in milliseconds. If not set it will default to timeout-1000 milliseconds
countryCode string Comma-separated list of country codes (ISO 3166, e.g. US for USA)
destination string List of URLEncoded URLs each prepended with <url>. Destination URL can start with http or https, if it does not, http is automatically presumed
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple countries probesLimit needs to be adjusted to be higher than actual number of tested countries
stateCode string 2-letter state code (applies only when CountryCode=US)
timeout number Maximum time available to probes for testing in milliseconds (default 45000ms)

Response

Example JSON response:

{
  "StartPageLoadTestByCountryResult": [
    {
      "ASN": {
        "AsnID": "AS5610",
        "AsnName": "O2 Czech Republic, a.s."
      },
      "Country": {
        "CountryCode": "CZ",
        "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/cz.png",
        "CountryName": "Czech Republic",
        "State": "",
        "StateCode": null
      },
      "DateTimeStamp": "\/Date(1472640073831+0000)\/",
      "ID": 222305926,
      "Location": {"Latitude": 50.35, "Longitude": 16.1833},
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "15235",
        "NetworkName": "O2 Czech Republic"
      },
      "PAGELoad": [
        {
          "Status": "OK",
          "Destination": "http:\/\/translate.google.com",
          "IEVersion": "11.0.9600.18427",
          "NumberOfObjectsLoaded": 27,
          "OSVersion": "6.3.9600.0",
          "PageLoaded": 13692,
          "PageLoadedByAPI": "9949.984565696055",
          "PageLoadedByWebComponent": 13692,
          "PerformanceApiTotalTime": "9949.984565696055",
          "WebBrowserMainTime": 13692,
          "WebBrowserTotalTime": 13692
        }
      ]
    }
  ]
}

Response includes array of probes from which tests were performed.

Page Load Test By Network

Start page load test from probes in selected network (ISP).

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPageLoadTestByNetwork?networkID=1425&destination=<url>translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPageLoadTestByNetwork

Request Data

Format: URL parameters

Parameter Type Description
commandTimeout number Maximum allowed time for pageload in milliseconds. If not set it will default to timeout-1000 milliseconds
destination string List of URLEncoded URLs each prepended with <url>. Destination URL can start with http or https, if it does not, http is automatically presumed
networkID string Comma-separated list of Network IDs
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple networks probesLimit needs to be adjusted to be higher than actual number of tested networks
timeout number Maximum time available to probes for testing in milliseconds (default 45000ms)

Response

Example JSON response:

{
  "StartPageLoadTestByNetworkResult": [
    {
      "ASN": {
        "AsnID": "AS5610",
        "AsnName": "O2 Czech Republic, a.s."
      },
      "Country": {
        "CountryCode": "CZ",
        "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/cz.png",
        "CountryName": "Czech Republic",
        "State": "",
        "StateCode": null
      },
      "DateTimeStamp": "\/Date(1472640073831+0000)\/",
      "ID": 222305926,
      "Location": {"Latitude": 50.35, "Longitude": 16.1833},
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "15235",
        "NetworkName": "O2 Czech Republic"
      },
      "PAGELoad": [
        {
          "Status": "OK",
          "Destination": "http:\/\/translate.google.com",
          "IEVersion": "11.0.9600.18427",
          "NumberOfObjectsLoaded": 27,
          "OSVersion": "6.3.9600.0",
          "PageLoaded": 13692,
          "PageLoadedByAPI": "9949.984565696055",
          "PageLoadedByWebComponent": 13692,
          "PerformanceApiTotalTime": "9949.984565696055",
          "WebBrowserMainTime": 13692,
          "WebBrowserTotalTime": 13692
        }
      ]
    }
  ]
}

Response includes array of probes from which tests were performed.

Page Load Test By ASN

Start page load test from probes selected by ASN IDs.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPageLoadTestByASN?asnID=AS3255&destination=<url>translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"
  -H 'Accept: text/plain'

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPageLoadTestByASN

Request Data

Format: URL parameters

Parameter Type Description
asnID string Comma-separated list of ASN IDs
commandTimeout number Maximum allowed time for pageload in milliseconds. If not set it will default to timeout-1000 milliseconds
destination string List of URLEncoded URLs each prepended with <url>. Destination URL can start with http or https, if it does not, http is automatically presumed
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple ASNs, probesLimit needs to be adjusted to be higher than actual number of tested ASNs
timeout number Maximum time available to probes for testing in milliseconds (default 45000ms)

Response

Example JSON response:

{
  "StartPageLoadTestByASNResult": [
    {
      "ASN": {
        "AsnID": "AS3255",
        "AsnName": "UARNet"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/ua.png",
        "CountryName": "Ukraine",
        "State": "Ivano-Frankivs'ka Oblast'",
        "StateCode": null
      },
      "DateTimeStamp": "\/Date(1472639201160+0000)\/",
      "ID": 222295061,
      "Location": {
        "Latitude": 48.8336,
        "Longitude": 24.5243
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "875",
        "NetworkName": "UARNet"
      },
      "PAGELoad": [
        {
          "Status": "OK",
          "Destination": "http:\/\/translate.google.com",
          "IEVersion": "8.0.6001.23266",
          "NumberOfObjectsLoaded": null,
          "OSVersion": "5.1.2600.196608-SP3",
          "PageLoaded": 7015,
          "PageLoadedByAPI": "",
          "PageLoadedByWebComponent": 7015,
          "PerformanceApiTotalTime": "",
          "WebBrowserMainTime": 7015,
          "WebBrowserTotalTime": 7015
        }
      ]
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

Page Load Test By Bounding Box

Start page load test from probes in selected area.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPageLoadTestByBoundingBox?maxLatitude=45&maxLongitude=35&minLatitude=43&minLongitude=28&destination=<url>translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartPageLoadTestByBoundingBox

Request Data

Format: URL parameters

Parameter Type Description
commandTimeout number Maximum allowed time for pageload in milliseconds. If not set it will default to timeout-1000 milliseconds
destination string List of URLEncoded URLs each prepended with <url>. Destination URL can start with http or https, if it does not, http is automatically presumed
maxLatitude number Latitude of north-east corner
maxLongitude number Longitude of north-east corner
minLatitude number Latitude of south-west corner
minLongitude number Longitude of south-west corner
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple countries probesLimit needs to be adjusted to be higher than actual number of tested countries
timeout number Maximum time available to probes for testing in milliseconds (default 45000ms)

Response

Example JSON response:

{
  "StartPageLoadTestByBoundingBoxResult": [
    {
      "ASN": {
        "AsnID": "AS35816",
        "AsnName": "Lancom Ltd."
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http:\/\/speedcheckerapi.blob.core.windows.net\/bsc-img-country-logos\/ua.png",
        "CountryName": "Ukraine",
        "State": "Misto Sevastopol'",
        "StateCode": null
      },
      "DateTimeStamp": "\/Date(1472639627975+0000)\/",
      "ID": 222393945,
      "Location": {"Latitude": 44.5888, "Longitude": 33.5224},
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "24517",
        "NetworkName": "Lancom Ltd, Russia, Sevastopol"
      },
      "PAGELoad": [
        {
          "Status": "OK",
          "Destination": "http:\/\/translate.google.com",
          "IEVersion": "11.0.9600.17963",
          "NumberOfObjectsLoaded": 32,
          "OSVersion": "6.1.7601.65536-SP1",
          "PageLoaded": 5038,
          "PageLoadedByAPI": "3967.1377522974326",
          "PageLoadedByWebComponent": 5037,
          "PerformanceApiTotalTime": "3967.1377522974326",
          "WebBrowserMainTime": 5037,
          "WebBrowserTotalTime": 5038
        }
      ]
    }
  ]
}

Response includes array of probes from which tests were performed.

HTTP GET Test By Country

Start http get test from probes in selected countries.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartHttpGetTestByCountry?countryCode=CZ&destination=<url>translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"
  -H 'Accept: text/plain'

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartHttpGetTestByCountry

Request Data

Format: URL parameters

Parameter Type Description
commandTimeout number Maximum allowed time to send HTTP GET request and receive the response in milliseconds. If not set it will default to timeout-1000 milliseconds
countryCode string Comma-separated list of country codes (ISO 3166, e.g. US for USA)
destination string List of URLEncoded URLs each prepended with <url>. Destination URL can start with http or https, if it does not, http is automatically presumed
maxBytes number Max bytes to download from response stream. Default 10485760 (10MB)
probesLimit number Maximum number of probes that will be tested
stateCode string 2-letter state code (applies only when CountryCode=US)
timeout number Maximum time available to probes for testing in milliseconds (default 8000)

Response

Example JSON response:

{
  "StartHttpGetTestByCountryResult": [
    {
      "ASN": {
        "AsnID": "AS5610",
        "AsnName": "O2 Czech Republic, a.s."
      },
      "Country": {
        "CountryCode": "CZ",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/cz.png",
        "CountryName": "Czech Republic",
        "State": "Karlovarsky kraj",
        "StateCode": null
      },
      "DateTimeStamp": "/Date(1472641080922+0000)/",
      "HTTPGet": [
        {
          "Status": "403",
          "ContentLength": null,
          "Destination": "http://w3.org",
          "DownloadedBytes": null,
          "TimeToFirstByte": null,
          "TotalTime": null
        }
      ],
      "ID": 222346355,
      "Location": {
        "Latitude": 50.1333,
        "Longitude": 12.35
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "15235",
        "NetworkName": "O2 Czech Republic"
      }
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

HTTP GET Test By Network

Start http get test from probes in selected network (ISP).

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartHttpGetTestByNetwork?networkID=1425&destination=<url>translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartHttpGetTestByNetwork

Request Data

Format: URL parameters

Parameter Type Description
commandTimeout number Maximum allowed time to send HTTP GET request and receive the response in milliseconds. If not set it will default to timeout-1000 milliseconds
destination string List of URLEncoded URLs each prepended with <url>. Destination URL can start with http or https, if it does not, http is automatically presumed
maxBytes number Max bytes to download from response stream. Default 10485760 (10MB)
networkID string Comma-separated list of Network IDs
probesLimit number Maximum number of probes that will be tested
timeout number Maximum time available to probes for testing in milliseconds (default 8000)

Response

Example JSON response:

{
  "StartHttpGetTestByNetworkResult": [
    {
      "ASN": {
        "AsnID": "AS25229",
        "AsnName": "Kyivski Telekomunikatsiyni Merezhi LLC"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": "",
        "StateCode": null
      },
      "DateTimeStamp": "/Date(1472641210830+0000)/",
      "HTTPGet": [
        {
          "Status": "403",
          "ContentLength": null,
          "Destination": "http://w3.org",
          "DownloadedBytes": null,
          "TimeToFirstByte": null,
          "TotalTime": null
        }
      ],
      "ID": 222149700,
      "Location": {
        "Latitude": 50.4333,
        "Longitude": 30.5167
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "1425",
        "NetworkName": "Volia"
      }
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

HTTP GET Test By ASN

Start http get test from probes selected by ASN IDs.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartHttpGetTestByASN?asnID=AS3255&destination=<url>translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartHttpGetTestByASN

Request Data

Format: URL parameters

Parameter Type Description
asnID string Comma-separated list of ASN IDs
commandTimeout number Maximum allowed time to send HTTP GET request and receive the response in milliseconds. If not set it will default to timeout-1000 milliseconds
destination string List of URLEncoded URLs each prepended with <url>. Destination URL can start with http or https, if it does not, http is automatically presumed
maxBytes number Max bytes to download from response stream. Default 10485760 (10MB)
probesLimit number Maximum number of probes that will be tested. If test requires testing multiple ASNs, probesLimit needs to be adjusted to be higher than actual number of tested ASNs
timeout number Maximum time available to probes for testing in milliseconds (default 8000)

Response

Example JSON response:

{
  "StartHttpGetTestByASNResult": [
    {
      "ASN": {
        "AsnID": "AS3255",
        "AsnName": "UARNet"
      },
      "Country": {
        "CountryCode": "UA",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ua.png",
        "CountryName": "Ukraine",
        "State": "L'vivs'ka Oblast'",
        "StateCode": null
      },
      "DateTimeStamp": "/Date(1472640644606+0000)/",
      "HTTPGet": [
        {
          "Status": "403",
          "ContentLength": null,
          "Destination": "http://w3.org",
          "DownloadedBytes": null,
          "TimeToFirstByte": null,
          "TotalTime": null
        }
      ],
      "ID": 222351268,
      "Location": {
        "Latitude": 49.8407,
        "Longitude": 24.0305
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "875",
        "NetworkName": "UARNet"
      }
    }, ...
  ]
}

Response includes array of probes from which tests were performed.

HTTP GET Test By Bounding Box

Start http get test from probes in selected area.

URL

Example request:

curl GET
  https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartHttpGetTestByBoundingBox?maxLatitude=45&maxLongitude=35&minLatitude=43&minLongitude=28&destination=<url>translate.google.com&probeslimit=10
  -H "apikey: <YourApiKey>"

GET https://kong.speedcheckerapi.com:8443/ProbeAPIService/Probes.svc/StartHttpGetTestByBoundingBox

Request Data

Format: URL parameters

Parameter Type Description
commandTimeout number Maximum allowed time to send HTTP GET request and receive the response in milliseconds. If not set it will default to timeout-1000 milliseconds
destination string List of URLEncoded URLs each prepended with <url>. Destination URL can start with http or https, if it does not, http is automatically presumed
maxBytes number Max bytes to download from response stream. Default 10485760 (10MB)
maxLatitude number Latitude of north-east corner
maxLongitude number Longitude of north-east corner
minLatitude number Latitude of south-west corner
minLongitude number Longitude of south-west corner
probesLimit number Maximum number of probes that will be tested
timeout number Maximum time available to probes for testing in milliseconds (default 8000)

Response

Example JSON response:

{
  "StartHttpGetTestByBoundingBoxResult": [
    {
      "ASN": {
        "AsnID": "AS201776",
        "AsnName": "Miranda-Media Ltd"
      },
      "Country": {
        "CountryCode": "RU",
        "CountryFlag": "http://speedcheckerapi.blob.core.windows.net/bsc-img-country-logos/ru.png",
        "CountryName": "Russia",
        "State": "",
        "StateCode": null
      },
      "DateTimeStamp": "/Date(1472640867276+0000)/",
      "HTTPGet": [
        {
          "Status": "403",
          "ContentLength": null,
          "Destination": "http://w3.org",
          "DownloadedBytes": null,
          "TimeToFirstByte": null,
          "TotalTime": null
        }
      ],
      "ID": 222372239,
      "Location": {
        "Latitude": 44.971192,
        "Longitude": 34.095115
      },
      "Network": {
        "CountryCode": null,
        "LogoURL": null,
        "NetworkID": "21735",
        "NetworkName": "Miranda-Media"
      }
    }, ...
  ]
}

Response includes array of probes from which tests were performed.