Skip to main content
GET
/
v1
/
projects
/
{projectId}
/
quota
Retrieve quota
curl --request GET \
  --url https://api-staging.respondent.io/v1/projects/{projectId}/quota \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'
{
  "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"
}

Headers

​
x-api-key
string
required
​
x-api-secret
string
required

Path Parameters

​
projectId
string
required

Response

200 - application/json
​
progress
object
required

Quota progress by segment ID

Example:
{
  "1": { "currentCount": 10, "targetCount": 25 },
  "2": { "currentCount": 15, "targetCount": 30 }
}
​
id
string<ObjectId>
​
projectId
string<ObjectId>
​
version
enum<string>
Available options:
v1
​
totalTarget
number
Required range: x >= 1
​
status
enum<string>
Available options:
IN_PROGRESS,
FILLED
​
criteria
object
​
createdAt
string<date-time>
​
updatedAt
string<date-time>