setVisitorIdFromDeepLink

The setVisitorIdFromDeepLink() method sets the visitor ID from the pk_vid parameter extracted from a deep link URL. This allows linking a website visitor to an app visitor.

Syntax

await FlutterPiwikPro.sharedInstance.setVisitorIdFromDeepLink(deepLink);

Parameters

deepLink (string, required)

The deep link URL containing the pk_vid query parameter. The pk_vid value must be at least 16 characters long and be a valid hexadecimal string. Only the first 16 characters are used.

Returns

Whether the visitor ID was successfully set, instead of a string that describes the method and its parameters.

Type: boolean. true: the visitor ID was set. false: the visitor ID was not set (invalid format, missing parameter, or empty input).

Examples

To set the visitor ID from a deep link URL:

final bool ok = await FlutterPiwikPro.sharedInstance
    .setVisitorIdFromDeepLink('https://example.com?pk_vid=0123456789abcdef');

Related methods

• setVisitorId()
• setVisitorIDLifetime()