Get the Organization Limit Status

Retrieving the current limit status of a Coveo organization can be useful to find out whether performing a certain operation is possible.

Before attempting to create a new source in an organization, you want to verify that for the numberOfSourcesLimit, the actualCount value is smaller than the limit value.

Use the Get organization limits and their status operation to get the current limit status of a specific Coveo organization.

You can also perform this action from the Coveo Administration Console (see Review Organization Settings and Limits).

Request template

GET https://platform.cloud.coveo.com/rest/organizations/<MyOrganizationId>/limits HTTP/1.1
 
Accept: application/json
Authorization: Bearer <MyAccessToken>

In the request path:

In the Authorization HTTP header:

The body of a successful response contains the current limits status of the target Coveo organization.

Sample Request

Getting all limit status of a Coveo organization

GET https://platform.cloud.coveo.com/rest/organizations/mycoveocloudv2organizationg8tp8wu3/limits HTTP/1.1
 
Accept: application/json
Authorization: Bearer **********-****-****-****-************

Successful response - 200 OK

{
  "content": {
    "numberOfMappingPerSourcesLimit": {
      "limit": 2500
    },
    "licenseExtensionsLimit": {
      "actualCount": 4,
      "limit": 10
    },
    "numberOfExtensionsPerSourceLimit": {
      "limit": 20
    },
    "numberOfSecurityProvidersLimit": {
      "actualCount": 8,
      "limit": 15
    },
    "numberOfSourcesLimit": {
      "actualCount": 7,
      "limit": 15
    }
  },
  "organization": {
    "numberOfSubscriptionsPerUserLimit": {
      "limit": 5
    },
    "numberOfSubscriptionsPerOrganizationLimit": {
      "limit": 100
    },
    "numberOfDailyEmailNotificationsSentPerOrganizationLimit": {
      "limit": 2000
    }
  },
  "searchapi": {},
  "usageAnalytics": {
    "monthlyEventsLimit": {
      "limit": 300000000
    },
    "customDimensionLimit": {
      "limit": 25
    },
    "exportLimit": {
      "limit": 25
    },
    "namedFilterLimit": {
      "limit": 400
    },
    "reportLimit": {
      "limit": 500
    },
    "dailyEventsLimit": {
      "limit": 10000000
    },
    "permissionFilterLimit": {
      "limit": 100
    },
    "queriesPerHourLimit": {
      "limit": 3000
    },
    "exportScheduleLimit": {
      "limit": 25
    }
  }
}
Recommended Articles