App Installations: Sample Use Cases and Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Search app installations

You want to find the app installation for a specific Wix site without knowing which of your apps is installed there or which field uniquely identifies it.

To find an app installation by free-text search:

1. Call Search App Installation with search.search.expression set to the value you want to match. The search runs against site URL, business name, business email, site owner email, instance ID, and review title and description.
2. Read appInstallations in the response. If there are more results than fit on a single page, use the cursor in pagingMetadata.cursors.next to retrieve the next page by calling Search App Installation again with the cursor in the request.

Query app installations

You want to list installations of one of your apps that match specific criteria. For example, all active installations in a country, all installations of a specific app version, or all installations whose plan ended in the last week.

To retrieve a filtered list of app installations:

1. Call Query App Installations with a query.filter describing the criteria. For example, to retrieve installations of a specific app that are currently installed in the US:

   Copy

2. Read appInstallations in the response. If there are more results than fit on a single page, use the cursor in pagingMetadata.cursors.next to retrieve the next page by calling Query App Installations again with the cursor in the request.