B U S I N E S S A N A L Y S T 10.5 R E S T R E P O R T T A S K
Benchmark Report Endpoint
A comparative report that benchmarks two or more trade areas based on selected volumetric data (typically demographic data).
Availability: Business Analyst web app, Business Analyst Server.
URL Example
http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/BenchmarkReport/execute
Specific Parameters
Parameter |
Description |
|---|---|
BenchmarkOptions (required) |
Benchmark area calculation method. Type esriBABenchmarkOptions. |
Summarizations (required) |
Fields of the geography data layer to be summarized for trade areas and compared with the benchmark. Type array of string. |
TradeAreas (required) |
Array containing one or more trade area layers to produce the benchmark report. Type array of DataLayer. |
BenchmarkAreaOID (optional) |
OID of area from the BenchmarkLayer layer to be used as a benchmark area. Type int. |
BenchmarkLayer (optional) |
Data layer used for calculation the benchmark area. Type DataLayer. |
DataHierarchy (optional) |
Name of a hierarchy of data layers used for summarization. Type string. Use the Get Data Hierarchies lookup operation to query available geography hierarchies. Default: Standard Business Analyst Data. |
FieldSortType (optional) |
Report fields sorting options. Type esriBABenchmarkSortOptions. Default: sortNone. |
SortFieldName (optional) |
Name of summarization field the sorting will be based on. Type string. |
TAinRows (optional) |
Report layout options. The "trade areas in rows" layout is used by default. Type boolean. Default: true. |
TALayersFields (optional) |
Fields of trade area layers that will appear in the report. Type array of string. |
Other Parameters
Parameter |
Description |
|---|---|
OutputType (required) |
Array of task output options. Options for this method include creating a report (GetReport). Type array of TaskOutputType. |
StandardReportOptions (required) |
Report parameters. Type ReportOptions. The TemplateName parameter is ignored. Available with Business Analyst Online and Business Analyst Server. |
ActiveDatasetID (optional) |
ID of the active dataset. Type string. Default: ID of the first available dataset. |
f (optional) |
Response format. Type string. Available formats: HTML, JSON, XML. Default: HTML. |
IsFullErrorMessage (optional) |
Mode for composing error messages. Type boolean. Default: false. |
OutputReportItem (optional) |
Configuration options for storing the output report in the repository. This will enable viewing and working with the output result in subsequent tasks. Type esriFolderItem. |
token |
Authentication token. In Business Analyst Server, this parameter is required if your Business Analyst Server is secured. Type string. |
Returns
Variable of type TaskResultOutput
Remarks
The Benchmark Report allows you to compare multiple trade areas against one another to decipher how different or similar one location is over the next. You can easily measure the demographic characteristics of one area versus all other areas. The report shows statistical differences in raw number, percent, and index values.
The BenchmarkOptions parameter specifies how to create the benchmark area:
• useOneOfTheTradeAreas selects the benchmark area by its OID from the benchmark layer (the BenchmarkLayer and BenchmarkAreaOID parameters should be specified).
• useAverageValues creates the benchmark area by calculating average summarization values for all areas in trade area layers.
• useMedianValues creates the benchmark area by calculating median summarization values for all areas in trade area layers.
• useNone means no benchmark (creates a report without comparison with benchmark).
The TAinRows option determines the orientation of the summarization fields in the report:
• true value outputs the report with the summarization fields in columns and the trade areas in rows.
• false value outputs the report with the summarization fields in rows and the trade areas in columns.
The FieldSortType option specifies the sorting rules based on the SortFieldName field:
• sortNone means no sorting.
• sortByFieldOnly sorts by the field itself.
• sortByFieldDifference sorts by calculated difference between the field value and the benchmark field value.
• sortByFieldPercent sorts by calculated percent of the field value with respect to the benchmark field value.
• sortByFieldIndex sorts by the field index (available for some summarization fields).
NOTE: Since Business Analyst Server 10.0, the DataLayerID parameter is replaced with an optional DataHierarchy parameter.
Usage Tips
• The benchmarks can only be made on variables that exist in all trade area layers being compared.
• Variables and trade areas can be shown as either rows or columns.
• When benchmarking all trade areas against a single trade area, the average or the median of all the trade areas is calculated and used as the benchmark.
Example Usage
The example below generates a benchmark report based on drive-time trade areas.
NOTE: The example uses the "Drive Time Polygons 1" polygon layer already created in the Trade Areas folder of the San Francisco Tutorial Project of the Default Workspace.
Response
{
"results": [
{
"paramName": "Benchmark Report.HTML",
"dataType": "GPDataFile",
"value": {
"url": "http://localhost:6080/arcgis/rest/directories/arcgisoutput/DefaultMap_MapServer/_ags_T700D354FB4D5486EDB1C375BD3ABE.html"
}
}
],
"messages": [
]
}
See Also