Get Privacy Settings

Returns the current privacy settings, including element blocks, ajax watches, etc.

Responses

200

---

A successful response.

Schema

Example

---

Schema

elementBlocks object[] optional
This field contains the raw element blocks set by the customer as part of their recording configuration. Don't use it directly for recording; instead, call EvalElementBlocks() to get the final set of element blocks that the recording script/plugins should see.
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.
]
ajaxWatches object[] optional
Array [
urlRegex string optional
recordReq string optional
Possible values: [ELIDE, RECORD, WHITELIST]
Default value: ELIDE
recordRsp string optional
Possible values: [ELIDE, RECORD, WHITELIST]
Default value: ELIDE
whitelistReq string optional
whitelistRsp string optional
]
discardIpAddresses boolean optional
metadata object optional

lastUpdated date-time optional

When this entity was last updated.

lastUpdatedBy string optional

Who made the last update to this entity.

created date-time optional

When this entity was first created.

createdBy string optional

Who first created this entity.

defaultPrivacyMode string optional
elementRuleGroups object optional

Element Privacy rule groups for this org.

property name* object optional

groupId int64 optional

templateId string optional

Possible values: [NONE, FORM_PRIVACY]

Default value: NONE

Used by the UI to add special copy or rendering.

note string optional

overrides object optional

ElementPrivacyRuleOverride is used to define properties of Rule Groups that override properties of member rules. This message is similar to ElementBlockRulesUpdate, but with different properties.

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.

editable string optional

Possible values: [EDITABLE_ANY, EDITABLE_DESCRIPTION_ONLY, EDITABLE_DESCRIPTION_SCOPE_AND_EXCEPTIONS]

Default value: EDITABLE_ANY

{
  "elementBlocks": [
    {
      "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
    }
  ],
  "ajaxWatches": [
    {
      "urlRegex": "/session\\?.*",
      "recordReq": "ELIDE",
      "recordRsp": "WHITELIST",
      "whitelistReq": "",
      "whitelistRsp": ""
    },
    {
      "urlRegex": "/highlights/share.*",
      "recordReq": "ELIDE",
      "recordRsp": "WHITELIST",
      "whitelistReq": "",
      "whitelistRsp": ""
    }
  ],
  "discardIpAddresses": false,
  "metadata": {
    "lastUpdated": "2021-06-03T14:57:32.623593Z",
    "lastUpdatedBy": "bob@example.com",
    "created": "2020-09-30T18:49:27.391Z",
    "createdBy": "bob@example.com"
  },
  "defaultPrivacyMode": "PRIVACY_MODE_OFF",
  "elementRuleGroups": {}
}

Loading...