List Quotas
Retrieve a list of all segmented quotas for a specified survey.
Note: The Quotas object is designed for use with Segmented Quotas only. To manage an Overall Quota, use the Survey Object with the options[overall_quota] parameter.
Endpoint
GET
/v5/survey/{survey_id}/quotas
Authentication is required for all requests. See Authentication.
Path Parameters
survey_id
integer
required
The ID of the survey whose quotas you want to retrieve.
Query Parameters
None
Response
result_ok
boolean
Returns
true if the request was successful.quotas
array
Array of quota objects for the survey. Note: This endpoint returns results under the key
quotas, not the standard data key used by most other Alchemer API endpoints.child attributes
id
string
Unique identifier for this quota.
name
string
The name of the quota.
description
string
A description of the quota.
limit
string
The maximum number of responses allowed before the quota closes.
responses
string
The current number of responses counted toward this quota.
distributed
string
Whether this is a distributed (percentage-based) quota. Returns
"true" or "false".groups
array
Logic rule groups defining which respondents count toward this quota. See Create Quota for full details on the groups structure.
Examples
Request
curl -X GET "https://api.alchemer.com/v5/survey/123456/quotas?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"quotas": [
{
"id": "1",
"name": "East Coast Respondents",
"description": "Limit responses from East Coast states",
"limit": "100",
"responses": "42",
"distributed": "false",
"groups": [
{
"id": "64a1bc2e3f001",
"rules": [
{
"id": "64a1bc2e3f002",
"input_value": "9_region",
"operator": "4",
"answers_type": "2",
"answers_values": "NY"
}
]
}
]
}
]
}