Visitor programs: forget, identify, merge

Reference for Visitor, one group of Visitor programs.

Visitor.forget

Forget masks a person’s captured data across every Event and Recording and suppresses further capture, keeping the records. Verb page.

Text

do: return await $.Visitor.forget(input)

Emits Visitor.forgotten.

Inputs

Input	Type	Required	Description
`visitor`	Visitor	required	The Visitor to forget.
`request`	`text`	required	The privacy request it answers.

Returns

Output	Type	Required	Description
`visitor`	Visitor	required	The Visitor, masked.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Visitor.forget({ visitor: 'visitor_M5gHadysq9', request: 'Example request' })"
  }
}

Visitor.identify

Identify joins a Visitor to the Contact it turns out to be, so earlier Visits count toward that person. Verb page.

Text

do: return await $.Visitor.identify(input)

Emits Visitor.identified.

Inputs

Input	Type	Required	Description
`visitor`	Visitor	required	The Visitor.
`contact`	Contact	required	The Contact or Customer the Visitor is.

Returns

Output	Type	Required	Description
`contact`	Contact	required	The Contact, with the Visitor’s Visits attached.
`visitor`	Visitor	required	The Visitor, now joined to its Contact.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Visitor.identify({ visitor: 'visitor_M5gHadysq9', contact: 'contact_WsrosCQi6J' })"
  }
}

Visitor.merge

Merge joins two Visitor ids that belong to one person and keeps both as aliases. Verb page.

Text

do: return await $.Visitor.merge(input)

Emits Visitor.merged.

Inputs

Input	Type	Required	Description
`visitor`	Visitor	required	The Visitor to merge.
`into`	Visitor	required	The Visitor that remains.

Returns

Output	Type	Required	Description
`visitor`	Visitor	required	The remaining Visitor.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Visitor.merge({ visitor: 'visitor_M5gHadysq9', into: 'visitor_M5gHadysq9' })"
  }
}

Visitor.forgetCopy Anchor Link

Visitor.identifyCopy Anchor Link

Visitor.mergeCopy Anchor Link

Visitor.forget

Visitor.identify

Visitor.merge