Getting started
WelcomeAPI Changelog
REST API (BETA)
IntroductionResourcesUsing the APICreating a personal access tokenRate limitsFurther stepsReference

Getting started

We're happy to announce a Beta version of LiveSession's REST API. From now, you'll be able to retrieve information about your data programmatically. You can for example use the API for deeper analyze of your data collected by LiveSession.

Resources

This API provides access to some LiveSession existing resources which you usually use using a web browser. List of today supported resources are here:

  • List sessions

Using the API

The API is HTTP-based and is hosted at https://api.livesession.io/v1. To access your data, you have to get a personal access token that will be sent together with your request through headers to authenticate as follows:

Authorization: Bearer <YOUR_PERSONAL_ACCESS_TOKEN>

For example, to list the user sessions, you can perform the following request:

curl -X GET \
https://api.livesession.io/v1/sessions \
-H 'content-type: application/json' \
-H 'Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}'

Creating a personal access token

  1. Go to the settings of your account.
  2. Click API Tokens from left menu.
  3. In the upper-right corner of API Tokens page, click the creation button.
  4. Give your token a descriptive name.
  5. Select the website you want to access through the REST API.
  6. Select the scopes you'd like to grant this token.
  7. At the end click on confirm button.

Rate limits

Note that by default all tokens are set to 2 Queries Per Second (QPS). This is a per token limit.

Further steps

Issues, bugs and questions can be reported by reaching us out at hello@livesession.io