Type alias GetOptions

GetOptions: {
    linkedId?: string;
    tag?: TagValue;
    tags?: TagValue;
    timeout?: number;
}

Options for requesting the visitor information

Optional linkedId?: string

linkedId 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 tag?: TagValue
Optional tags?: TagValue

Tags is a user-provided value or object that will be returned back to you in a webhook message. You may want to use the tags 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 tags? Anything that identifies a visitor or a request. You can pass the event_id as tags and then get this event_id back in the webhook, associated with a visitorId.

If both tag and tags are provided, tags takes precedence.
Optional timeout?: number

Controls 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.
Default
```
10000
```