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 both webhooks and the API.

Queries

Querying app_installs will return an app's installation details. This method accepts various arguments and returns an object.

You can only query app_installs directly at the root, so it can't be nested within another query.

Only app collaborators using a personal token can query this object. The call will fail if anyone other than an app collaborator tries to run the 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
    }
  }
}
let query = "query { app_installs (app_id: 123456789, account_id: 9876543210) { app_id timestamp app_install_account { id } app_install_user { id } app_version { major minor patch type text } permissions { approved_scopes required_scopes }}}";

fetch ("https://api.monday.com/v2", {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE',
    'API-version' : '2024-01'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to reduce the number of results returned in your app_installs query.

ArgumentDescription
account_id IDThe account's unique identifier to filter results by.
app_id ID!The application's unique identifier to filter results by.
limit IntThe number of boards to return. The default is 25 and the maximum is 100.
page IntThe page number to return. Starts at 1.

Fields

You can use the following field(s) to specify what information your app_installs query will return. Please note that some fields will have their own fields.

FieldsDescriptionSupported fields
app_id Int!The app's unique identifier.
app_install_account AppInstallAccount!The app installer's account details.id Int!
app_install_user AppInstallUser!The app installer's user details. id Int
app_version AppVersionThe app's version details when it was installed.major Int!
minor Int!
patch Int!
text String!
type String
permissions AppInstallPermissionsThe required and approved scopes for an app installation. approved_scopes [String!]!
required_scopes [String!]!
timestamp StringThe date and time the app was installed.

📘

Join our developer community!

We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! 😎