Customer Geographic Summary Endpoint

Creates a report containing the geography areas where most of customers are located, ranked top to bottom according to the number of customers in each area.

Availability: Business Analyst Server.

URL Example

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

Specific Parameters

Parameter	Description
Customers (required)	The customer layer used to get the geographic summary. Type PointLayer.

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.
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, PJSON, 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. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Variable of type TaskResultOutput

Usage Tips

• This report uses a point-in-polygon procedure to assign customers to a given geography and outputs them in a report format.

• Use this report to outline the frequency and distribution of customer points for the base set of Business Analyst data layers. For example, you may want to know how many customers are in the State of California, in the county of San Diego, and in ZIP Code 92037.

• The customer layer must be a point feature layer.

• Customer points that do not fall inside the base Business Analyst layers will not be included in the report.

Example Usage

The example below generates a report area containing a geographic summary of customer distribution.

Request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/CustomerGeographicSummary/execute?
Customers={"Points":[
  {"name":"cust1","latitude":37.73325,"longitude":-122.4329,"storeId":"1","description":"Customer at Bosworth and Arlington"},
  {"name":"cust2","latitude":37.78415,"longitude":-122.4346,"storeId":"1","description":"Customer at Steiner St. and Geary Blvd"},
  {"longitude":-117.2384,"storeId":"2","description":"Customer in San Diego","latitude":32.8015,"name":"cust3"},
  {"longitude":-117.20393,"storeId":"2","description":"Customer in San Diego","latitude":32.769298,"name":"cust4"}
]}&StandardReportOptions={
  "ReportFormat":"PDF",
  "ReportHeader":[{"key":"subtitle","value":"Custom Report Title"}]
}&
OutputType=GetReport&
f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"CustGeoSumm.PDF",
      "dataType":"GPDataFile",
      "value":
      {
        "url":"http://localhost/arcgisoutput/_ags_T91DCC9D89498A83C2E57E53E65164.pdf"
      }
    }
  ],
  "messages":
  [
  ]
}