1. v3
  2. TextAnalysis
  3. GET - 3/textanalysis/{surveyid}/questions/{questionid}/aggregates

Definition

GET - 3/textanalysis/{surveyId}/questions/{questionId}/aggregates?lang={lang}

Retrieve the tagging aggregates

Required roles: Results (read)
Response cached for 60 seconds.

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 in which you would like to retrieve the tags. If the requested language is not available we will use the default language from the survey. The available language code can be found for each survey in the Survey - Langs property.


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 TagAggregate
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-11-21T11:43:44.6942978Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "Negative": 1,
      "Neutral": 2,
      "Positive": 3,
      "SurveyId": 4,
      "QuestionId": 5,
      "TagId": 6,
      "Name": "sample string 7",
      "Description": "sample string 8",
      "RespondentCount": 9,
      "RespondentRate": 10.0
    },
    {
      "Negative": 1,
      "Neutral": 2,
      "Positive": 3,
      "SurveyId": 4,
      "QuestionId": 5,
      "TagId": 6,
      "Name": "sample string 7",
      "Description": "sample string 8",
      "RespondentCount": 9,
      "RespondentRate": 10.0
    }
  ]
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <TagAggregate>
      <Description>sample string 8</Description>
      <Name>sample string 7</Name>
      <QuestionId>5</QuestionId>
      <RespondentCount>9</RespondentCount>
      <RespondentRate>10</RespondentRate>
      <SurveyId>4</SurveyId>
      <TagId>6</TagId>
      <Negative>1</Negative>
      <Neutral>2</Neutral>
      <Positive>3</Positive>
    </TagAggregate>
    <TagAggregate>
      <Description>sample string 8</Description>
      <Name>sample string 7</Name>
      <QuestionId>5</QuestionId>
      <RespondentCount>9</RespondentCount>
      <RespondentRate>10</RespondentRate>
      <SurveyId>4</SurveyId>
      <TagId>6</TagId>
      <Negative>1</Negative>
      <Neutral>2</Neutral>
      <Positive>3</Positive>
    </TagAggregate>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-11-21T11:43:44.6942978+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>