Update Element Block Rules (Deprecated)

Updates the current element block rules privacy settings.

This API is currently deprecated. A V2 version will be made available at a later date.

Request Body required

addElementBlocks object[] optional
Array [
selector string optional
A CSS selector identifying the elements that this block rule should apply to. Required.
groupId int64 optional
Membership in a privacy rule group. Defaults to 0, means no group.
consentControlled boolean optional
If true, indicates that it is safe to record these elements in sessions with user consent. Optional. Defaults to false.
notes string optional
Administrator notes about this rule. Optional.
type string optional
Possible values: [BLOCK_EXCLUDE, BLOCK_MASK, BLOCK_UNMASK]
What type of block rule this is. See Fullstory privacy documentation for details. Optional. Defaults to BLOCK_EXCLUDE.
scope string optional
Possible values: [ALL_SESSIONS, NO_SESSIONS, PREVIEW_SESSIONS_ONLY, LIVE_SESSIONS_ONLY]
Default value: ALL_SESSIONS
RuleScope is used to limit the scope exclusion rules so a customer can dogfood a rule in "audited" sessions they record themselves before turning the rule on for all of their users.
• ALL_SESSIONS: Apply always (default).
• NO_SESSIONS: Never apply.
• PREVIEW_SESSIONS_ONLY: Apply only for "previewed" sessions e.g. to test the addition of a BLOCK_UNMASK rule.
• LIVE_SESSIONS_ONLY: Apply only for non-preview sessions e.g. to test the removal of an BLOCK_EXCLUDE rule.
ruleExceptions object[] optional
CSS selectors identifying elements that this block rule should NOT apply to.
Array [
selector string optional
CSS selectors identifying elements that this block rule should NOT apply to.
]
]
updateElementBlocks object[] optional
Array [
key object optional
Subset of properties from ElementBlockRules used for uniquely identifying the ElementBlockRules. Required.
selector string optional
A CSS selector identifying the elements that this block rule should apply to.
groupId int64 optional
Membership in a privacy rule group. Defaults to 0, means no group.
update object optional
The desired update values for the ElementBlockRules Required.
selector string optional
A CSS selector identifying the elements that this block rule should apply to. Optional. No-op when not provided, or if an empty string is provided.
consentControlled boolean optional
If true, indicates that it is safe to record these elements in sessions with user consent. Optional. No-op when not provided.
notes string optional
Administrator notes about this rule. Optional. No-op when not provided. Providing an empty string will remove any existing notes.
type string optional
Possible values: [BLOCK_EXCLUDE, BLOCK_MASK, BLOCK_UNMASK]
What type of block rule this is. See Fullstory privacy documentation for details. Optional. No-op when not provided.
scope SessionScope includes all the possible RuleScope enums, but adds an UNSET default. Since RuleScope doesn't have a UNSET, we can't safely perform no-op. Using a wrapper like RuleScopeUpdate makes the API inconsistent for callers, as it requires callers to provide a "value" field, which looks like below (json): { "rule_scope": { "value": "ALL_SESSIONS" } }. So, instead, the new SessionScope enum defaults to UNSET that allows a easy notion of "no-op" NB: It's also important to know that now the actual int value is different from that in RuleScope, making it necessary to use the string representations, not integers! optional
Possible values: [ALL_SESSIONS, NO_SESSIONS, PREVIEW_SESSIONS_ONLY, LIVE_SESSIONS_ONLY]
The scope of the rule, which determines which sessions are affected. Optional. No-op when not provided.
ruleExceptions object[] optional
A list of exceptions identifying elements by CSS selectors that this block rule should NOT apply to. The entire list will be replaced, any existing exceptions will be cleared if not provided, or if an empty array [] is provided.
groupId int64 optional
]
removeElementBlocks object[] optional
Array [
selector string optional
A CSS selector identifying the elements that this block rule should apply to.
groupId int64 optional
Membership in a privacy rule group. Defaults to 0, means no group.
]

Responses

200

---

A successful response.

Schema

Example

---

Schema

