POST

Query App Installations

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, with the specified paging, filtering, and sorting.

Query App Installations runs with these defaults, which you can override:

createdDate is sorted in DESC order
paging.limit is 50

The results include installations across all the apps in your developer account. Pass supported values to fields in the request to include those fields in the response.

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection. For a free-text search across a number of fields, use Search App Installation.

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

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-installations/query

Errors

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

Did this help?