Definition

GET - 3/textanalysis/{surveyId}/questions/{questionId}?lang={lang}&top={top}&skip={skip}&filter={filter}&filterTagIds={filterTagIds}&filterSentimentScore={filterSentimentScore}&orderby={orderby}

Retrieve the open answers

Required roles: Results (read)
Response cached for 60

Request information

surveyId

The id of a survey.


Type integer
Additional info
Required
questionId

The id of a question.


Type integer
Additional info
Required
lang

The language for which you would like to retrieve the responses.


Type string
Additional info
Required
top

Select only the first N responses of the list. read more


Type string
Additional info
Optional, Default value is 25
skip

Skip the first N responses of the list. read more


Type string
Additional info
Optional
filter

Select only the Respondents that satisfy the predicate expression read more


Type string
Additional info
Optional
filterTagIds

Comma-seperated list of tagIds for which you would like to retrieve the open responses


Type string
Additional info
Optional
filterSentimentScore

Select only the respones with this Sentiment score (-10: negative, 0: neutral, 10: positive)


Type signed byte
Additional info
Optional
orderby

Define the properties which are used to order the list of responses. read more


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 OpenTextResponse
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": "2019-08-25T05:57:06.730042Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "Response": "sample string 1",
      "ResponseStringId": 2,
      "Tags": [
        {
          "TagId": 1,
          "SentimentScore": 1,
          "SalienceScore": 1.1,
          "TaggedByTextMining": true
        },
        {
          "TagId": 1,
          "SentimentScore": 1,
          "SalienceScore": 1.1,
          "TaggedByTextMining": true
        }
      ],
      "RespondentId": 3,
      "LanguageCode": "sample string 4",
      "RespondentStatusId": 5,
      "ResponseDate": "2019-08-25T05:57:06.730042Z",
      "CompletionTime": 6,
      "DistributionMethodId": 7,
      "BrowserId": 64,
      "OsId": 64,
      "IsMobile": true,
      "IpAddress": "sample string 9",
      "RespondentReportUrl": "sample string 10",
      "ReportUrl": "sample string 11",
      "EditUrl": "sample string 12",
      "Responses": [
        {
          "QuestionId": 3,
          "DataLabel": "sample string 4",
          "ResponseId": 5,
          "Value": "sample string 6",
          "Tags": [
            {
              "TagId": 1,
              "SentimentScore": 1,
              "SalienceScore": 1.1,
              "TaggedByTextMining": true
            },
            {
              "TagId": 1,
              "SentimentScore": 1,
              "SalienceScore": 1.1,
              "TaggedByTextMining": true
            }
          ],
          "ScaleValue": 7,
          "Score": 8.0,
          "ResponseCaption": "sample string 9"
        },
        {
          "QuestionId": 3,
          "DataLabel": "sample string 4",
          "ResponseId": 5,
          "Value": "sample string 6",
          "Tags": [
            {
              "TagId": 1,
              "SentimentScore": 1,
              "SalienceScore": 1.1,
              "TaggedByTextMining": true
            },
            {
              "TagId": 1,
              "SentimentScore": 1,
              "SalienceScore": 1.1,
              "TaggedByTextMining": true
            }
          ],
          "ScaleValue": 7,
          "Score": 8.0,
          "ResponseCaption": "sample string 9"
        }
      ],
      "Location": {
        "Latitude": 2.0,
        "Longitude": 3.0,
        "CountryId": "sample string 4",
        "City": "sample string 5"
      },
      "Score": 13.1,
      "RespondentHash": "sample string 14",
      "PanelistStatusId": 16,
      "DateAdded": "2019-08-25T05:57:06.730042Z",
      "DateInvited": "2019-08-25T05:57:06.730042Z",
      "DateSawMail": "2019-08-25T05:57:06.730042Z",
      "DateClickedThrough": "2019-08-25T05:57:06.730042Z",
      "DateReminded": "2019-08-25T05:57:06.730042Z",
      "DateRemindedPartial": "2019-08-25T05:57:06.730042Z",
      "DateResponded": "2019-08-25T05:57:06.730042Z",
      "Password": "sample string 17",
      "DateSentThankYouMail": "2019-08-25T05:57:06.730042Z",
      "DateToBeInvited": "2019-08-25T05:57:06.730042Z",
      "DateSecondReminder": "2019-08-25T05:57:06.730042Z",
      "DateToExpire": "2019-08-25T05:57:06.730042Z",
      "DateLastModified": "2019-08-25T05:57:06.730042Z",
      "Surveys": [
        {
          "SurveyId": 2,
          "Title": "sample string 3",
          "PanelistStatusId": 4,
          "DateAdded": "2019-08-25T05:57:06.730042Z",
          "PanelistReportUrl": "sample string 5"
        },
        {
          "SurveyId": 2,
          "Title": "sample string 3",
          "PanelistStatusId": 4,
          "DateAdded": "2019-08-25T05:57:06.730042Z",
          "PanelistReportUrl": "sample string 5"
        }
      ],
      "Groups": [
        {
          "GroupId": 2,
          "Name": "sample string 3"
        },
        {
          "GroupId": 2,
          "Name": "sample string 3"
        }
      ],
      "LangCode": "en",
      "ContactId": 19,
      "FirstName": "John",
      "LastName": "Doe",
      "Email": "john.doe@mail.com",
      "CustomField1": "sample string 20",
      "CustomField2": "sample string 21",
      "CustomField3": "sample string 22",
      "CustomField4": "sample string 23",
      "CustomField5": "sample string 24",
      "CustomField6": "sample string 25",
      "CustomField7": "sample string 26",
      "CustomField8": "sample string 27",
      "CustomField9": "sample string 28",
      "CustomField10": "sample string 29",
      "CustomField11": "sample string 30",
      "CustomField12": "sample string 31",
      "CustomField13": "sample string 32",
      "CustomField14": "sample string 33",
      "CustomField15": "sample string 34",
      "CustomField16": "sample string 35",
      "CustomField17": "sample string 36",
      "CustomField18": "sample string 37",
      "CustomField19": "sample string 38",
      "CustomField20": "sample string 39",
      "Street": "Main Street",
      "HouseNumber": "123",
      "Suite": "B",
      "PostalCode": "98765-4321",
      "City": "Anytown",
      "State": "CA",
      "Province": "Orange County",
      "Phone": "+1-202-555-0117",
      "CountryId": "US",
      "Gender": "M",
      "DateOfBirth": "2019-08-25T05:57:06.7309616Z",
      "IsBounced": true,
      "IsOptedOut": true
    },
    {
      "Response": "sample string 1",
      "ResponseStringId": 2,
      "Tags": [
        {
          "TagId": 1,
          "SentimentScore": 1,
          "SalienceScore": 1.1,
          "TaggedByTextMining": true
        },
        {
          "TagId": 1,
          "SentimentScore": 1,
          "SalienceScore": 1.1,
          "TaggedByTextMining": true
        }
      ],
      "RespondentId": 3,
      "LanguageCode": "sample string 4",
      "RespondentStatusId": 5,
      "ResponseDate": "2019-08-25T05:57:06.730042Z",
      "CompletionTime": 6,
      "DistributionMethodId": 7,
      "BrowserId": 64,
      "OsId": 64,
      "IsMobile": true,
      "IpAddress": "sample string 9",
      "RespondentReportUrl": "sample string 10",
      "ReportUrl": "sample string 11",
      "EditUrl": "sample string 12",
      "Responses": [
        {
          "QuestionId": 3,
          "DataLabel": "sample string 4",
          "ResponseId": 5,
          "Value": "sample string 6",
          "Tags": [
            {
              "TagId": 1,
              "SentimentScore": 1,
              "SalienceScore": 1.1,
              "TaggedByTextMining": true
            },
            {
              "TagId": 1,
              "SentimentScore": 1,
              "SalienceScore": 1.1,
              "TaggedByTextMining": true
            }
          ],
          "ScaleValue": 7,
          "Score": 8.0,
          "ResponseCaption": "sample string 9"
        },
        {
          "QuestionId": 3,
          "DataLabel": "sample string 4",
          "ResponseId": 5,
          "Value": "sample string 6",
          "Tags": [
            {
              "TagId": 1,
              "SentimentScore": 1,
              "SalienceScore": 1.1,
              "TaggedByTextMining": true
            },
            {
              "TagId": 1,
              "SentimentScore": 1,
              "SalienceScore": 1.1,
              "TaggedByTextMining": true
            }
          ],
          "ScaleValue": 7,
          "Score": 8.0,
          "ResponseCaption": "sample string 9"
        }
      ],
      "Location": {
        "Latitude": 2.0,
        "Longitude": 3.0,
        "CountryId": "sample string 4",
        "City": "sample string 5"
      },
      "Score": 13.1,
      "RespondentHash": "sample string 14",
      "PanelistStatusId": 16,
      "DateAdded": "2019-08-25T05:57:06.730042Z",
      "DateInvited": "2019-08-25T05:57:06.730042Z",
      "DateSawMail": "2019-08-25T05:57:06.730042Z",
      "DateClickedThrough": "2019-08-25T05:57:06.730042Z",
      "DateReminded": "2019-08-25T05:57:06.730042Z",
      "DateRemindedPartial": "2019-08-25T05:57:06.730042Z",
      "DateResponded": "2019-08-25T05:57:06.730042Z",
      "Password": "sample string 17",
      "DateSentThankYouMail": "2019-08-25T05:57:06.730042Z",
      "DateToBeInvited": "2019-08-25T05:57:06.730042Z",
      "DateSecondReminder": "2019-08-25T05:57:06.730042Z",
      "DateToExpire": "2019-08-25T05:57:06.730042Z",
      "DateLastModified": "2019-08-25T05:57:06.730042Z",
      "Surveys": [
        {
          "SurveyId": 2,
          "Title": "sample string 3",
          "PanelistStatusId": 4,
          "DateAdded": "2019-08-25T05:57:06.730042Z",
          "PanelistReportUrl": "sample string 5"
        },
        {
          "SurveyId": 2,
          "Title": "sample string 3",
          "PanelistStatusId": 4,
          "DateAdded": "2019-08-25T05:57:06.730042Z",
          "PanelistReportUrl": "sample string 5"
        }
      ],
      "Groups": [
        {
          "GroupId": 2,
          "Name": "sample string 3"
        },
        {
          "GroupId": 2,
          "Name": "sample string 3"
        }
      ],
      "LangCode": "en",
      "ContactId": 19,
      "FirstName": "John",
      "LastName": "Doe",
      "Email": "john.doe@mail.com",
      "CustomField1": "sample string 20",
      "CustomField2": "sample string 21",
      "CustomField3": "sample string 22",
      "CustomField4": "sample string 23",
      "CustomField5": "sample string 24",
      "CustomField6": "sample string 25",
      "CustomField7": "sample string 26",
      "CustomField8": "sample string 27",
      "CustomField9": "sample string 28",
      "CustomField10": "sample string 29",
      "CustomField11": "sample string 30",
      "CustomField12": "sample string 31",
      "CustomField13": "sample string 32",
      "CustomField14": "sample string 33",
      "CustomField15": "sample string 34",
      "CustomField16": "sample string 35",
      "CustomField17": "sample string 36",
      "CustomField18": "sample string 37",
      "CustomField19": "sample string 38",
      "CustomField20": "sample string 39",
      "Street": "Main Street",
      "HouseNumber": "123",
      "Suite": "B",
      "PostalCode": "98765-4321",
      "City": "Anytown",
      "State": "CA",
      "Province": "Orange County",
      "Phone": "+1-202-555-0117",
      "CountryId": "US",
      "Gender": "M",
      "DateOfBirth": "2019-08-25T05:57:06.7309616Z",
      "IsBounced": true,
      "IsOptedOut": true
    }
  ]
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <OpenTextResponse z:Id="i2">
      <Groups>
        <GroupReference>
          <GroupId>2</GroupId>
          <Name>sample string 3</Name>
        </GroupReference>
        <GroupReference>
          <GroupId>2</GroupId>
          <Name>sample string 3</Name>
        </GroupReference>
      </Groups>
      <LangCode>en</LangCode>
      <Surveys>
        <SurveyReference z:Id="i3">
          <DateAdded>2019-08-25T06:57:06.730042+01:00</DateAdded>
          <PanelistReportUrl>sample string 5</PanelistReportUrl>
          <PanelistStatusId>4</PanelistStatusId>
          <SurveyId>2</SurveyId>
          <Title>sample string 3</Title>
        </SurveyReference>
        <SurveyReference z:Ref="i3" />
      </Surveys>
      <ContactId>19</ContactId>
      <FirstName>John</FirstName>
      <LastName>Doe</LastName>
      <Email>john.doe@mail.com</Email>
      <CustomField1>sample string 20</CustomField1>
      <CustomField2>sample string 21</CustomField2>
      <CustomField3>sample string 22</CustomField3>
      <CustomField4>sample string 23</CustomField4>
      <CustomField5>sample string 24</CustomField5>
      <CustomField6>sample string 25</CustomField6>
      <CustomField7>sample string 26</CustomField7>
      <CustomField8>sample string 27</CustomField8>
      <CustomField9>sample string 28</CustomField9>
      <CustomField10>sample string 29</CustomField10>
      <CustomField11>sample string 30</CustomField11>
      <CustomField12>sample string 31</CustomField12>
      <CustomField13>sample string 32</CustomField13>
      <CustomField14>sample string 33</CustomField14>
      <CustomField15>sample string 34</CustomField15>
      <CustomField16>sample string 35</CustomField16>
      <CustomField17>sample string 36</CustomField17>
      <CustomField18>sample string 37</CustomField18>
      <CustomField19>sample string 38</CustomField19>
      <CustomField20>sample string 39</CustomField20>
      <Street>Main Street</Street>
      <HouseNumber>123</HouseNumber>
      <Suite>B</Suite>
      <PostalCode>98765-4321</PostalCode>
      <City>Anytown</City>
      <State>CA</State>
      <Province>Orange County</Province>
      <Phone>+1-202-555-0117</Phone>
      <CountryId>US</CountryId>
      <Gender>M</Gender>
      <DateOfBirth>2019-08-25T06:57:06.7309616+01:00</DateOfBirth>
      <IsBounced>true</IsBounced>
      <IsOptedOut>true</IsOptedOut>
      <DateAdded>2019-08-25T06:57:06.730042+01:00</DateAdded>
      <DateClickedThrough>2019-08-25T06:57:06.730042+01:00</DateClickedThrough>
      <DateInvited>2019-08-25T06:57:06.730042+01:00</DateInvited>
      <DateLastModified>2019-08-25T06:57:06.730042+01:00</DateLastModified>
      <DateReminded>2019-08-25T06:57:06.730042+01:00</DateReminded>
      <DateRemindedPartial>2019-08-25T06:57:06.730042+01:00</DateRemindedPartial>
      <DateResponded>2019-08-25T06:57:06.730042+01:00</DateResponded>
      <DateSawMail>2019-08-25T06:57:06.730042+01:00</DateSawMail>
      <DateSecondReminder>2019-08-25T06:57:06.730042+01:00</DateSecondReminder>
      <DateSentThankYouMail>2019-08-25T06:57:06.730042+01:00</DateSentThankYouMail>
      <DateToBeInvited>2019-08-25T06:57:06.730042+01:00</DateToBeInvited>
      <DateToExpire>2019-08-25T06:57:06.730042+01:00</DateToExpire>
      <PanelistStatusId>16</PanelistStatusId>
      <Password>sample string 17</Password>
      <BrowserId>64</BrowserId>
      <CompletionTime>6</CompletionTime>
      <DistributionMethodId>7</DistributionMethodId>
      <EditUrl>sample string 12</EditUrl>
      <IpAddress>sample string 9</IpAddress>
      <IsMobile>true</IsMobile>
      <LanguageCode>sample string 4</LanguageCode>
      <Location>
        <City>sample string 5</City>
        <CountryId>sample string 4</CountryId>
        <Latitude>2</Latitude>
        <Longitude>3</Longitude>
      </Location>
      <OsId>64</OsId>
      <ReportUrl>sample string 11</ReportUrl>
      <RespondentHash>sample string 14</RespondentHash>
      <RespondentId>3</RespondentId>
      <RespondentReportUrl>sample string 10</RespondentReportUrl>
      <RespondentStatusId>5</RespondentStatusId>
      <ResponseDate>2019-08-25T06:57:06.730042+01:00</ResponseDate>
      <Responses>
        <Response z:Id="i4">
          <DataLabel>sample string 4</DataLabel>
          <QuestionId>3</QuestionId>
          <ResponseCaption>sample string 9</ResponseCaption>
          <ResponseId>5</ResponseId>
          <ScaleValue>7</ScaleValue>
          <Score>8</Score>
          <Tags>
            <ResponseStringTag>
              <SalienceScore>1.1</SalienceScore>
              <SentimentScore>1</SentimentScore>
              <TagId>1</TagId>
              <TaggedByTextMining>true</TaggedByTextMining>
            </ResponseStringTag>
            <ResponseStringTag>
              <SalienceScore>1.1</SalienceScore>
              <SentimentScore>1</SentimentScore>
              <TagId>1</TagId>
              <TaggedByTextMining>true</TaggedByTextMining>
            </ResponseStringTag>
          </Tags>
          <Value>sample string 6</Value>
        </Response>
        <Response z:Ref="i4" />
      </Responses>
      <Score>13.1</Score>
      <Response>sample string 1</Response>
      <ResponseStringId>2</ResponseStringId>
      <Tags>
        <ResponseStringTag>
          <SalienceScore>1.1</SalienceScore>
          <SentimentScore>1</SentimentScore>
          <TagId>1</TagId>
          <TaggedByTextMining>true</TaggedByTextMining>
        </ResponseStringTag>
        <ResponseStringTag>
          <SalienceScore>1.1</SalienceScore>
          <SentimentScore>1</SentimentScore>
          <TagId>1</TagId>
          <TaggedByTextMining>true</TaggedByTextMining>
        </ResponseStringTag>
      </Tags>
    </OpenTextResponse>
    <OpenTextResponse z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2019-08-25T06:57:06.730042+01:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>