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.
Note: v1 of the List Sessions API has been deprecated as of January 28, 2022 and will be sunset on June 30, 2022. For more info on v2, check out our API docs.
Endpoints
/sessions/v2
This endpoint returns a list of session URLs for a given user’s email address. These requests are scoped to user in the context of a single Fullstory account. These URLs are only accessible by browsers who 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.identify. |
email |
string |
The email address that you have associated with a Fullstory session via FS.identify orFS.setUserVars. |
Specifying both uid and email will return the union of matches for a given uid or email. An example request and response for an email only query with 1 result would look like:
curl -X GET \
'https://api.fullstory.com/sessions/v2?email=john@example.com' \
-H 'content-type: application/json' \
-H 'Authorization: Basic YOUR_API_KEY'
Response:
{
"sessions": [
{
"userId": "1234567890",
"sessionId": "1234567890",
"createdTime": "1411492739",
"fsUrl": "https://www.fullstory.com/ui/ORG_ID/discover/session/1234567890:1234567890"
}
]
}
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. Callers can change this value by supplying an optional limit parameter.
There are two ways to make requests to this endpoint:
GETrequests must supply arguments as simple URL query parameters. For example:
/sessions/v2?email=john@doe.com&limit=15
POSTrequests must submit arguments as part of a JSON encoded request body. An examplePOSTrequest would be:
{
limit: 20,
email: john@doe.com
}
Third-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.