If you’re a monitoring customer, you’re probably familiar with the various reports available in our portal. You probably also get email and/or text alerts from time to time, and you may have our dashboard on display in your network operations centre. If you need a little more in the way of customisation, perhaps you’ve even delved into the world of management reports.
But did you know you can get much, much more?
Our monitoring platform API allows you to access your test results through standard HTTP requests and extract them in a variety of formats, such as XML, JSON, PHP or YAML.
Once you have the data, what you do with it next is up to you. For example, you might want to:
- Integrate it with other data, such as PPC, traffic or sales figures
- Generate customised reports in your company style
- Create a dashboard (if our own interactive dashboard isn’t quite what you need).
If you’re looking for some inspiration, you can see one example of the API at work here.
How do you use it?
We appreciate that you probably won’t be using the API every day, so we’ve tried to make sure that the learning curve isn’t too steep.
What’s more, to help you get started, we’ve just published a step-by-step user guide. This comprehensive manual will help you get everything you need from the API. You can even download a video that will walk you through an example.
The guide is packed with sample queries so, whether you’re planning to run queries manually or build an application to get the data programmatically, you should be up and running in no time.