> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pollandroll.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Fieldwork progress

> View the fieldwork progress indicators of a survey.

## View the fieldwork progress

Returns the fieldwork progress indicators for a survey.

```http theme={null}
GET /api/v1/surveys/{SURVEY_ID}/fieldwork_progress
```

### Parameters

<ParamField path="SURVEY_ID" type="integer" required>
  The identifier of the survey.
</ParamField>

<ParamField query="sample_source_id" type="integer">
  Identifier of a sample source of the current survey, to filter the indicators on that source.
</ParamField>

<ParamField query="started_after" type="string">
  Filters interviews whose start date is on or after this date, in ISO 8601 format. Example: `2025-09-19T10:43:16+02:00`. Optional, can be omitted for a range with no start bound.
</ParamField>

<ParamField query="started_before" type="string">
  Filters interviews whose start date is on or before this date, in ISO 8601 format. Optional, can be omitted for a range with no end bound.
</ParamField>

### Response fields

<ResponseField name="sample_size" type="integer">
  Number of expected complete interviews.
</ResponseField>

<ResponseField name="interviews_count" type="integer">
  Number of complete interviews collected.
</ResponseField>

<ResponseField name="interview_count_by_status" type="object">
  Number of interviews by status.

  <Expandable title="breakdown by status">
    Each status contains a number of individuals (`individuals`) and a percentage (`percentage`): `complete`, `incomplete`, `quota_full`, `screen_out`, `above_target`, `manual_action`, `pending_analysis`, `speeder`, `straightliner`, `failed_quality_check`, `inappropriate_language`.
  </Expandable>
</ResponseField>

<Note>
  Interviews with the **Ignored** status appear nowhere in this response: not in `interview_count_by_status`, not in `interviews_count`, and not in the rates derived from them.
</Note>

<ResponseField name="completion_rate" type="float">
  Number of complete interviews divided by the total sample size.
</ResponseField>

<ResponseField name="questionnaire_incidence_rate" type="float">
  Number of complete interviews divided by the number of complete + screen out + quota-full + incomplete interviews.
</ResponseField>

<ResponseField name="target_incidence_rate" type="float">
  Number of complete interviews divided by the number of complete + screen out interviews.
</ResponseField>

<ResponseField name="incidence_rate" type="float" deprecated>
  Number of complete interviews divided by the number of complete + screen out interviews.

  <Warning>
    This indicator is **deprecated** and will be removed in a future version. It is replaced by `target_incidence_rate`.
  </Warning>
</ResponseField>

<ResponseField name="drop_out_rate" type="float">
  Number of incomplete interviews divided by the total number of interviews.
</ResponseField>

<ResponseField name="length_of_interview" type="integer">
  Median length of a complete interview, in seconds.
</ResponseField>

<ResponseExample>
  ```json Response theme={null}
  {
    "fieldwork_progress": {
      "sample_size": 100,
      "interviews_count": 3,
      "interview_count_by_status": {
        "complete": { "individuals": 3, "percentage": 0.125 },
        "incomplete": { "individuals": 3, "percentage": 0.125 },
        "quota_full": { "individuals": 3, "percentage": 0.125 },
        "screen_out": { "individuals": 3, "percentage": 0.125 },
        "above_target": { "individuals": 0, "percentage": 0.0 },
        "manual_action": { "individuals": 0, "percentage": 0.0 },
        "pending_analysis": { "individuals": 0, "percentage": 0.0 },
        "speeder": { "individuals": 3, "percentage": 0.125 },
        "straightliner": { "individuals": 3, "percentage": 0.125 },
        "failed_quality_check": { "individuals": 3, "percentage": 0.125 },
        "inappropriate_language": { "individuals": 3, "percentage": 0.125 }
      },
      "completion_rate": 0.03,
      "questionnaire_incidence_rate": 0.25,
      "target_incidence_rate": 0.5,
      "incidence_rate": 0.5,
      "drop_out_rate": 0.125,
      "length_of_interview": 300
    }
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.