APIs.

Back to top

SamKnows One provides a powerful set of APIs that let you interact with the SamKnows backend programmatically. This is particularly useful for automating batch tasks.

All APIs are delivered over HTTP, encrypted using TLS 1.2, and use JSON for all requests and responses.

Metadata API

The Metadata API allows you to attach supporting metadata to Whiteboxes or CPE. This includes items such as ISP, package, or service tier and timezone. You can also create entirely custom metadata fields that are specific to your network. This metadata can then be used in SamKnows One Analytics when analysing measurement results.

For more information on the Metadata API, please consult our documentation here.

Data API

The Data API provides read-only access to raw and aggregated measurement results, similar to that which you will find in SamKnows One Analytics. This API is intended for clients who wish to integrate our data into their internal platforms or backend systems.

For more information on the Data API, please consult our documentation here.

Instant Test API

The Instant Test API allows tests to be executed remotely in realtime on a SamKnows-enabled device (such as a Whitebox or CPE) and have the result returned synchronously. The time taken for each test will vary with the test requested (e.g. a 5 second speed test will result in a total response time of slightly more than 5 seconds).

For more information on the Instant Test API, please consult our documentation here.

Agent Activation API

The Agent Activation API allows you to activate or deactivate a CPE for testing. When activating a CPE, you can optionally specify the test schedule it should be assigned to and a TTL (time to live) before it reverts to an inactive state. Activating a CPE will consume one of your CPE licenses.

For more information on the Agent Activation API, please consult our documentation here.