Not all support ticket tools make it easy to supply programmatic custom data at the time the ticket is created by your customers. As such, we provide a secure server side API for retrieving a list of sessions for a particular user.
Learn more about the List Sessions API in our API docs.
Endpoints
GET /v2/sessionsThis endpoint returns a list of session URLs for a given user's email address or user ID. These requests are scoped to a single Fullstory account. The session URLs returned are only accessible by browsers that have logged in to the appropriate Fullstory account, and thus safe to share via email.
The parameters to this endpoint are:
| Param name | Type | Description |
|---|---|---|
limit |
int |
Optional. The max number of sessions to return (defaults to 20). |
uid |
string |
The uid is your app's user ID for the current user, set via FS('setIdentity'). |
email |
string |
The email address you have associated with a Fullstory session via FS('setIdentity') or FS('setProperties'). |
session_uid |
string |
A customer-defined session identifier (the value passed as uid when starting a session via the Fullstory SDK or server API). Returns a single matching session. Mutually exclusive with uid and email. |
Specifying both uid and email will return the union of matches. An example request and response for an email-only query with 1 result would look like:
curl -X GET \
'https://api.fullstory.com/v2/sessions?email=john@example.com' \
-H 'content-type: application/json' \
-H 'Authorization: Basic YOUR_API_KEY'Response:
{
"results": [
{
"id": "1234567890:1234567890",
"app_url": "https://app.fullstory.com/ui/ORG_ID/session/1234567890:1234567890",
"created_time": "2024-01-15T10:30:00Z"
}
]
}All requests must supply the required API key in the form of a custom request header: 'Authorization': 'Basic [YOUR API KEY]'
You can generate your integrations API key from your Settings page in Fullstory. This key also encodes your Fullstory account identifier, so no need to supply that separately.
By default the API returns the last 20 sessions the user was seen in. You can change this value by supplying an optional limit query parameter. For example:
/v2/sessions?email=john@doe.com&limit=15Third-Party Tools
These tools and libraries have been created by third-party developers for interacting with the Fullstory HTTP API. While they have not been vetted by Fullstory, we're providing them here for the benefit of other developers.
- Fullstory npm package for Node.js - The Fullstory SDK for API version 1 supporting both Promise and Callback styles.