The App Installations API lets you list, filter, and search installations of your own apps across the Wix sites where they're installed.
An app installation represents a single installation of one of your apps on a Wix site. It includes details about the site, the installed app version, the purchased plan, the installation status, and any review the site owner left for the app.
With the App Installations API, you can:
- Query app installations of your apps by status, plan, billing cycle, installation date, country, editor type, and more.
- Search app installations using free-text matching across site URL, business name, business email, owner email, instance ID, and review text.
- Subscribe to events to track installs, updates, and uninstalls in real time.
It's important to note the following before starting to code:
- Uninstalling and reinstalling the same app on a site doesn't create a new app installation. The existing app installation's
status flips between INSTALLED and UNINSTALLED, and instanceId stays the same.
- App installation: A record describing one installation of one of your apps on a Wix site, including site details, plan information, installation status, and review data. An app can be installed on a site only once. The same app installation persists across uninstalls and reinstalls. The
instanceId stays the same and only status changes.
- Instance: A specific install of an app on a site, identified by
instanceId. The instanceId is stable across uninstalls and reinstalls of the same app on the same site.
- Status: Whether the app is currently
INSTALLED or UNINSTALLED on the site.
- Plan: The Premium plan, if any, that the site owner purchased for the installed app.