Interface VisitorQueryContext

interface VisitorQueryContext {
    data?: VisitorData;
    error?: Error;
    getData: ((tags?, linkedId?) => Promise<null | VisitorData>);
    isLoading?: boolean;
}

Hierarchy

  • VisitorQueryResult
    • VisitorQueryContext

Properties

data? error? getData isLoading?

Properties

Optional data

data?: VisitorData

Visitor identification dataaaa

Optional error

error?: Error

Error message in case of failed getData() call

getData

getData: ((tags?, linkedId?) => Promise<null | VisitorData>)

Retrieve the visitor identifier using your public API key.

Type declaration

    • (tags?, linkedId?): Promise<null | VisitorData>

    • Retrieve the visitor identifier using your public API key.

      Parameters

      • Optional tags: Tags

        is a customer-provided value or an object that will be saved together with the analysis event and will be returned back to you in a webhook message or when you search for the visit in the server API. more info in the documentation page

      • Optional linkedId: string

        is a way of linking current analysis event with a custom identifier. This will allow you to filter visit information when using the Server API more info in the documentation page

      Returns Promise<null | VisitorData>

Param: tags

is a customer-provided value or an object that will be saved together with the analysis event and will be returned back to you in a webhook message or when you search for the visit in the server API. more info in the documentation page

Param: linkedId

is a way of linking current analysis event with a custom identifier. This will allow you to filter visit information when using the Server API more info in the documentation page

Optional isLoading

isLoading?: boolean

Request state after calling getData()

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc