Skip to main content

Retrieve installs count

GET 

https://api.freemius.com/v1/products/{product_id}/installs/count.json

Auth:Bearer TokenSCOPE: PRODUCT

Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need.

  1. Go to the Freemius Developer Dashboard.
  2. Open the Settings page of the relevant product.
  3. Click the API & Keys tab.
  4. Copy the API Bearer Authorization Token from the UI.

Retrieve the number of installs associated with the product.

Filtering

You can filter the count by plan_id or is_active.

Request

Path Parameters

    product_id integer<int64>required

    The ID of the product.

    Possible values: >= 1

    Example: 1234

Query Parameters

    plan_id number

    (optional) Return the count of installs that are associated with a non-expired license for the given plan ID.

    Example: 1
    is_active boolean

    (optional) Return active installs only.

    Example: false

Responses

The number of installs with the product.

Schema
countinteger

Possible values: >= 0

Example: 123
We use essential cookies to enable our site to function. With your consent, we also use analytics and advertising cookies to understand how visitors interact with our site and to improve our services.
Learn More