Skip to main content
FullStory logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: FULLSTORY
  • Version: 20261030_00

Tools

Slug: FULLSTORY_CANCEL_OPERATIONIrreversibly request cancellation of a cancelable in-progress FullStory operation, currently intended for segment exports. Confirm the operation before calling because a successful cancellation request cannot be undone.

Input Parameters

string
required
Cancelable in-progress FullStory operation ID. Cancellation is irreversible; confirm the operation before calling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_CREATE_ANNOTATIONAdd a persistent annotation to the FullStory timeline for a point or time range. Warning: FullStory provides no matching delete endpoint, so a successful call cannot be cleaned up through this API.

Input Parameters

string
required
Annotation text.
string
Source system label for the annotation.
string
Annotation end time as an ISO 8601 timestamp with a timezone. When both timestamps are supplied, this must not precede start_time.
string
Annotation start time as an ISO 8601 timestamp with a timezone. Omit to use FullStory’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_CREATE_ELEMENT_BLOCKCreate a beta FullStory element recording or masking rule. Requires an Admin API key. Privacy-critical: an incorrect selector, UNMASK action, or live scope can expose sensitive data, while EXCLUDE or MASK can suppress useful recording. Review every field and prefer preview scope before calling.

Input Parameters

string
required
Human-readable rule name.
object
required
Exact selector source for the elements affected by this rule.
object
required
Privacy action, consent behavior, and session scope for matched elements.
array
required
One or more capture platforms to which the rule applies.
string
Administrator notes explaining why this privacy rule exists.
string
Stable retry key that prevents duplicate element-block creation when retrying.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_CREATE_EXTRACTION_RULECreate and immediately activate one FullStory beta extraction rule using the provider’s nested rule, source, and mapping contract. Extraction can capture sensitive element, URL, header, or body values and can materially increase collected data volume. Archiving later only stops future capture; it does not erase data already collected. Review selectors, network filters, mapping targets, property scope, and privacy policy before calling. The beta contract may change without notice. Requires an Architect or Admin API key.

Input Parameters

object
required
Complete beta extraction rule. Creation activates it immediately; review source breadth, mapped values, privacy impact, and expected data volume first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_DELETE_ELEMENT_BLOCKPermanently delete a custom FullStory privacy element-block rule. This is irreversible: removing a block or mask can expose sensitive content in future recordings. Confirm the exact custom rule first; built-in rules cannot be deleted. This API is in beta and may change without notice.

Input Parameters

string
required
Editable custom element-block rule ID. Confirm the exact rule before calling; built-in rules cannot be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_DELETE_USER_DATAPermanently delete a FullStory user and their associated data by FullStory-generated ID. This is an irreversible privacy mutation; confirm the target before calling.

Input Parameters

string
required
FullStory-generated ID of the user whose data must be permanently deleted. Confirm the target before calling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_GET_ACCOUNTValidate the connected API key and return its FullStory organization, identity, and API-key role. Do not use the role to infer paid product entitlements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_GET_ELEMENT_BLOCKGet one FullStory privacy element-block rule by ID, including its exact selector source, recording or masking operation, platforms, and editability. Warning: this exposes privacy-sensitive recording configuration. This API is in beta; functionality and documentation are subject to breaking change without notification.

Input Parameters

string
required
Element-block rule ID returned by the beta list element blocks API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_GET_EXTRACTION_RULEGet one FullStory beta extraction rule by ID, including its archive state and complete nested source and mappings.

Input Parameters

string
required
Extraction rule ID returned by List Extraction Rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_GET_IMPORT_STATUSGet status and success/error counts for an asynchronous FullStory event or user import job.

Input Parameters

string
required
Import job ID returned by Import Events or Import Users.
string ("event" | "user")
required
Type of asynchronous import job: event or user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_GET_OPERATIONGet detailed status, progress, operation-specific results, and failure details for one asynchronous FullStory operation.

Input Parameters

