Skip to main content

FullStory Data Source

The FullStory connector enables you to ingest behavioral analytics data — including user records, session information, and captured events — from your FullStory account into Nexla for analysis, reporting, or downstream processing. Follow the instructions below to create a new data flow that ingests data from a FullStory source in Nexla.
fullstory_api.png

FullStory

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the FullStory connector tile from the list of available connectors. Then, select the credential that will be used to connect to the FullStory instance, and click Next; or, create a new FullStory credential for use in this flow.

  3. In Nexla, FullStory data sources can be created using pre-built endpoint templates, which expedite source setup for common FullStory endpoints. Each template is designed specifically for the corresponding FullStory endpoint, making data source setup easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    FullStory sources can also be configured manually, allowing you to ingest data from FullStory endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common FullStory endpoints. Each template is designed specifically for the corresponding FullStory endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List Block Rules

    Retrieves all recording block rules configured in the FullStory account. Use this endpoint to audit which CSS selectors or page elements are excluded from session capture.

    This endpoint requires an API key with at least read access to recording settings. No additional parameters are needed.

    Get Domain Settings

    Retrieves the domain recording settings for your FullStory account, including which domains are enabled for session capture.

    No parameters are required. This endpoint returns a single settings object rather than a list.

    Get Geo Settings

    Retrieves geographic-based recording settings, such as which countries or regions are included or excluded from session capture.

    No parameters are required. Returns a single configuration object.

    Get Recording Features

    Retrieves the recording features and capabilities that are enabled for your FullStory account, such as heatmaps or mobile recording.

    Feature availability depends on your FullStory plan tier. No parameters are required.

    List Session Targeting Rules

    Retrieves all session targeting rules configured in FullStory, which determine which user sessions are captured based on criteria such as URL patterns or user attributes.

    No parameters are required. Each returned rule includes its conditions and capture percentage settings.

    List Webhooks

    Retrieves all webhook endpoints configured in FullStory for receiving system event notifications, such as session recording or export completion events.

    No parameters are required. Use this endpoint to audit your current webhook configurations.

    List Event Types

    Retrieves all available event types that can be subscribed to via FullStory webhooks, such as session recording events or export status changes.

    No parameters are required. Use this to determine which event types are available for webhook subscriptions in your FullStory account.

    Get User

    Retrieves profile data and custom properties for a specific FullStory user identified by their UID or internal ID.

    • Sends a GET request to https://api.fullstory.com/v2/users/{uid} and returns the full user object.
    • Response data is located at $ (the top-level response object).
    • Configure the following parameter: User UID — the UID or internal ID of the user to retrieve.

    The User UID must match an existing user in your FullStory account. Use the List Users endpoint to discover valid UIDs.

    List Users

    Retrieves a paginated list of FullStory users matching the supplied filter criteria, such as email address or UID.

    • Sends a GET request to https://api.fullstory.com/v2/users/list with optional query parameters and returns an array of user objects.
    • Response data is located at $.users[*].
    • Configure the following parameters: User UID — filter by UID; Email — filter by email address; Limit — maximum number of results to return; Page Token — token for paginating through results.

    All parameters are optional. To paginate through large result sets, use the page token returned in the previous response.

    Get Segment

    Retrieves segment information — including name, creator, and app URL — for a specific FullStory segment by its ID.

    • Sends a GET request to https://api.fullstory.com/segments/v1/{id} and returns the segment object.
    • Response data is located at $ (the top-level response object).
    • Configure the following parameter: Id — the unique identifier of the segment to retrieve.

    Segment export operations are available on Enterprise plans. The segment ID can be found in the FullStory UI or by using the List Segments endpoint.

    Get Operation Status

    Returns the current status of a long-running FullStory operation, such as a segment export or user deletion job.

    • Sends a GET request to https://api.fullstory.com/operations/v1/{id} and returns the operation status object.
    • Response data is located at $ (the top-level response object).
    • Configure the following parameter: Id — the operation ID returned when the long-running operation was initiated.

    Poll this endpoint to track the progress of async operations. When the status is complete, use Get Export Results to retrieve the output.

    Get Export Results

    Retrieves a download link for a completed segment export operation, allowing you to access the exported data.

    Only call this endpoint after the operation status is complete. Requires Enterprise plan access for segment exports.

    Get Event Export

    Downloads a specific legacy Data Export bundle by its ID as a JSON file, enabling ingestion of exported event data.

    • Sends a GET request to https://api.fullstory.com/exports/v1/{id} and returns the export bundle content.
    • Response data is located at $ (the top-level response object).
    • Configure the following parameter: Id — the ID of the legacy event export bundle.

    This endpoint uses the legacy Data Export v1 API. For new integrations, consider using the segment export workflow instead.

    Get User Events

    Retrieves indexed high-level events captured by FullStory for a specific user, useful for analyzing user behavior patterns.

    Returns high-level indexed events (page views, clicks, errors) rather than raw interaction data. For complete raw event data, use the segment export workflow.

    Get User Pages

    Retrieves a user's visited pages including raw event data recorded on each page visit.

    Each page record includes the URL visited, timestamp, and associated raw events. This can return large payloads for active users.

    Get Batch Events Imports

    Retrieves event details for successfully imported events from a previously submitted batch events import job.

    Use this endpoint to verify the results of a completed batch import job initiated via the Create Batch Events Import Job operation.

    Generate Session Summary

    Returns a generative AI summarization of a specified FullStory session using a configured prompt summary profile.

    • Sends a GET request to https://api.fullstory.com/v2/sessions/{id}/summary and returns a structured summary object.
    • Response data is located at $ (the top-level response object).
    • Configure the following parameters: Id — the session ID to summarize; Profile ID — the ID of the prompt profile to use for summarization.

    AI-powered session summaries require the appropriate FullStory plan. The prompt profile determines the structure and focus of the generated summary.

    Check Batch User Import Job Status

    Checks the status of a batch user-import job previously submitted via the Batch Create Users endpoint.

    Poll this endpoint periodically after submitting a batch user import to confirm it has completed successfully before processing the results.

    List Session Replay URLs

    Retrieves a list of session replay URLs for users queried by email address and/or UID, making it easy to link user records to their recorded sessions.

    • Sends a GET request to https://api.fullstory.com/sessions/v2 with optional filter parameters and returns an array of session URL objects.
    • Response data is located at $.sessions[*].
    • Configure the following parameters: Uid — filter sessions by user UID; Email — filter sessions by user email; Limit — maximum number of sessions to return.

    At least one of Uid or Email is required. Session replay URLs are direct links to the FullStory session player.

    List Segments

    Retrieves a paginated list of all segments defined in your FullStory account, including segment names and creator information.

    • Sends a GET request to https://api.fullstory.com/segments/v1 with optional limit and pagination parameters and returns an array of segment objects.
    • Response data is located at $.segments[*].
    • Configure the following parameters: Limit — maximum number of segments to return; Pagination Token — token for paginating through results.

    Segment management and export features require an Enterprise plan. Use the returned segment IDs with the Get Segment or Get Export Results endpoints.

    List Operations

    Retrieves a paginated list of all operations — both ongoing and completed — for the FullStory account, useful for monitoring export or bulk processing jobs.

    • Sends a GET request to https://api.fullstory.com/operations/v1 with optional filter parameters and returns an array of operation objects.
    • Response data is located at $.operations[*].
    • Configure the following parameters: Limit — maximum number of operations to return; State — filter by operation state (e.g., pending, complete); Type — filter by operation type.

    All parameters are optional. Use this endpoint to monitor the status of all long-running jobs in your account.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

