Capturly’s REST API (Application Programming Interface) is a platform to communicate with our servers and export the tracked data of your websites.

Please note that this API is a beta version and it will be updated with additional features in the future. If you have any request or suggestion, please feel free to send it to us at [email protected]

How does the Capturly REST API works?

The Capturly’s REST API allows you to request data from our servers. In order to authenticate the request, you should use your own API key as a query parameter.

In the header, you should define the exact format of the answer which can be a JSON or an XML.

Example of sending a request:

 

curl -X GET -i -H "Accept:application/json"
"https://api.capturly.com/v0/recordings/[websiteId]?apiKey=[apiKey]"

 

The current version of the REST API allows you to request a list of your session replays with the GET method:

 

https://api.capturly.com/v0/recordings/[websiteID]?apiKey=[apiKey]

 

The current version of the REST API allows you to request a list of your session replays with the GET method:

Please note that the apiKey is unique and it is used for authenticating the user making the request. According to this, please don’t share your apiKey and keep it private.

 

This list contains the public URL of your recordings as well, it can be found in the url column of the list. The complete list structure is the following:

aaaaaaaaa
[

  {

    “startPage”: …,

    “endPage”: …,

    “visitedPages”: …,

    “country”: …,

    “ip”: …,

    “duration”: …,

    “browser”: …,

    “url”: …,

    “createTime”: …

  },

  {

    “startPage”: …,

    “endPage”: …,

    “visitedPages”: …,

    “country”: …,

    “ip”: …,

    “duration”: …,

    “browser”: …,

    “url”: …,

    “createTime”: …

  },

  …

]

 

How can I request an API key?

 

If you would like to use the API you will need an API key (apiKey). You can request a unique API key (apiKey) by sending a request to [email protected]