Summary Reports Endpoint

Generates summary reports for trade areas.

Availability: Business Analyst Online, Business Analyst Server.

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/SummaryReports/execute

Specific Parameters

Parameter	Description
Boundaries (required)	The boundary layer that will be used to generate the reports. This boundary layer is usually a Business Analyst trade area layer. Type DataLayer.
AnalysisExtent (optional)	Data extent to restrict the summarization. Type ExtentData.
AreaIDField (optional)	The attribute field name in the input Boundaries layer which is associated with unique area IDs. If this parameter is omitted, the area ID field is recognized as follows: if the Boundaries layer is a standard layer, the "ID" field is used; otherwise, the "AREA_ID" field is used. Type string.
ReportSummarizationOptions (optional)	Features summarization method. Type esriBAReportSummarizationOptions. Available with Business Analyst Server 9.3 SP1 or greater. Default: esriBAIndividualFeatures.
RingIDField (optional)	The attribute field name in the input Boundaries layer which is associated with ring IDs (typically this field name is "RING"). Type string.
SingleAreaID (optional)	ID of a single area in the Boundaries layer to generate summary reports. Type string.
StoreIDField (optional)	The attribute field name in the input Boundaries layer which is associated with unique store/business IDs (typically store numbers for retail establishments with multiple locations). Type 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.
ReportOptions (required)	Array specifying summary reports that will be generated using trade/service areas as boundary areas for analysis. Use the Get Report Templates lookup operation to query available report templates. Type array of ReportOptions. 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.
DataHierarchy (optional)	Name of a hierarchy of data layers used for generating summary reports. Type string. Use the Get Data Hierarchies lookup operation to query available geography hierarchies. Default: Standard Business Analyst Data.
f (optional)	Response format. Type string. Available formats: HTML, JSON, PJSON, XML. Default: HTML.
IsFullErrorMessage (optional)	Mode for composing error messages. Type boolean. Default: false.
OutputReportItems (optional)	Array of configuration options for storing the output reports in the repository. This will enable viewing and working with the output results in subsequent tasks. Type array of 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

Report items are sorted by area ID field having the form "storeID_ringID". If the area ID field has a value non-confirming to this template, the RingIDField and StoreIDField parameters can be specified to provide the proper sorting.

The summarization can be restricted to an analysis extent if the AnalysisExtent parameter is specified. Optional SingleAreaID parameter restricts the summarization to a single area of the boundary layer. Since version 9.3 SP1, the summarization can be applied to individual features, to all features, and to both individual and all features. This behavior is controlled with the ReportSummarizationOptions parameter. Default is the summarization by individual features.

NOTE 1: Since Business Analyst Server 10.0, the SummaryDataLayerID parameter is replaced with an optional DataHierarchy parameter.

NOTE 2: Since Business Analyst Server 10.0, the OutputReportItem parameter is replaced with the OutputReportItems parameter which is an array of folder items. The number of items in this array should be equal to the number of items in the ReportOptions array.

Usage Tips

Creates one or more reports for a given boundary layer.

This function should be primarily used to create reports for Business Analyst trade areas.

The layer to summarize is usually the Esri Business data that comes standard with Business Analyst but can be any boundary layer that contains quantifiable data that has been set up using the Analysis Layer Setup function.

Example Usage

The example below generates Summary Reports on a drive-time trade area. See Get Report Templates endpoint for a list of available Summary Report types.

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.

Request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/SummaryReports/execute?boundaries={"Recordset":{"geometryType":"esriGeometryPolygon","spatialReference":{"wkid":4269},"features":[{"geometry":{"rings":[[[-122.4346,37.8566476371076],[-122.360655858915,37.826739954428],[-122.347749703146,37.761714833162],[-122.406398364369,37.7151967133423],[-122.488250155425,37.7254855017619],[-122.525947479981,37.784114591287],[-122.488335196333,37.8427896412311],[-122.4346,37.8566476371076]]],"spatialReference":{"wkid":4269}},"attributes":{"OID":1,"AREA_ID":"1_1","STORE_ID":"1","RING":1,"RING_DEFN":"5","AREA_DESC":"0 - 5 Miles"}},{"geometry":{"rings":[[[-122.4329,37.8057482650651],[-122.35900658434,37.775840365754],[-122.346109142864,37.7108146974946],[-122.404717633044,37.6642961225184],[-122.48651348554,37.6745850161913],[-122.524184911958,37.7332146557964],[-122.486598312884,37.791890171551],[-122.4329,37.8057482650651]]],"spatialReference":{"wkid":4269}},"attributes":{"OID":2,"AREA_ID":"2_1","STORE_ID":"2","RING":1,"RING_DEFN":"5","AREA_DESC":"0 - 5 Miles"}}]}}&reportoptions=[{"TemplateName":"Automotive Aftermarket Expenditures","ReportFormat":"PDF","ReportHeader":[{"key":"subtitle","value":"Automotive Aftermarket Expenditures"}],"ReportFooter":[{"key":"ProductLabel","value":"Test Label"},{"key":"ProductUrl","value": "www.Test.com/test"},{"key":"PhoneNumber","value": "000000000"},{"key":"TrialUrlText","value":"Test: Try it Now!"},{"key":"TrialUrl","value": "http://www.Test.test/test"}]}, {"TemplateName":"Census 2010 Summary Profile","ReportFormat":"PDF","ReportHeader":[{"key":"subtitle","value":"Census 2010 Summary Profile"}]}]&outputtype=[GetReport]&f=pjson

Response

{
 "results": [
  {
   "paramName": "Automotive Aftermarket Expenditures.PDF",
   "dataType": "GPDataFile",
   "value": {
    "url": "http://localhost:6080/arcgis/rest/directories/arcgisoutput/DefaultMap_MapServer/_ags_T52A22E94F41E8A621AE0A28E9F8CF.pdf"
   }
  },
  {
   "paramName": "Census 2010 Summary Profile.PDF",
   "dataType": "GPDataFile",
   "value": {
    "url": "http://localhost:6080/arcgis/rest/directories/arcgisoutput/DefaultMap_MapServer/_ags_T8D12B0B5846DC95DB396CEE6AAFBE.pdf"
   }
  }
 ],
 "messages": [
  
 ]
}