Profile by Area Summation Endpoint

Creates a new Tapestry segmentation profile on the given polygon layer.

Availability: Business Analyst Server.

URL Example

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

Specific Parameters

Parameter	Description
Boundaries (required)	The polygon layer used for area summation. Type DataLayer.
SegmentationBase (required)	Segmentation base. Use the GetSegBases lookup operation to query available segmentation bases. Type string.
AnalysisExtent (optional)	Analysis extent. Type ExtentData.
AreaIDField (optional)	Name of area ID field in the Boundaries layer. Type string. Default: AREA_ID.
SingleAreaID (optional)	ID of a single area of the Boundaries layer to calculate market penetration. Type string.

Other Parameters

Parameter	Description
ActiveDatasetID (optional)	ID of the active dataset. Type string. Default: ID of the first available dataset.
compatibility (optional)	Business Analyst Server version the JSON output is compatible with. Type string.
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.
OutputItem (optional)	Configuration options for storing the output profile 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 string containing XML serialized segmentation profile. In the case of JSON and PJSON response types, the response format depends on the compatibility parameter value.

Remarks

Use the Profile by Area Summation endpoint when you want to create a profile based on a polygon layer. Segmentation profiles can be created for any polygon feature layer, such as trade areas, study areas, and standard geography units in Business Analyst.

For example, suppose you want to create a Customer Tapestry Profile Report for a set of customers around a given store location. In Business Analyst, you can create a customer derived trade area using the locations of each customer in relation to the store location. For example, you could create a trade area that represents the closest 80 percent of the customers around the store location. This type of trade area is often referred to as the store's primary trade area. Once the trade area is created, you can use the ProfileByAreaSummation method to create a segmentation profile of the primary market area. When you create the Customer Tapestry Profile Report, you can compare the profile of the customer locations to the primary market area.

The analysis can be restricted to an analysis extent if the AnalysisExtent parameter is specified. The optional SingleAreaID and UseSelectedAreas parameters restrict the analysis to a single area and to selected areas of the boundary layer respectively. If the SingleAreaID property is specified, the AreaIDField property should be also specified.

Example Usage

The example below generates a market segmentation profile on a drive-time trade area layer.

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/ProfileByAreaSummation/execute?
Boundaries={"Item":{
  "WorkspaceName":"Default Workspace",
  "ProjectName":"San Francisco Tutorial Project",
  "folderType":"esriFolderTradeAreas",
  "itemName":"Drive Time Polygons 1"
}}&
SegmentationBase=Total Households&AreaIDField=RING&
f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"ProfileData",
      "dataType":"GPString",
      "value":"<ProfileData
        xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
        xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
        Base=\"Total Households\"
      >
        <Cluster
          ID=\"1\"
          Name=\"Top Rung\"
          Count=\"821\"
          Weight=\"0.875760\"
          VolumeInfo=\"821.682340\"
        />
        ...
        <Cluster
          ID=\"66\"
          Name=\"Unclassified\"
          Count=\"0\"
          Weight=\"0.000000\"
          VolumeInfo=\"0.000000\"
        />
      </ProfileData>"
    }
  ],
  "messages":
  [
  ]
}

NOTE: The XML string value in the response is split in lines for easy reading. The response has been abbreviated where "..." is noted.