1. v3
  2. Surveys
  3. GET - 3/surveys/{surveyid}/responserate

Definition

GET - 3/surveys/{surveyId}/responserate?filter={filter}&groupby={groupby}

Gets the response rate for a survey.

You can only retrieve the response rate if the survey has a panel, otherwise you will get an empty result.

Request information

surveyId

The id of a survey.


Type integer
Additional info
Required
filter

Select only the panelists that satisfy the expression in the response rate calculation. read more


Type string
Additional info
Optional
groupby

Define the panelist property on which we should group the response rate. This option allows you to compare the response rate between different types of panelists.


Type string
Additional info
Optional

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Collection of ResponseRate
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-21T18:22:36.5872198Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "PanelistStatusId": 1,
      "PanelistCount": 2,
      "Group": "sample string 3"
    },
    {
      "PanelistStatusId": 1,
      "PanelistCount": 2,
      "Group": "sample string 3"
    }
  ]
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <ResponseRate z:Id="i2">
      <Group>sample string 3</Group>
      <PanelistCount>2</PanelistCount>
      <PanelistStatusId>1</PanelistStatusId>
    </ResponseRate>
    <ResponseRate z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-12-21T18:22:36.5872198+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>