List sessions

List sessions

curl --request GET \
  --url https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "results": [
    {
      "id": "<string>",
      "object": "contentSession",
      "answers": [
        {
          "id": "<string>",
          "object": "contentSessionAnswer",
          "answerValue": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "questionCvid": "<string>",
          "questionName": "<string>"
        }
      ],
      "completed": true,
      "completedAt": "<string>",
      "endedAt": "<string>",
      "endReason": "<string>",
      "contentId": "<string>",
      "content": {
        "id": "<string>",
        "object": "content",
        "name": "<string>",
        "editedVersionId": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "companyId": "<string>",
      "company": {
        "id": "<string>",
        "object": "company",
        "attributes": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "lastActivityAt": "2023-11-07T05:31:56Z",
      "progress": 123,
      "userId": "<string>",
      "user": {
        "id": "<string>",
        "object": "user",
        "attributes": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "versionId": "<string>",
      "version": {
        "id": "<string>",
        "object": "contentVersion",
        "number": 123,
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

GET

projects

{projectId}

environments

{environmentId}

sessions

List sessions

curl --request GET \
  --url https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usertour.io/v2/projects/{projectId}/environments/{environmentId}/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "results": [
    {
      "id": "<string>",
      "object": "contentSession",
      "answers": [
        {
          "id": "<string>",
          "object": "contentSessionAnswer",
          "answerValue": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "questionCvid": "<string>",
          "questionName": "<string>"
        }
      ],
      "completed": true,
      "completedAt": "<string>",
      "endedAt": "<string>",
      "endReason": "<string>",
      "contentId": "<string>",
      "content": {
        "id": "<string>",
        "object": "content",
        "name": "<string>",
        "editedVersionId": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "companyId": "<string>",
      "company": {
        "id": "<string>",
        "object": "company",
        "attributes": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "lastActivityAt": "2023-11-07T05:31:56Z",
      "progress": 123,
      "userId": "<string>",
      "user": {
        "id": "<string>",
        "object": "user",
        "attributes": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "versionId": "<string>",
      "version": {
        "id": "<string>",
        "object": "contentVersion",
        "number": 123,
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId

string

required

Environment ID

projectId

string

required

Project ID

Query Parameters

contentId

string

Filter to a single content.

userId

string

Filter to a single end-user.

completed

enum<string>

Filter by GENUINE completion: true = the user reached the goal (flow finished / every checklist task done), false = did not. This is NOT "ended" — a dismissed session is not completed, and a completed checklist may still be open.

Available options:

true,

false

limit

integer

default:20

Max items per page (1-100, default 20).

Required range: 1 <= x <= 100

cursor

string

Opaque page cursor — the cursor query value found inside a prior response's next/previous URL. Normally you never build this yourself: just GET those URLs as-is.

orderBy

Order by createdAt / -createdAt.

Available options:

createdAt,

-createdAt

expand

Inline: answers, content, company, user, version.

Available options:

answers,

content,

company,

user,

version

createdAfter

string

Only items created at or after this time — ISO date or datetime WITH timezone. A date-only value starts at that day's first instant (UTC).

createdBefore

string

Only items created at or before this time — ISO date or datetime WITH timezone. A date-only value includes the ENTIRE day (up to its last instant, UTC).

Response

List of content sessions

results

object[]

required

Show child attributes

string | null

required

Full URL of the next page — request it as-is (it already carries cursor= and your query parameters). null = no further pages.

string | null

required

Full URL of the previous page — request it as-is. null = already at the first page.

Getting started

Conventions

Concepts

Endpoints

Authorizations

Path Parameters

Query Parameters

Response