GET /external/api/v3/averagescore

Get the average score of questions.

Request Information

URI Parameters

Name	Description	Type	Additional information	Nullable
Period	Get average score for each period in the selection. Available options are Day, Week, Month, Quarter, Year or Total.	string	Required	False
GroupByCustomerDataColumnId	Groups all the scores not just on the period, but also on an customer data value.	integer	None	True
QuestionIds	Filter on QuestionIds.	Collection of integer	Required	False
DateFilter		DateFilter	None	False
DecimalsRound	Rounds score to the specified number of digits.	integer	None	False
CustomerDataFilters	Filter on customer data.	Collection of CustomerDataFilter	None	False
ReviewApprovedDateFilter	Filters on review approved date.	DateFilter	None	False
ReviewStatus	Filters on review status.	ReviewSiteReviewStatus	None	True

Body Parameters

None.

Response Information

Resource Description

GetAverageScoreResponse

Name	Description	Type	Additional information	Nullable
AverageScores		Collection of AverageScore	None	False

Response Formats

application/json, text/json

Sample:

{
  "AverageScores": [
    {
      "Score": 1.0,
      "CustomerDataValue": "sample string 2",
      "ScalePositionPercentage": [
        {
          "Value": 1,
          "Label": "sample string 2",
          "Percentage": 3.0,
          "Volume": 4
        },
        {
          "Value": 1,
          "Label": "sample string 2",
          "Percentage": 3.0,
          "Volume": 4
        }
      ],
      "ScaleGroupPercentage": [
        {
          "Group": "sample string 1",
          "Percentage": 2.0,
          "Volume": 3
        },
        {
          "Group": "sample string 1",
          "Percentage": 2.0,
          "Volume": 3
        }
      ],
      "QuestionId": 3,
      "Amount": 4,
      "Year": 1,
      "Quarter": "sample string 5",
      "Month": 1,
      "Week": 1,
      "Day": 1
    },
    {
      "Score": 1.0,
      "CustomerDataValue": "sample string 2",
      "ScalePositionPercentage": [
        {
          "Value": 1,
          "Label": "sample string 2",
          "Percentage": 3.0,
          "Volume": 4
        },
        {
          "Value": 1,
          "Label": "sample string 2",
          "Percentage": 3.0,
          "Volume": 4
        }
      ],
      "ScaleGroupPercentage": [
        {
          "Group": "sample string 1",
          "Percentage": 2.0,
          "Volume": 3
        },
        {
          "Group": "sample string 1",
          "Percentage": 2.0,
          "Volume": 3
        }
      ],
      "QuestionId": 3,
      "Amount": 4,
      "Year": 1,
      "Quarter": "sample string 5",
      "Month": 1,
      "Week": 1,
      "Day": 1
    }
  ]
}

application/xml, text/xml

Sample:

<GetAverageScoreResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Responses">
  <AverageScores xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Models">
    <d2p1:AverageScore>
      <Amount xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">4</Amount>
      <Day xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">1</Day>
      <Month xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">1</Month>
      <Quarter xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 5</Quarter>
      <QuestionId xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">3</QuestionId>
      <Week xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">1</Week>
      <Year xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">1</Year>
      <d2p1:CustomerDataValue>sample string 2</d2p1:CustomerDataValue>
      <d2p1:ScaleGroupPercentage>
        <d2p1:ScaleGroupPercentage>
          <d2p1:Percentage>2</d2p1:Percentage>
          <d2p1:Volume>3</d2p1:Volume>
          <d2p1:Group>sample string 1</d2p1:Group>
        </d2p1:ScaleGroupPercentage>
        <d2p1:ScaleGroupPercentage>
          <d2p1:Percentage>2</d2p1:Percentage>
          <d2p1:Volume>3</d2p1:Volume>
          <d2p1:Group>sample string 1</d2p1:Group>
        </d2p1:ScaleGroupPercentage>
      </d2p1:ScaleGroupPercentage>
      <d2p1:ScalePositionPercentage>
        <d2p1:ScalePositionPercentage>
          <d2p1:Percentage>3</d2p1:Percentage>
          <d2p1:Volume>4</d2p1:Volume>
          <d2p1:Label>sample string 2</d2p1:Label>
          <d2p1:Value>1</d2p1:Value>
        </d2p1:ScalePositionPercentage>
        <d2p1:ScalePositionPercentage>
          <d2p1:Percentage>3</d2p1:Percentage>
          <d2p1:Volume>4</d2p1:Volume>
          <d2p1:Label>sample string 2</d2p1:Label>
          <d2p1:Value>1</d2p1:Value>
        </d2p1:ScalePositionPercentage>
      </d2p1:ScalePositionPercentage>
      <d2p1:Score>1</d2p1:Score>
    </d2p1:AverageScore>
    <d2p1:AverageScore>
      <Amount xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">4</Amount>
      <Day xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">1</Day>
      <Month xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">1</Month>
      <Quarter xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 5</Quarter>
      <QuestionId xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">3</QuestionId>
      <Week xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">1</Week>
      <Year xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">1</Year>
      <d2p1:CustomerDataValue>sample string 2</d2p1:CustomerDataValue>
      <d2p1:ScaleGroupPercentage>
        <d2p1:ScaleGroupPercentage>
          <d2p1:Percentage>2</d2p1:Percentage>
          <d2p1:Volume>3</d2p1:Volume>
          <d2p1:Group>sample string 1</d2p1:Group>
        </d2p1:ScaleGroupPercentage>
        <d2p1:ScaleGroupPercentage>
          <d2p1:Percentage>2</d2p1:Percentage>
          <d2p1:Volume>3</d2p1:Volume>
          <d2p1:Group>sample string 1</d2p1:Group>
        </d2p1:ScaleGroupPercentage>
      </d2p1:ScaleGroupPercentage>
      <d2p1:ScalePositionPercentage>
        <d2p1:ScalePositionPercentage>
          <d2p1:Percentage>3</d2p1:Percentage>
          <d2p1:Volume>4</d2p1:Volume>
          <d2p1:Label>sample string 2</d2p1:Label>
          <d2p1:Value>1</d2p1:Value>
        </d2p1:ScalePositionPercentage>
        <d2p1:ScalePositionPercentage>
          <d2p1:Percentage>3</d2p1:Percentage>
          <d2p1:Volume>4</d2p1:Volume>
          <d2p1:Label>sample string 2</d2p1:Label>
          <d2p1:Value>1</d2p1:Value>
        </d2p1:ScalePositionPercentage>
      </d2p1:ScalePositionPercentage>
      <d2p1:Score>1</d2p1:Score>
    </d2p1:AverageScore>
  </AverageScores>
</GetAverageScoreResponse>

Response Status Codes

Status Code	Name	Description
200	OK	The request has succeeded.
400	Bad Request	Fulfilling the request would cause an invalid state. Request needs modification.
401	Unauthorized	Missing or invalid authentication token.
403	Forbidden	Server refuses to authorize the request.
408	Request Timeout	The server timed out waiting for the request.
429	Too Many Requests	Too many requests in a given amount of time.
500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.
503	Service Unavailable	The server is unable to proces the request at the moment, try again later.