Skip to main content

Overview

Version 1.0.0

The Overwolf Developers Console API provides endpoints for the retrieval of app performance data. Use these API end points to programmatically pull performance statistics, bypassing the need for manual console access. These APIs expose crucial metrics like Daily Active Users (DAU), user retention data, and session length analytics. These endpoints allow you to pull data directly into external business intelligence (BI) dashboards or monitoring tools.

Accessing the endpoints​

To access the API endpoints you need to generate an API key. To generate your key:

  1. Open the Overwolf Developers console.

  2. In the Settings menu, select Profile.

  3. Press the Revoke and get new API key. Press Confirm. A new key is issued.

  4. Copy the key and save it. You will not be able to retrieve it. Should you lose the key, you will need to repeat these steps and issue a new key.

  5. Use the key:value pair of x-api-token: as part of the authentication when accessing the Developers Console endpoints.

Using the Postman collection​

Overwolf provides the endpoints for you to use in a number of different ways. Overwolf recommends using The Postman App to build and test your request before you add it to your integration.

Run these APIs in Postman

Download the collection JSON

After you have downloaded the collection, open Postman, navigate to the workspace of your choice, and then press the Import button. Then you will need to make sure that you add/change the following variables:

  1. base_url—ensure the path to the console API is https://console.overwolf.com/api/stats.

  2. x-api-token—enter your generated API token .

  3. app_id—the ID of the app you want to query.