curl https://api.getversive.com/api/v1/studies/9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b/quotas \
-H "Authorization: Bearer $VERSIVE_API_KEY"
{
"mode": "url_param",
"fixed_limit": null,
"param_name": "group",
"buckets": [
{ "value": "1", "limit": 50 },
{ "value": "2", "limit": 50 }
],
"unmatched_param_policy": "allow"
}
Quotas
Get study quotas
The study-level quota configuration
GET
/
studies
/
{id}
/
quotas
curl https://api.getversive.com/api/v1/studies/9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b/quotas \
-H "Authorization: Bearer $VERSIVE_API_KEY"
{
"mode": "url_param",
"fixed_limit": null,
"param_name": "group",
"buckets": [
{ "value": "1", "limit": 50 },
{ "value": "2", "limit": 50 }
],
"unmatched_param_policy": "allow"
}
Returns the study’s quota configuration. See Quotas for how each mode behaves.
string
required
The study ID.
Response
string
off, fixed (total completes), or url_param (per link parameter).integer | null
Completes allowed in
fixed mode. 0 closes the study to new participants.string | null
The URL parameter in
url_param mode.array
One
{ value, limit } per link value in url_param mode. A limit of 0 closes that value.string
allow or reject: what happens to participants whose link has no matching value.curl https://api.getversive.com/api/v1/studies/9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b/quotas \
-H "Authorization: Bearer $VERSIVE_API_KEY"
{
"mode": "url_param",
"fixed_limit": null,
"param_name": "group",
"buckets": [
{ "value": "1", "limit": 50 },
{ "value": "2", "limit": 50 }
],
"unmatched_param_policy": "allow"
}