GET /external/api/v3/averagescore/approvedreviewaveragescore

Get the average score of questions for approved reviews.

Request Information

URI Parameters

Name	Description	Type	Additional information	Nullable
DateGroup	Available options are transaction date (0) and review approved date (1).	ApprovedReviewAverageScoreDateGroup	Required	False
Period	Get average score for each period in the selection. Available options are Day, Week, Month, Quarter, Year or Total.	string	Required	False
QuestionIds	Filter on QuestionIds.	Collection of integer	Required	False
DateFilter		DateFilter	Required	False
CustomerDataFilters	Filter on customer data.	Collection of CustomerDataFilter	None	False

Body Parameters

None.

Response Information

Resource Description

GetApprovedReviewAverageScoreResponse

Name	Description	Type	Additional information	Nullable
ApprovedReviewAverageScores		Collection of ApprovedReviewAverageScore	None	False

Response Formats

application/json, text/json

Sample:

{
  "ApprovedReviewAverageScores": [
    {
      "QuestionDescription": "sample string 1",
      "Average": 2.1,
      "QuestionId": 3,
      "Amount": 4,
      "Year": 1,
      "Quarter": "sample string 5",
      "Month": 1,
      "Week": 1,
      "Day": 1
    },
    {
      "QuestionDescription": "sample string 1",
      "Average": 2.1,
      "QuestionId": 3,
      "Amount": 4,
      "Year": 1,
      "Quarter": "sample string 5",
      "Month": 1,
      "Week": 1,
      "Day": 1
    }
  ]
}

application/xml, text/xml

Sample:

<GetApprovedReviewAverageScoreResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V2.Responses">
  <ApprovedReviewAverageScores xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
    <d2p1:ApprovedReviewAverageScore>
      <d2p1:Amount>4</d2p1:Amount>
      <d2p1:Day>1</d2p1:Day>
      <d2p1:Month>1</d2p1:Month>
      <d2p1:Quarter>sample string 5</d2p1:Quarter>
      <d2p1:QuestionId>3</d2p1:QuestionId>
      <d2p1:Week>1</d2p1:Week>
      <d2p1:Year>1</d2p1:Year>
      <d2p1:Average>2.1</d2p1:Average>
      <d2p1:QuestionDescription>sample string 1</d2p1:QuestionDescription>
    </d2p1:ApprovedReviewAverageScore>
    <d2p1:ApprovedReviewAverageScore>
      <d2p1:Amount>4</d2p1:Amount>
      <d2p1:Day>1</d2p1:Day>
      <d2p1:Month>1</d2p1:Month>
      <d2p1:Quarter>sample string 5</d2p1:Quarter>
      <d2p1:QuestionId>3</d2p1:QuestionId>
      <d2p1:Week>1</d2p1:Week>
      <d2p1:Year>1</d2p1:Year>
      <d2p1:Average>2.1</d2p1:Average>
      <d2p1:QuestionDescription>sample string 1</d2p1:QuestionDescription>
    </d2p1:ApprovedReviewAverageScore>
  </ApprovedReviewAverageScores>
</GetApprovedReviewAverageScoreResponse>

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.