POST Reporting/ComparisonReport/Post
Returns a new Comparison Report
Request Information
URI Parameters
None.
Body Parameters
The parameters to constrain the report
Smg.RestApi.Model.Reporting.ComparisonReportRequestEncapsulates the parameters used to request a comparison report.
Request Formats
application/json, text/json
Sample:
{
"LanguageId": 3,
"ProjectDefinedId": "SMG_EXAMPLE",
"ResponseMinCount": 1,
"ReportDateRange": {
"StartDate": "2018-06-10T00:00:00",
"EndDate": "2018-07-10T00:00:00"
},
"CompareDateRange": {
"StartDate": "2017-06-10T00:00:00",
"EndDate": "2017-07-10T00:00:00"
},
"DateType": "Visit",
"ReportHierarchyLevelId": 95013,
"ProvidedHierarchyLevelId": 915867,
"HierarchyNumbers": [
"1"
],
"Benchmarks": [
881,
884
],
"QuestionIds": [
10000,
20000
],
"IncludeHierarchyLevels": [],
"BreakoutId": 20000,
"TopPercentBenchmarks": [
20
]
}
application/xml, text/xml
Sample:
<ComparisonReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Smg.RestApi.Model.Reporting">
<Benchmarks xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>881</d2p1:int>
<d2p1:int>884</d2p1:int>
</Benchmarks>
<BreakoutId>20000</BreakoutId>
<CompareDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/Smg.RestApi.Model">
<d2p1:EndDate>2017-07-10T00:00:00</d2p1:EndDate>
<d2p1:StartDate>2017-06-10T00:00:00</d2p1:StartDate>
</CompareDateRange>
<DateType>Visit</DateType>
<HierarchyNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>1</d2p1:string>
</HierarchyNumbers>
<IncludeHierarchyLevels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<LanguageId>3</LanguageId>
<ProjectDefinedId>SMG_EXAMPLE</ProjectDefinedId>
<ProvidedHierarchyLevelId>915867</ProvidedHierarchyLevelId>
<QuestionIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>10000</d2p1:int>
<d2p1:int>20000</d2p1:int>
</QuestionIds>
<ReportDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/Smg.RestApi.Model">
<d2p1:EndDate>2018-07-10T00:00:00</d2p1:EndDate>
<d2p1:StartDate>2018-06-10T00:00:00</d2p1:StartDate>
</ReportDateRange>
<ReportHierarchyLevelId>95013</ReportHierarchyLevelId>
<ResponseMinCount>1</ResponseMinCount>
<TopPercentBenchmarks xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>20</d2p1:int>
</TopPercentBenchmarks>
</ComparisonReportRequest>
Response Information
Resource Description
A comparison report
Smg.RestApi.Model.Reporting.ComparisonReportEncapsulates the return data for a comparison report.
Response Formats
application/json, text/json
Sample:
{
"ValidationErrorMessage": null,
"ProjectId": 94108,
"ReportHierarchyLevelId": 95013,
"CombinedResult": {
"Text": "Combined",
"SurveyCount": 49808,
"Results": [
{
"QuestionId": 10000,
"Text": "Overall Satisfaction",
"Score": 0.75985785415997431,
"HasMinCount": true,
"Count": 49808,
"CompareToScore": null,
"CompareToHasMinCount": false,
"CompareToCount": null,
"ScoreDifference": null,
"Breakout": {
"QuestionId": 20000,
"Text": "Dine Type",
"Values": [
{
"SurveyCount": 10262,
"Text": "Dine-In",
"Value": 1,
"Score": 0.764373416488014,
"Count": 10262,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
},
{
"SurveyCount": 10273,
"Text": "Carry Out",
"Value": 2,
"Score": 0.76520977319186212,
"Count": 10273,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
}
]
}
}
],
"Skey": 0,
"HierarchyNumber": null,
"HierarchyLevels": []
},
"Results": [
{
"Text": "001 - Store 1",
"SurveyCount": 48,
"Results": [
{
"QuestionId": 10000,
"Text": "Overall Satisfaction",
"Score": 0.75,
"HasMinCount": true,
"Count": 48,
"CompareToScore": null,
"CompareToHasMinCount": false,
"CompareToCount": null,
"ScoreDifference": null,
"Breakout": {
"QuestionId": 15000,
"Text": "Dine Type",
"Values": [
{
"SurveyCount": 10,
"Text": "Dine-In",
"Value": 1,
"Score": 0.9,
"Count": 10,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
},
{
"SurveyCount": 11,
"Text": "Carry Out",
"Value": 2,
"Score": 0.6363636364,
"Count": 11,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
}
]
}
}
],
"Skey": 723565,
"HierarchyNumber": "001",
"HierarchyLevels": []
},
{
"Text": "002 - Store 2",
"SurveyCount": 39,
"Results": [
{
"QuestionId": 10000,
"Text": "Overall Satisfaction",
"Score": 0.8461538462,
"HasMinCount": true,
"Count": 39,
"CompareToScore": null,
"CompareToHasMinCount": false,
"CompareToCount": null,
"ScoreDifference": null,
"Breakout": {
"QuestionId": 15000,
"Text": "Dine Type",
"Values": [
{
"SurveyCount": 4,
"Text": "Dine-In",
"Value": 1,
"Score": 1.0,
"Count": 4,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
},
{
"SurveyCount": 14,
"Text": "Carry Out",
"Value": 2,
"Score": 0.7857142857,
"Count": 14,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
}
]
}
}
],
"Skey": 723565,
"HierarchyNumber": "002",
"HierarchyLevels": []
}
],
"Benchmarks": [
{
"Text": "Ohio",
"SurveyCount": 1246,
"Results": [
{
"QuestionId": 10000,
"Text": "Overall Satisfaction",
"Score": 0.7953451043,
"HasMinCount": true,
"Count": 1246,
"CompareToScore": null,
"CompareToHasMinCount": false,
"CompareToCount": null,
"ScoreDifference": null,
"Breakout": {
"QuestionId": 15000,
"Text": "Dine Type",
"Values": [
{
"SurveyCount": 307,
"Text": "Dine-In",
"Value": 1,
"Score": 0.8110749186,
"Count": 307,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
},
{
"SurveyCount": 249,
"Text": "Carry Out",
"Value": 2,
"Score": 0.7871485944,
"Count": 249,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
}
]
}
}
],
"Skey": 4972606,
"HierarchyNumber": "Ohio",
"HierarchyLevels": []
},
{
"Text": "Missouri",
"SurveyCount": 586,
"Results": [
{
"QuestionId": 10000,
"Text": "Overall Satisfaction",
"Score": 0.7423208191,
"HasMinCount": true,
"Count": 586,
"CompareToScore": null,
"CompareToHasMinCount": false,
"CompareToCount": null,
"ScoreDifference": null,
"Breakout": {
"QuestionId": 15000,
"Text": "Dine Type",
"Values": [
{
"SurveyCount": 128,
"Text": "Dine-In",
"Value": 1,
"Score": 0.734375,
"Count": 128,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
},
{
"SurveyCount": 123,
"Text": "Carry Out",
"Value": 2,
"Score": 0.7398373984,
"Count": 123,
"HasMinCount": true,
"CompareToScore": null,
"CompareToCount": null,
"CompareToHasMinCount": false,
"ScoreDifference": null
}
]
}
}
],
"Skey": 5576051,
"HierarchyNumber": "Missouri",
"HierarchyLevels": []
}
],
"TopPercentBenchmarks": [
{
"TopNPercent": 20,
"QuestionId": 18425,
"Text": "Overall Satisfaction",
"Score": 0.8322019147,
"Count": 45960,
"CompareToScore": null,
"CompareToCount": null,
"ScoreDifference": null
}
]
}
application/xml, text/xml
Sample:
<ComparisonReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Smg.RestApi.Model.Reporting">
<Benchmarks>
<ComparisonResult>
<HierarchyLevels />
<HierarchyNumber>Ohio</HierarchyNumber>
<Results>
<QuestionResult>
<Breakout>
<QuestionId>15000</QuestionId>
<Text>Dine Type</Text>
<Values>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>307</Count>
<HasMinCount>true</HasMinCount>
<Score>0.8110749186</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>307</SurveyCount>
<Text>Dine-In</Text>
<Value>1</Value>
</BreakoutValue>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>249</Count>
<HasMinCount>true</HasMinCount>
<Score>0.7871485944</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>249</SurveyCount>
<Text>Carry Out</Text>
<Value>2</Value>
</BreakoutValue>
</Values>
</Breakout>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>1246</Count>
<HasMinCount>true</HasMinCount>
<QuestionId>10000</QuestionId>
<Score>0.7953451043</Score>
<ScoreDifference i:nil="true" />
<Text>Overall Satisfaction</Text>
</QuestionResult>
</Results>
<Skey>4972606</Skey>
<SurveyCount>1246</SurveyCount>
<Text>Ohio</Text>
</ComparisonResult>
<ComparisonResult>
<HierarchyLevels />
<HierarchyNumber>Missouri</HierarchyNumber>
<Results>
<QuestionResult>
<Breakout>
<QuestionId>15000</QuestionId>
<Text>Dine Type</Text>
<Values>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>128</Count>
<HasMinCount>true</HasMinCount>
<Score>0.734375</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>128</SurveyCount>
<Text>Dine-In</Text>
<Value>1</Value>
</BreakoutValue>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>123</Count>
<HasMinCount>true</HasMinCount>
<Score>0.7398373984</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>123</SurveyCount>
<Text>Carry Out</Text>
<Value>2</Value>
</BreakoutValue>
</Values>
</Breakout>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>586</Count>
<HasMinCount>true</HasMinCount>
<QuestionId>10000</QuestionId>
<Score>0.7423208191</Score>
<ScoreDifference i:nil="true" />
<Text>Overall Satisfaction</Text>
</QuestionResult>
</Results>
<Skey>5576051</Skey>
<SurveyCount>586</SurveyCount>
<Text>Missouri</Text>
</ComparisonResult>
</Benchmarks>
<CombinedResult>
<HierarchyLevels />
<HierarchyNumber i:nil="true" />
<Results>
<QuestionResult>
<Breakout>
<QuestionId>20000</QuestionId>
<Text>Dine Type</Text>
<Values>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>10262</Count>
<HasMinCount>true</HasMinCount>
<Score>0.764373416488014</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>10262</SurveyCount>
<Text>Dine-In</Text>
<Value>1</Value>
</BreakoutValue>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>10273</Count>
<HasMinCount>true</HasMinCount>
<Score>0.76520977319186212</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>10273</SurveyCount>
<Text>Carry Out</Text>
<Value>2</Value>
</BreakoutValue>
</Values>
</Breakout>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>49808</Count>
<HasMinCount>true</HasMinCount>
<QuestionId>10000</QuestionId>
<Score>0.75985785415997431</Score>
<ScoreDifference i:nil="true" />
<Text>Overall Satisfaction</Text>
</QuestionResult>
</Results>
<Skey>0</Skey>
<SurveyCount>49808</SurveyCount>
<Text>Combined</Text>
</CombinedResult>
<ProjectId>94108</ProjectId>
<ReportHierarchyLevelId>95013</ReportHierarchyLevelId>
<Results>
<ComparisonResult>
<HierarchyLevels />
<HierarchyNumber>001</HierarchyNumber>
<Results>
<QuestionResult>
<Breakout>
<QuestionId>15000</QuestionId>
<Text>Dine Type</Text>
<Values>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>10</Count>
<HasMinCount>true</HasMinCount>
<Score>0.9</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>10</SurveyCount>
<Text>Dine-In</Text>
<Value>1</Value>
</BreakoutValue>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>11</Count>
<HasMinCount>true</HasMinCount>
<Score>0.6363636364</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>11</SurveyCount>
<Text>Carry Out</Text>
<Value>2</Value>
</BreakoutValue>
</Values>
</Breakout>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>48</Count>
<HasMinCount>true</HasMinCount>
<QuestionId>10000</QuestionId>
<Score>0.75</Score>
<ScoreDifference i:nil="true" />
<Text>Overall Satisfaction</Text>
</QuestionResult>
</Results>
<Skey>723565</Skey>
<SurveyCount>48</SurveyCount>
<Text>001 - Store 1</Text>
</ComparisonResult>
<ComparisonResult>
<HierarchyLevels />
<HierarchyNumber>002</HierarchyNumber>
<Results>
<QuestionResult>
<Breakout>
<QuestionId>15000</QuestionId>
<Text>Dine Type</Text>
<Values>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>4</Count>
<HasMinCount>true</HasMinCount>
<Score>1</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>4</SurveyCount>
<Text>Dine-In</Text>
<Value>1</Value>
</BreakoutValue>
<BreakoutValue>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>14</Count>
<HasMinCount>true</HasMinCount>
<Score>0.7857142857</Score>
<ScoreDifference i:nil="true" />
<SurveyCount>14</SurveyCount>
<Text>Carry Out</Text>
<Value>2</Value>
</BreakoutValue>
</Values>
</Breakout>
<CompareToCount i:nil="true" />
<CompareToHasMinCount>false</CompareToHasMinCount>
<CompareToScore i:nil="true" />
<Count>39</Count>
<HasMinCount>true</HasMinCount>
<QuestionId>10000</QuestionId>
<Score>0.8461538462</Score>
<ScoreDifference i:nil="true" />
<Text>Overall Satisfaction</Text>
</QuestionResult>
</Results>
<Skey>723565</Skey>
<SurveyCount>39</SurveyCount>
<Text>002 - Store 2</Text>
</ComparisonResult>
</Results>
<TopPercentBenchmarks>
<TopPercentBenchmark>
<CompareToCount i:nil="true" />
<CompareToScore i:nil="true" />
<Count>45960</Count>
<QuestionId>18425</QuestionId>
<Score>0.8322019147</Score>
<ScoreDifference i:nil="true" />
<Text>Overall Satisfaction</Text>
<TopNPercent>20</TopNPercent>
</TopPercentBenchmark>
</TopPercentBenchmarks>
<ValidationErrorMessage i:nil="true" />
</ComparisonReport>