Optional
debug(does nothing)
Use the debug
option of load()
instead
Optional
disablePrevents agent from waiting for the TLS request to complete.
Use the disableTls
option of load()
instead
Optional
extendedAdds details about the visitor to the result
Optional
ipDoes nothing
Optional
linkedlinkedId
is a way of linking current identification event with a custom identifier.
This can be helpful to be able to filter API visit information later.
Optional
productsProducts to enable. By default, all the products are enabled as determined by the billing plan.
The option to configure products became obsolete with the introduction of Smart Signals.
Billed amount is determined by the billing plan and the products
option does not influence it.
Optional
tagTag
is a user-provided value or object that will be returned back to you in a webhook message.
You may want to use the tag
value to be able to associate a server-side webhook event with a web request of the
current visitor.
What values can be used as a tag
?
Anything that identifies a visitor or a request.
You can pass the requestId as a tag
and then get this requestId back in the webhook, associated with a visitorId.
Optional
timeoutControls client-side timeout. Client timeout controls total time (both client-side and server-side) that any identification event is allowed to run. It doesn't include time when the page is in background (not visible). The value is in milliseconds.
10000
Options of getting a visitor identifier.
The TypeScript
TIP
parameter does nothing and is left for backward compatibility. It will be removed later.