Overwolf

Overwolf

  • Getting Started
  • Docs
  • API
  • Events Status
  • Blog
  • Q&A
  • Support

›Best Practices

Best Practices

  • Overview
  • App specific experience
  • First time user experience
  • App launch performance
  • Marketing Communications
  • User journey and error handling
  • Per-game settings
  • Hotkey best practices
  • Second monitor usage
  • Data persistence
  • Reduce OPK size
  • Use Tab as an app Hotkey
  • Type definition file
  • Download Link with referral ID
  • Video capture best practices
  • Enable Developer Tools

Using Windows API

  • Using Overwolf windows
  • Windows Communication
  • Windows Types
  • Resolution Size and Position
  • General Tips

Using Plugins

  • Plugins overview
  • Plug-in Implementation
  • Write your own plugin
  • Sample plugin
  • Simple I/O plugin
  • TeamSpeak plugin
  • Downloader plugin
  • Process Manager plugin

Using Events

  • JavaScript events overview
  • Using game events in your app
  • Game events Simulator
  • Verifying event status

Developers Console

  • Submit a new version
  • Submit for review
  • Update store listing
  • Manage your subscriptions
  • Users and permissions
  • Crash reports
  • Rating and reviews

Integrations

  • Integrating app analytics
  • Login with Twitch
  • Login with Overwolf
  • Event SDK for Game Devs
  • Twitch Extensions

Request a Service

  • Marketing asset requirements
  • Looking for Group
  • Promoting your app

Community Help

  • Join the Community
  • Webinars
  • Developers Content
  • Code snippets

Legal

  • Legal overview
  • App terms
  • Developers terms
Edit

Creating an App Download Link with referral ID

The Overwolf API allows you to include some info in the OW app store’s download link. You can use this feature for different purposes, however, the most common one is to add a unique referral ID to track your download link. This ID allows you to track installations and know exactly which users came from which channel.

You can also allow your users to create shareable download links for their friends, and track how many friends each user has recruited for reward purposes.

Getting a Download Link

The download link format for all apps bundled with the Overwolf client installation looks like this:

https://download.overwolf.com/install/Download?Name=name&ExtensionId=123123123123&Channel=website

You can get your personalized download link by copying the link’s address from the Download button in the store:

alt-text

Add Referral ID to the Download Link

Once you have the base download link, you can concatenate your referral ID in the utm_campaign parameter, for example:

https://download.overwolf.com/install/Download?Name=BUFF&ExtensionId=caboggillkkpgkiokbjmgldfkedbfnpkgadakcdl&Channel=website&utm_campaign=[REFERRAL_ID]
important

utm_campaign data will be saved to the OW database only for new OW installations! If the user that uses the download link already has the OW client installed, the link will only update the app if necessary, but not save the data in utm_campaign to the OW Database.

Extract referral data using API

In order to extract the data, you can use the overwolf.profile.getCurrentUser() API.

This function’s callback will return with an installParams object, including the utm_campaign for this client:

alt-text

Once data is extracted, you can identify what the origin (the source) of the current installation is, and do whatever you like with it. For example, send it back to your servers or analysis software.

Last updated on 2020-2-4 by eransharv
← Type definition fileVideo capture best practices →
  • Getting a Download Link
  • Add Referral ID to the Download Link
  • Extract referral data using API
  • Legal
  • Terms overview
  • Developer's terms
  • App terms
  • Overwolf terms
  • Overwolf Privacy policy
  • Support
  • Questions and Answers
  • Discord
  • Slack
  • Facebook
  • Twitter
  • Documentation
  • Changelog
  • API
  • App Creation Process
  • Best Practices
  • Game Events status
  • Information
  • Careers
  • Fund
  • Developers Blog
  • Overwolf Appstore
  • Advertise on Overwolf