POST

Search App Installation

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 app installations that match a free-text search expression.

Search matches against the site URL, business name, business email, site owner email, instance ID, review title, and review description. Pass supported values to fields in the request to include those fields in the response.

Search App Installation runs with these defaults, which you can override:

paging.limit is 50

The results include installations across all the apps in your developer account.

To search a single field only, use Query App Installations with the appropriate filter.

Property	Capabilities	Filters
`siteInfo.businessCategory.secondary`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$hasAll`, `$hasSome`
`createdDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`id`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`updatedDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`appId`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`appVersion`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`firstInstallationDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`instanceId`	Search: ✓ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`planInfo.billingCycle.cycleDuration.count`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`planInfo.billingCycle.cycleDuration.unit`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`planInfo.billingCycle.cycleType`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`planInfo.endDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`planInfo.freeTrialInfo.endDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`planInfo.freeTrialInfo.status`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`planInfo.planName`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`planInfo.planStatus`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`review.id`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`review.date`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`review.rating`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`siteInfo.accountId`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`siteInfo.businessCategory.primary`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`siteInfo.businessEmail`	Search: ✓ Aggregate: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`siteInfo.businessName`	Search: ✓ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`siteInfo.countryCode`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`siteInfo.editorType`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`siteInfo.ownerEmail`	Search: ✓ Aggregate: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`siteInfo.premium`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`siteInfo.siteId`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`siteInfo.siteUrl`	Search: ✓ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`status`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`

Authentication

You can only call this method when authenticated as a Wix user or by using an account level API key.

Permissions

Learn more about app permissions.

Endpoint

POST

https://www.wixapis.com/app/installations/v1/app-installation/search

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?