Once you've created anAPI Key, you're ready to start sending data to Fullstory.

• User data can be created and modified via theUsers API.
• Multiple users can be batch created with theBatch Import Users API.
• Event data can be created with theEvents API.
• Multiple events can be batch created with theBatch Import Events API.

Differences between V1 and V2​

The current API version (V2) is initially focused on enhanced data capture and processing.

Some features that will remain in the V1 API:

• Segment Export
• List Sessions
• Privacy Settings
• Get User Events
• Get User Pages

Migrating from V1 to V2​

• The V1Set User Properties endpoint is replaced byPOST /v2/users andPOST /v2/users/batch.
• The V1Set User Events endpoint is being replaced byPOST /v2/events andPOST /v2/events/batch.

Changes to custom properties​

The V2 API has significant changes to how custom properties for users and events are defined. Type suffixes are no longer required for custom properties.In fact, it is actually required that you omit these suffixes for all custom properties.Types will be inferred, but they can be declared explicitly by using the optionalschema.SeeCustom Properties for more details.

Examples​

V1 user data updates require the addition of type suffixes on custom field names:

POST /users/v1/individual/{uid}/customvars

{
  "displayName": "Daniel Falko",
  "email": "daniel.falko@example.com",
  "pricingPlan_str": "free",
  "popupHelp_bool": true,
  "totalSpent_real": 14.55
}

It is required that you omit these suffixes for all custom properties for V2 user data create/update.Types will be inferred unless explicitly declared in aschema collection. All custom data is captured in aproperties collection:

POST /v2/users

{
  "uid": "xyz123",
  "display_name": "Daniel Falko",
  "email": "daniel.falko@example.com",
  "properties": {
    "pricing_plan": "paid",
    "popup_help": true,
    "total_spent": 14.55
  }
}

Greater flexibility for user data​

• In the V1 API, only users that have been identified during a browser or mobile app session can be updated via theSet User Properties endpoint. Otherwise, the APIcall will return a404 "user not found" error.
• The V2 API allows for user data creation and management for users thathave not already been captured in a session.Anonymous users as well as identified users can be created/updated via thePOST /v2/users andPOST /v2/users/batch endpoints.Unlike the V1 API, a404 error will not be returned if you send user data that hasn't already been captured in a session.
• The V2 API returns a Fullstory-generatedid field in case you wish to use it to reference user data in Fullstory.You can still provide auid with the identifier that you already use in your system for any given user.

API Guarantees​

• Over time, as an anonymous user is identified across multiple devices and via the server API, they will representa single “logical” user.
• A Fullstory-generated userid will remain stable and will be guaranteed to reference the same logical user afterthat user has been identified.
• Once a user is identified, a different “id” value may be returned in the server API response of an operation on thatuser.
• Once a user is identified, the state of their properties collection will represent the most recent state set for thatuser, even when property values were set when the user was anonymous, prior to being identified.
• This means we will merge existing user properties with new properties being set, and resolve any collisions by takingthe most recent value
• Once a server APIuid value has been set for a user (i.e. they’ve been identified), that value is immutable and anyattempt to update the existing value will result in an error.

Data Residency​

Fullstory usesGoogle Cloud Platform data centers toprocess and store data. The default data center for all customers is located in the US. As of August 2022, Fullstoryalso has a data center in the European Union (“EU”). Customers now have the option to designate the location of thedata center that supports their Fullstory account.

All API requests use theapi.fullstory.com domain. They are automatically routed to the correct data center based onwhat is configured for your Fullstory account. You can determine which data center your account is associated with inone of two ways:

• The Fullstory URL you use to login
  • https://app.fullstory.com/ uses thena1 data center
  • https://app.eu1.fullstory.com uses theeu1 data center
• TheAPI key you are using for API authentication. The data center used is included as the firstthree characters of the API key. If your API key was created prior to August 2022, it may not include this prefix. Inthis case, your API key will be associated with thena1 data center.
  • API key format:<data center>.<token>

Server Event Quota​

Each Fullstory account includes a maximum number of server events that can be captured withina monthly or annual cycle. View the server event quota for the account as well as the total number ofserver events that have been recorded in the current cycle atSettings > Account Management > Subscription.

API requests that exceed the server event quota will receive a429 response code.

Additional Information​

• Authentication
• Fullstory Data Residency
• Managing API Keys