Learn how to query app installation data using the monday.com platform API
Whenever a monday.com user installs an app, we send the installation information to the app developer to help them further understand their app's performance and usage. This information is available through webhooks and by querying app_installs.
Queries
You can use the app_installs query to retrieve app installation data via the API.
- Only works for app collaborators using a personal token
- Returns an object containing an app's installation details
- Can only be queried directly at the root; can't be nested within another query
query {
app_installs(
app_id: 123456789
account_id: 98766543210
) {
app_id
timestamp
app_install_account {
id
}
app_install_user {
id
}
app_version {
major
minor
patch
type
text
}
permissions {
approved_scopes
required_scopes
}
}
}import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });
const query = `query ($appId: ID!, $accountId: ID!) { app_installs (app_id: $appId, account_id: $accountId) { app_id timestamp app_install_account { id } app_install_user { id } app_version { major minor patch type text } permissions { approved_scopes required_scopes }}}`;
const variables = {
appId: 123456789,
accountId: 9876543210
}
const response = await mondayApiClient.request(query, variables);Arguments
You can use the following arguments to reduce the number of results returned in your app_installs query.
| Argument | Description |
|---|---|
account_id ID | The account's unique identifier to filter results by. |
app_id ID! | The application's unique identifier to filter results by. |
limit Int | The number of boards to return. The default is 25 and the maximum is 100. |
page Int | The page number to return. Starts at 1. |
Fields
You can use the following fields to specify what information your app_installs query will return. Some fields support their own subfields.
Fields | Description | Supported Subfields |
|---|---|---|
app_id | The app's unique identifier. | |
app_install_account | The app installer's account details. | id |
app_install_user | The app installer's user details. | id |
app_version | The app's version details when it was installed. | major |
permissions | The required and approved scopes for an app installation. | approved_scopes |
timestamp | The date and time the app was installed. |
