RapidSpike Documentation

Welcome to our documentation website! Use this as a resource to learn how to write your own user journeys with our JSON markup syntax and how to interact with our HTTP, RESTful API.

We have tried our best to explain ourselves, but if you require further help, technical support is available through the web-app or via your account manager.

In addition, we accept feature requests and ideas through the same channels. If we think its a great idea, or enough people request the same feature, it will be added to the development roadmap!

System API

The RapidSpike API is the backbone of our web-app and can provide all of the functionality to developers that the web-app does to its users.

Access is only available on certain subscription plans and authentication requires a public and private key currently provided by us on request (this will be changing).

We attempt to stick to a RESTful API design pattern where possible and all communication is over HTTPS.

Please take some time to read and understand the relationships between entities in the RapidSpike system.

User Journey Scripting

Our self-service user journey scripting feature provides developers with a way to write their own journeys.

Journeys are ran using Selenium WebDriver and Google Chrome, via a BrowserMob proxy to record the page elements into HAR files.

The generated HAR files and statistics collected in these journeys are then analysed in great detail, with the output providing a comprehensive toolkit for measuring the performance of the tested website. We also provide a highly customisable notification engine allowing users to create rules around the following areas:

  • Journey run times
  • Detected page errors
  • Image size and load time
  • Javascript file size and load time
  • CSS file size and load time