FullStory sources can also be configured manually, allowing you to ingest data from FullStory endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs. First, select the method that will be used for calls to the FullStory API from the Method pulldown menu. The most common methods for FullStory data ingestion are:

  • GET: For retrieving users, sessions, events, or export data
  • POST: For triggering segment exports or batch operations

API Endpoint URL​

  1. Enter the URL of the FullStory API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

    Common FullStory Server API base URLs include:

    • Users: https://api.fullstory.com/v2/users — retrieve user records
    • Sessions for a user: https://api.fullstory.com/sessions/v2?email={user_email} — list session URLs for a given user
    • Session events: https://api.fullstory.com/v2/sessions/{session_id}/events — retrieve all events captured in a specific session
    • Segment exports: https://api.fullstory.com/segments/v1 — list or initiate segment data exports (Enterprise only)

Ensure the API endpoint URL is correct and accessible with your current credentials. The FullStory Server API uses https://api.fullstory.com as its base URL for all v2 endpoints. Additional documentation is available in the FullStory Developer Guide.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros — all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is particularly useful for FullStory endpoints that accept date or timestamp parameters to filter data by time range.

Macros are particularly useful for FullStory APIs that accept time-based query parameters, such as filtering session exports by date range or retrieving events within a specific time window.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime — for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro — i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu — for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data. For FullStory, this is useful when you need to iterate over a list of user IDs or session IDs sourced from another Nexla data set.

Lookup-based macros are useful when you need to create FullStory API endpoints that reference specific user IDs, session IDs, or other values from other data sources in your Nexla environment.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the FullStory API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. FullStory API responses typically return data nested within a top-level JSON object, so specifying the path to the relevant array or object is important for correct data parsing.

For example, when fetching a list of users from the FullStory Users API, the response returns a JSON object containing a users array. By specifying the path $.users[*], you configure Nexla to treat each element of that array as a separate record.

Path to Data is essential for FullStory API responses, which typically wrap returned records in a named array (e.g., users, events, sessions). Without specifying the correct path, Nexla may not correctly parse and organize the data into individual records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.users[*] to access the users array, or $.events[*] to access an array of captured events).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    For the FullStory Users API (GET https://api.fullstory.com/v2/users), the response wraps user records in a top-level users array. Enter $.users[*] as the path to treat each user record as an individual Nexla record.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. FullStory API responses often include pagination tokens, total counts, or request-level context outside the primary data array — these can be preserved as metadata for each record.

For example, when fetching users from the FullStory Users API, the response includes a nextPageToken field at the top level alongside the users array. If you want to preserve this pagination context with each user record, you can specify a metadata path to capture it.

Metadata paths are particularly useful for preserving FullStory API response context like pagination tokens, request IDs, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). For FullStory, additional headers may be needed for API versioning or to specify content type for POST requests.

    You do not need to include the Authorization header here — it is automatically handled by Nexla using the API key configured in your FullStory credential. Common headers like Authorization and Content-Type are handled automatically based on your credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new FullStory data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.