elementBlocks object[] optional
Array [
selector string optional
consent boolean optional
notes string optional
type string optional
Possible values: [BLOCK_EXCLUDE, BLOCK_MASK, BLOCK_UNMASK]
scope string optional
Possible values: [ALL_SESSIONS, NO_SESSIONS, PREVIEW_SESSIONS_ONLY, LIVE_SESSIONS_ONLY]
Default value: ALL_SESSIONS
RuleScope is used to limit the scope exclusion rules so a customer can dogfood a rule in "audited" sessions they record themselves before turning the rule on for all of their users.
• ALL_SESSIONS: Apply always (default).
• NO_SESSIONS: Never apply.
• PREVIEW_SESSIONS_ONLY: Apply only for "previewed" sessions e.g. to test the addition of a BLOCK_UNMASK rule.
• LIVE_SESSIONS_ONLY: Apply only for non-preview sessions e.g. to test the removal of an BLOCK_EXCLUDE rule.
lastUpdated date-time optional
label string optional
targetingConditions object optional
privacyTargetingConditions object[] optional
Array [
attr Targeting rules for privacy settings and session recording Attributes of the session compared against in a TargetingRuleCondition optional
Possible values: [UID, IP, LOCATION, PLATFORM, DOMAIN, USER_AGENT, APP_VERSION, BUILD_TYPE, FS_VERSION, FS_BUILD_ID, OS_VERSION, MODEL, MANUFACTURER]
• UID: common
identified user
• PLATFORM: a value of schema.PageTypeEnum
• DOMAIN: web related
• APP_VERSION: native mobile related
application version string (can be normalized to a numeric value for comparison operators, if in dotted quad form)
• BUILD_TYPE: application build variant
• FS_VERSION: application fs instrumentation version
• FS_BUILD_ID: application fs build id
• OS_VERSION: operating system version
• MODEL: device model
• MANUFACTURER: device manufacturer
op Comparison operators that we use to compare a targeting attribute’s incoming value against a declared value in a TargetingRuleCondition optional
Possible values: [EQ, NEQ, LT, LTE, GT, GTE, RANGE, CONTAINS]
values object[] optional
Array [
strVal string optional
intVal int64 optional
versionVal object optional
major uint64 optional
minor uint64 optional
build uint64 optional
revision uint64 optional
]
joinPrevious conjunction type to use for the previous condition if multiple optional
Possible values: [AND, OR]
]
editable string optional
Possible values: [EDITABLE_ANY, EDITABLE_DESCRIPTION_ONLY, EDITABLE_DESCRIPTION_SCOPE_AND_EXCEPTIONS]
Default value: EDITABLE_ANY
exceptionSelectors string[] optional
groupId int64 optional
Membership in a privacy rule group. 0 means no group.
]

{
  "element_blocks": [
    {
      "selector": "input[type=password]",
      "consent": false,
      "notes": "",
      "type": "BLOCK_EXCLUDE",
      "scope": "ALL_SESSIONS",
      "lastUpdated": "0001-01-01T00:00:00Z",
      "label": "",
      "targetingConditions": null,
      "editable": "EDITABLE_DESCRIPTION_ONLY",
      "exceptionSelectors": [],
      "groupId": 0
    }
  ]
}

POST /settings/recording/v1/privacy:element-block-rules

Authorization: ApiKeyAuth

name: Authorizationin: headertype: apiKey

Body

{
  "addElementBlocks": [
    {
      "selector": "string",
      "groupId": 0,
      "consentControlled": true,
      "notes": "string",
      "type": "UNSET",
      "scope": "ALL_SESSIONS",
      "ruleExceptions": [
        {
          "selector": "string"
        }
      ]
    }
  ],
  "updateElementBlocks": [
    {
      "key": {
        "selector": "string",
        "groupId": 0
      },
      "update": {
        "selector": "string",
        "consentControlled": true,
        "notes": "string",
        "type": "UNSET",
        "scope": "UNSET",
        "ruleExceptions": [
          {}
        ],
        "groupId": 0
      }
    }
  ],
  "removeElementBlocks": [
    {
      "selector": "string",
      "groupId": 0
    }
  ]
}

https://api.fullstory.com/settings/recording/v1/privacy:element-block-rules

cURL

curl -L -X GET 'https://api.fullstory.com' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'

Python

curl -L -X GET 'https://api.fullstory.com' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'

Go

curl -L -X GET 'https://api.fullstory.com' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'

Javascript

curl -L -X GET 'https://api.fullstory.com' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'