Getting started
Screener Response Handling
Messaging
Lookup and Reference Data
Webhooks
Team Tools
Audience Quotas
Create quota
Creates quota for a specific project.
POST
/
v1
/
projects
/
{projectId}
/
quota
Create quota
Copy
Ask AI
curl --request POST \
--url https://api-staging.respondent.io/v1/projects/{projectId}/quota \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-secret: <x-api-secret>' \
--data '
{
"version": "v1",
"criteria": {
"category": "gender",
"segments": [
{
"value": "male",
"percentage": 50
}
]
}
}
'Copy
Ask AI
{
"progress": {
"1": {
"currentCount": 10,
"targetCount": 25
},
"2": {
"currentCount": 15,
"targetCount": 30
}
},
"id": "<string>",
"projectId": "<string>",
"version": "v1",
"totalTarget": 2,
"status": "IN_PROGRESS",
"criteria": {
"category": "gender",
"segments": [
{
"value": "male",
"percentage": 50,
"id": "1"
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Path Parameters
Body
application/json
Available options:
v1 Quota criteria details
Show child attributes
Show child attributes
The category this quota applies to
Available options:
age, gender, ethnicity, location Example:
"gender"
Array of quota segments. Must contain at least one segment.
Show child attributes
Show child attributes
The value for this segment (e.g., "Male" for gender, "18-24" for age, "USA" for location). Type depends on category.
Available options:
male, female, other, nonbinary, transmale, transfemale, prefernottoanswer, 18-20, 21-29, 30-39, 40-54, 55+, americanindianalaskannative, hispaniclatino, blackorafricanamerican, asianpacificislander, whitecaucasian, middleeastern, multipleethnicity, prefernotdisclose, AX, AL, DZ, AS, AD, AI, AQ, AG, AR, AM, AW, AU, AT, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, CV, CM, CA, KY, CF, TD, CL, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, CD, DK, DJ, DM, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, LA, LV, LB, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, NA, NR, NP, NL, NC, NZ, NI, NE, NU, NF, KP, MK, MP, NO, OM, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RW, RE, SH, KN, LC, PM, VC, WS, SM, ST, SA, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, KR, ES, LK, SR, SJ, SE, CH, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, AE, GB, UM, US, UY, VU, VE, VN, WF, EH, ZM, ZW, all Example:
"male"
The target percentage for this segment (0-100)
Required range:
0 <= x <= 100Example:
50
Response
201 - application/json
Quota progress by segment ID
Example:
{
"1": { "currentCount": 10, "targetCount": 25 },
"2": { "currentCount": 15, "targetCount": 30 }
}Available options:
v1 Required range:
x >= 1Available options:
IN_PROGRESS, FILLED Show child attributes
Show child attributes
The category this quota applies to
Available options:
age, gender, ethnicity, location Example:
"gender"
Array of quota segments
Show child attributes
Show child attributes
The value for this segment (e.g., "Male" for gender, "18-24" for age, "USA" for location). Type depends on category.
Available options:
male, female, other, nonbinary, transmale, transfemale, prefernottoanswer, 18-20, 21-29, 30-39, 40-54, 55+, americanindianalaskannative, hispaniclatino, blackorafricanamerican, asianpacificislander, whitecaucasian, middleeastern, multipleethnicity, prefernotdisclose, AX, AL, DZ, AS, AD, AI, AQ, AG, AR, AM, AW, AU, AT, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, CV, CM, CA, KY, CF, TD, CL, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, CD, DK, DJ, DM, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, LA, LV, LB, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, NA, NR, NP, NL, NC, NZ, NI, NE, NU, NF, KP, MK, MP, NO, OM, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RW, RE, SH, KN, LC, PM, VC, WS, SM, ST, SA, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, KR, ES, LK, SR, SJ, SE, CH, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, AE, GB, UM, US, UY, VU, VE, VN, WF, EH, ZM, ZW, all Example:
"male"
The target percentage for this segment (0-100)
Required range:
0 <= x <= 100Example:
50
Unique identifier for the segment
Example:
"1"
Was this page helpful?
⌘I
Create quota
Copy
Ask AI
curl --request POST \
--url https://api-staging.respondent.io/v1/projects/{projectId}/quota \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-secret: <x-api-secret>' \
--data '
{
"version": "v1",
"criteria": {
"category": "gender",
"segments": [
{
"value": "male",
"percentage": 50
}
]
}
}
'Copy
Ask AI
{
"progress": {
"1": {
"currentCount": 10,
"targetCount": 25
},
"2": {
"currentCount": 15,
"targetCount": 30
}
},
"id": "<string>",
"projectId": "<string>",
"version": "v1",
"totalTarget": 2,
"status": "IN_PROGRESS",
"criteria": {
"category": "gender",
"segments": [
{
"value": "male",
"percentage": 50,
"id": "1"
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}