Upsight logo Back to top

Helper Methods

Constructor


Important! This function returns the generated tracking tag as a string.

URL

This method does not wrap any Data Collection API call.

Required Parameters

ParameterTypeDescription
apiKeystringYour application's Upsight Analytics API key.

Optional Parameters

ParameterTypeDescription
[optionalParams]objectAn associative array containing paramName => value.
[optionalParams.useTestServer]boolDetermines if data is sent to the Upsight Analytics Test or Production servers. For QA, use the Test server, and set this value as TRUE. To send data to Production, set this value as FALSE.
[optionalParams.useHttps]boolDetermines if data is sent to the Upsight Analytics servers using HTTPS.
[optionalParams.validateParams]boolDetermines if parameters passed into the tracking methods will be validated by Upsight Analytics servers. If set to TRUE, the tracking methods will call the successCallback function to validate the successful execution of that method, or return a validation error via the [validationErrorCallback] function. If set to FALSE, no validation checking will be present.

Unique Tracking Tag


genUniqueTrackingTag() Function to automatically generate a unique tracking tag. Unique tracking tags are used to correlate advertisement and partner link clicks with any user installs that occur through these channels.

Important! This function returns the generated tracking tag as a string.

URL

This method does not wrap any Data Collection API call.

Required Parameters

No Required Parameters

Optional Parameters

No Optional Parameters

Short Unique Tracking Tag


genShortUniqueTrackingTag() Function to automatically generate a short unique tracking tag. Unique tracking tags are used to correlate advertisement and partner link clicks with any user installs that occur through these channels.

Important! This function returns the generated tracking tag as a string.

URL

This method does not wrap any Data Collection API call.

Required Parameters

No Required parameters.

Optional Parameters

No optional parameters.