Quotas

{
  "quotas": [
    {
      "id": 6386,
      "kind": "questionnaire_quotas",
      "row_iteration_id": 158469,
      "column_iteration_id": 158467,
      "created_at": "2025-04-01T09:48:52.796+02:00",
      "updated_at": "2025-04-01T09:48:52.796+02:00",
      "type": "CrossedQuota"
    },
    {
      "id": 7130,
      "kind": "follow_up",
      "row_iteration_id": 158473,
      "column_iteration_id": 158469,
      "created_at": "2025-06-23T11:07:11.125+02:00",
      "updated_at": "2025-06-23T11:07:11.125+02:00",
      "type": "CrossedQuota"
    }
  ]
}

List the quotas of a survey

Retrieves all the quotas of a survey. Quotas are returned in descending order of creation (most recent first).

GET /api/v1/surveys/{SURVEY_ID}/quotas

Parameters

integer

required

The identifier of the survey.

`kind` field

Value	Description
`questionnaire_quotas`	Quota with a leeway.
`target_quotas`	Quota without leeway.
`follow_up`	Quota without an objective.

`type` field

Value	Description
`FlatQuota`	Quota on a single question.
`CrossedQuota`	Quota crossed on two questions.

{
  "quotas": [
    {
      "id": 6386,
      "kind": "questionnaire_quotas",
      "row_iteration_id": 158469,
      "column_iteration_id": 158467,
      "created_at": "2025-04-01T09:48:52.796+02:00",
      "updated_at": "2025-04-01T09:48:52.796+02:00",
      "type": "CrossedQuota"
    },
    {
      "id": 7130,
      "kind": "follow_up",
      "row_iteration_id": 158473,
      "column_iteration_id": 158469,
      "created_at": "2025-06-23T11:07:11.125+02:00",
      "updated_at": "2025-06-23T11:07:11.125+02:00",
      "type": "CrossedQuota"
    }
  ]
}

View the details of a quota

Retrieves the details and progress of a quota.

GET /api/v1/quotas/{QUOTA_ID}

Parameters

integer

required

The identifier of the quota.

Response fields

integer

ID of the quota.

string

Kind of quota: questionnaire_quotas, target_quotas or follow_up (see above).

string

FlatQuota (a single question) or CrossedQuota (crossed on two questions).

float

Leeway allowed on the quota objective (e.g. 0.05).

string

Readable label of the quota with its identifier (e.g. RS2 - age5).

object

Progress of the quota.

Show progress breakdown

Nested object crossing the items. Each cell contains: objective (the target objective), completes (the number of complete interviews collected) and progress (the progress rate).

{
  "id": 7132,
  "kind": "questionnaire_quotas",
  "row_iteration_id": 158467,
  "column_iteration_id": null,
  "created_at": "2025-06-23T11:19:51.357+02:00",
  "updated_at": "2025-06-23T11:19:51.357+02:00",
  "type": "FlatQuota",
  "leeway": 0.05,
  "pretty_label_with_identifier": "RS2 - age5",
  "progress": {
    "total": {
      "total": {
        "objective": 850,
        "completes": 800,
        "progress": 1
      }
    },
    "0-17": {
      "total": {
        "objective": 170,
        "completes": 0,
        "progress": 0
      }
    }
  }
}

Last modified on August 24, 2026

{
  "quotas": [
    {
      "id": 6386,
      "kind": "questionnaire_quotas",
      "row_iteration_id": 158469,
      "column_iteration_id": 158467,
      "created_at": "2025-04-01T09:48:52.796+02:00",
      "updated_at": "2025-04-01T09:48:52.796+02:00",
      "type": "CrossedQuota"
    },
    {
      "id": 7130,
      "kind": "follow_up",
      "row_iteration_id": 158473,
      "column_iteration_id": 158469,
      "created_at": "2025-06-23T11:07:11.125+02:00",
      "updated_at": "2025-06-23T11:07:11.125+02:00",
      "type": "CrossedQuota"
    }
  ]
}

General information

Endpoints

List the quotas of a survey

Parameters

`kind` field

`type` field

View the details of a quota

Parameters

Response fields

​List the quotas of a survey

​Parameters

​kind field

​type field

​View the details of a quota

​Parameters

​Response fields

List the quotas of a survey

Parameters

`kind` field

`type` field

View the details of a quota

Parameters

Response fields