Get Target Rules

Returns the current set of targeting rules.

Responses

200

---

A successful response.

Schema

Example

---

Schema

sessionTargetingRules object[] optional
Array [
id a named identifier for this rule, which can be referenced to build a composite rule by a UI optional
notes additional information provided by the author optional
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.
conditions 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]
]
children object[] optional
Array [
id string optional
joinPrevious Joins multiple TargetingRuleConditions and/or TargetingRules optional
Possible values: [AND, OR]
]
]
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.

{
  "sessionTargetingRules": [],
  "metadata": {
    "lastUpdated": "2020-10-01T23:53:06.496Z",
    "lastUpdatedBy": "bob@example.com",
    "created": "2020-10-01T23:53:06.496Z",
    "createdBy": "bob@example.com"
  }
}

Loading...