GET Social/ReportSummaryReview/{projectDefinedId}?language={language}

Returns an aggregation of social data, based on an authenticated user hierarchy access

Request Information

URI Parameters

Name	Description	Type	Additional information
projectDefinedId	The project defined id	string	Required
language	The webtext langugage to display. Defaults to "US"	string	Default value is US

Body Parameters

None.

Response Information

Resource Description

SMG.Report.Contracts.Social.ReportSummaryReview

Response Formats

application/json, text/json

Sample:

{
  "AverageRatings": {
    "RatingCount": 1,
    "Value": 2.1
  },
  "EndDate": "2024-04-26T11:38:15.8239762-05:00",
  "StartDate": "2024-04-26T11:38:15.8239762-05:00",
  "Ratings": [
    {
      "Name": "sample string 1",
      "ReviewCount": 2,
      "ReviewType": "Unknown",
      "Recommendation": true
    },
    {
      "Name": "sample string 1",
      "ReviewCount": 2,
      "ReviewType": "Unknown",
      "Recommendation": true
    }
  ],
  "Sources": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "ReviewCount": 3,
      "ReviewType": "Unknown",
      "Recommendation": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "ReviewCount": 3,
      "ReviewType": "Unknown",
      "Recommendation": true
    }
  ],
  "RecommendationSources": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "ReviewCount": 3,
      "ReviewType": "Unknown",
      "Recommendation": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "ReviewCount": 3,
      "ReviewType": "Unknown",
      "Recommendation": true
    }
  ]
}

application/xml, text/xml

Sample:

<ReportSummaryReview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMG.Report.Contracts.Social">
  <AverageRatings>
    <RatingCount>1</RatingCount>
    <Value>2.1</Value>
  </AverageRatings>
  <EndDate>2024-04-26T11:38:15.8239762-05:00</EndDate>
  <Ratings>
    <SummaryItem>
      <Name>sample string 1</Name>
      <Recommendation>true</Recommendation>
      <ReviewCount>2</ReviewCount>
      <ReviewType>Unknown</ReviewType>
    </SummaryItem>
    <SummaryItem>
      <Name>sample string 1</Name>
      <Recommendation>true</Recommendation>
      <ReviewCount>2</ReviewCount>
      <ReviewType>Unknown</ReviewType>
    </SummaryItem>
  </Ratings>
  <RecommendationSources>
    <SummaryItemSource>
      <Name>sample string 2</Name>
      <Recommendation>true</Recommendation>
      <ReviewCount>3</ReviewCount>
      <ReviewType>Unknown</ReviewType>
      <Id>1</Id>
    </SummaryItemSource>
    <SummaryItemSource>
      <Name>sample string 2</Name>
      <Recommendation>true</Recommendation>
      <ReviewCount>3</ReviewCount>
      <ReviewType>Unknown</ReviewType>
      <Id>1</Id>
    </SummaryItemSource>
  </RecommendationSources>
  <Sources>
    <SummaryItemSource>
      <Name>sample string 2</Name>
      <Recommendation>true</Recommendation>
      <ReviewCount>3</ReviewCount>
      <ReviewType>Unknown</ReviewType>
      <Id>1</Id>
    </SummaryItemSource>
    <SummaryItemSource>
      <Name>sample string 2</Name>
      <Recommendation>true</Recommendation>
      <ReviewCount>3</ReviewCount>
      <ReviewType>Unknown</ReviewType>
      <Id>1</Id>
    </SummaryItemSource>
  </Sources>
  <StartDate>2024-04-26T11:38:15.8239762-05:00</StartDate>
</ReportSummaryReview>