string
required
FullStory operation ID returned by an asynchronous workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_GET_ORGANIZATION_QUOTASReturn current FullStory session and server-event quota usage, limits, and quota periods.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_GET_RECORDING_SETTINGSGet one current FullStory recording-settings category. Privacy settings may contain sensitive configuration and large built-in rule sets; the complete provider response is preserved.

Input Parameters

string ("web" | "mobile")
Platform filter. Supported only when setting_type is domain or features.
string ("blocking" | "domain" | "geo" | "privacy" | "features" | "targeting")
required
Recording-settings category to retrieve: blocking, domain, geo, privacy, features, or targeting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_GET_SEGMENTGet metadata and the FullStory app URL for one segment.

Input Parameters

string
required
Segment ID returned by List Segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_GET_USERRetrieve one user by FullStory-generated user ID, including profile fields and a FullStory app link.

Input Parameters

string
required
FullStory-generated user ID, not the application UID.
boolean
Include property schema and type conflicts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_IMPORT_EVENTSStart an asynchronous import of 1 to 50,000 server events. This permanently adds analytics data; use an idempotency key when retrying.

Input Parameters

array
required
One to 50,000 events to import; each event requires a name.
object
Context values shared by every event in this batch.
string
Stable retry key that prevents duplicate batch import jobs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_IMPORT_USERSStart an asynchronous upsert import of 1 to 50,000 users. This mutates personal profile data.

Input Parameters

array
required
One to 50,000 users to create or update.
string
Stable retry key that prevents duplicate batch import jobs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_LIST_DATASETSList beta datasets readable by the connected FullStory organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_LIST_ELEMENT_BLOCKSReturn one page of custom and built-in FullStory privacy element-block rules. These rules determine what FullStory records or masks.

Input Parameters

string
Opaque next-page token returned by a previous call. Omit for the first page and pass it back exactly as received.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_LIST_EXTRACTION_RULESList all FullStory beta extraction rules matching one required scope and optional filters, together with current active-rule usage and limits.

Input Parameters

string ("PAGE" | "USER" | "ELEMENT" | "REQUEST" | "EVENT")
required
Extraction-rule scope to list: PAGE, USER, ELEMENT, REQUEST, or EVENT.
string
Filter rules by the extracted property name.
boolean
Whether to include archived extraction rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_LIST_IMPORT_RECORDSReturn one page of successful or failed records from a FullStory event or user import job, including failure details when requested.

Input Parameters

string
required
Import job ID returned by Import Events or Import Users.
string ("successful" | "failed")
required
Select imported records or rejected records with errors.
string ("event" | "user")
required
Type of import job whose records to list: event or user.
string
Opaque next-page token returned by a previous call. Omit for the first page and pass it back unchanged.
boolean
Include inferred schemas for successful records. Not valid for failed records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_LIST_OPERATIONSReturn one page of asynchronous FullStory operations, optionally filtered by state or type.

Input Parameters

string ("DELETE_USER" | "SEARCH_EXPORT" | "DELETE_SESSION" | "DELETE_SEGMENT_SESSIONS" | "DELETE_SEGMENT_USERS")
Operation type: DELETE_USER, SEARCH_EXPORT, DELETE_SESSION, DELETE_SEGMENT_SESSIONS, or DELETE_SEGMENT_USERS.
integer
Maximum operations to return in this page.
string ("PENDING" | "COMPLETED" | "FAILED")
Operation state: PENDING, COMPLETED, or FAILED.
string
Opaque continuation token from the previous response. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_LIST_RECORDING_SETTINGS_HISTORYReturn one page of historical FullStory recording settings for blocking, domain, geo, privacy, features, or targeting. Privacy history requires an Architect-level API key; the other categories require Standard or higher.

Input Parameters

integer
Maximum number of historical versions to return in this page.
string ("web" | "mobile")
Platform filter. Supported only for domain and features history.
string
Opaque continuation token returned by the previous call. Omit for the first page and do not decode or modify it.
string ("blocking" | "domain" | "geo" | "privacy" | "features" | "targeting")
required
Recording-settings category whose historical versions to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_LIST_SEGMENTSReturn one page of FullStory segments, optionally filtered by creator.

