App installs

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

Get app installs

  • 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

ArgumentTypeDescription
account_idIDThe account's unique identifier to filter results by.
app_idID!The application's unique identifier to filter results by.
limitIntThe number of boards to return. The default is 25, and the maximum is 100.
pageIntThe page number to return. Starts at 1.

Fields

FieldsTypeDescription
app_idInt!The app's unique identifier.
app_install_accountAppInstallAccount!The app installer's account details.
app_install_userAppInstallUser!The app installer's user details.
app_versionAppVersionThe app's version details when it was installed.
permissionsAppInstallPermissionsThe required and approved scopes for an app installation.
timestampStringThe date and time the app was installed.