Input Parameters

integer
Maximum number of segments to return in this page.
string
Filter segments by creator.
string
Opaque continuation token returned by a previous call. Omit for the first page; do not decode or increment it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_LIST_SESSIONSFind recent FullStory session replay links by application UID, email, or exact session UID. Provide at least one selector; session_uid cannot be combined with uid or email. This is a filtered single-page lookup, not an unfiltered or paginated list; a no-match 404 returns an empty sessions list.

Input Parameters

string
Application-defined user ID whose recent sessions to find.
string
User email whose recent sessions to find.
integer
Maximum number of recent sessions to return. FullStory defaults to 20.
string
Exact customer-defined session UID. Cannot be combined with uid or email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_SEARCH_USERSFind FullStory users by UID, email, display name, or identification state. Provide at least one of uid, email, display_name, or is_identified. A no-match 404 is returned as an empty result page.

Input Parameters

string
Application-defined user ID filter.
string
Exact user email filter.
string
Opaque next-page token from a prior call; do not decode it.
string
Display-name filter.
boolean
Filter identified versus anonymous users.
boolean
Include property schema and type conflicts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_SET_EXTRACTION_RULE_ARCHIVEDArchive a FullStory beta extraction rule to stop future capture, or unarchive it to resume capture. Warning: this changes collection behavior immediately. Archiving does not erase data already collected, and data not captured while the rule is archived cannot be recovered by unarchiving. Confirm the rule ID and intended state before calling. Requires an Architect or Admin API key.

Input Parameters

string
required
Extraction rule ID returned by the beta extraction rules API.
boolean
required
Set true to stop future capture by this rule, or false to resume capture.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_UPDATE_ELEMENT_BLOCKFully replace an editable beta FullStory element recording or masking rule. Requires an Admin API key. This is an irreversible privacy configuration update, not a patch: read the existing rule first and provide every required replacement field. An incorrect selector, UNMASK action, or live scope can expose sensitive data, while EXCLUDE or MASK can suppress desired recording.

Input Parameters

string
required
Complete replacement rule name.
object
required
Complete replacement selector source; existing source values are not merged.
string
required
ID of the editable custom element-block rule to replace. Read the existing rule first; built-in rules may not support this update.
object
required
Complete replacement privacy action, consent behavior, and session scope; existing operation values are not merged.
array
required
Complete replacement platform list. Existing platforms omitted from this list will no longer be targeted.
string
Complete replacement administrator notes explaining why the rule exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_UPDATE_EXTRACTION_RULEPartially update a FullStory beta extraction rule using last-write-wins semantics. Provide at least one of name, description, source, or mappings. Omitted fields remain unchanged; read the current rule first. Warning: changing a rule’s source or mappings changes what FullStory captures and may affect privacy, downstream analytics, and data volume.

Input Parameters

string
Replacement rule name. Omit to leave the current name unchanged.
object
Complete replacement source definition. Omit to leave it unchanged. Changing the source changes what FullStory captures and may affect privacy.
string
required
Extraction rule ID returned by the beta extraction rules API.
array
Complete replacement mappings. Omit to leave them unchanged. Changing mappings changes extracted data and may affect privacy and data volume.
string
Replacement description. Omit to leave it unchanged; pass an empty string to clear it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FULLSTORY_UPSERT_USERCreate or update one FullStory user. Supplying fullstory_user_id updates that record; otherwise uid identifies an upsert. This mutates personal profile data.

Input Parameters

string
Application-defined user ID. Required when fullstory_user_id is omitted and immutable after a user is identified.
string
User email address.
object
Schema declarations that override inferred custom-property types.
object
Custom user properties.
string
User display name.
string
Stable retry key that prevents duplicate create or upsert requests. Omit for an ID-based update.
string
FullStory-generated ID to update. Omit to create or upsert by uid. When provided, also supply one or more mutable fields: uid for an anonymous user, display_name, email, properties, or schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not