Tapestry Profile Report Endpoint

Creates the Tapestry Profile Report based on comparison of your customer target segmentation profile to a base segmentation profile.

URL Example

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

The Tapestry Profile Report shows the Tapestry segments and summary groups that most accurately reflect your customer records and compares your customer target segmentation profile to a base segmentation profile. The report is based on the number of customer records analyzed.

The Customer Tapestry Profile by Summary Group and Customer Tapestry Profile by Segment tables display the count, percent, and index of each summary group or segment for your customer profile and for the base profile. The Customer column notes the actual count of customers in each summary group or segment and the percentage of customers in the summary group or segment to the total number of customer records. The Penetration per 100 illustrates the penetration percentage per 100 customers in the summary group or segment. The last three columns—Number, Percent, and Index—show the households, percent of total households, and index of each summary group or segment in the base profile. The index average is 100. A segment with an index of 216 means that these households are 2.16 times more likely to be a customer than the average household.

The Customer Tapestry Profile by Segment table is sorted by customer percentage from highest to lowest. By sorting on customer percentage, you can see which segments make up your current customers. This report helps you answer the questions Who are my customers? and Who are my target (best) customers?

The illustration below is an example of a Customer Tapestry Profile Report. There are annotation callout bubbles that highlight how each value is calculated.

• A—There are 11 life mode groups, 10 urbanization groups, and a total of 66 Tapestry segments.

• B—1,203 customers are classified in "6 Sophisticated Squires". This Tapestry segment represents 29 percent of all customers.

• C—Percent penetration is calculated by dividing the target total for each segment by the base total and multiplying by 100. For example, if there were 2,000 customers in segment "6 Sophisticated Squires" and 100,000 households in the base, the percent penetration would be 2 percent.

• D—In the base area, 4 percent of all households, or 3,155,442 households, are in Tapestry segment "6 Sophisticated Squires".

• E—The index estimates the propensity of customers to be in a specific segment. A value of 100 is average. If a segment has an index value of 100, your percentage of customers for that segment is the same as the base. Therefore, a value of less than 100 indicates that the target profile consumes less than average (compared to the base), and a value greater than 100 indicates that the target profile consumes at a rate higher than the base. For example, in the report above, "6 Sophisticated Squires" has an index of 725, which means that households in this segment are 7.25 times as likely to be one of your customers than the average household in the base profile. An index is calculated by dividing the target percent composition (column B) by the base percent composition (column D) and multiplying by 100.

• If you want to use volumetric data instead of the distribution of customers in each segment, you must create the profile with volume information.

• Customers in the target profile should be wholly contained within the base profile.

• If you are unclear what to use as the base profile, you can use the whole United States.

The example below illustrates a workflow to create a Tapestry Profile Report from a target profile derived from a tables of customers with sales data and a base profile generated from a sales trade area.

Parameter	Description
BaseProfile (required)	Base segmentation profile. Type ProfileData.
TargetProfile (required)	Target segmentation profile. Type ProfileData.

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, 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.

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.

STEP 1: Create a base profile

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&
OutputItem={
  "WorkspaceName":"Default Workspace",
  "ProjectName":"Default Project",
  "folderType":"esriFolderSegProfiles",
  "itemName":"sampleBaseSegProfile_TapestryProfileReport"
}&
f=PJSON

STEP 2: Create a target profile

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/ProfileByImportFromTable/execute?
DataTable={"RecordSet":{"features":[
  {"geometry":{},"attributes":{"OID":1,"CUST_TYPE":"Target1","SEG_CODE":"1","COUNT":12320}},
  {"geometry":{},"attributes":{"OID":2,"CUST_TYPE":"Target2","SEG_CODE":"3","COUNT":3415}},
  {"geometry":{},"attributes":{"OID":3,"CUST_TYPE":"Target3","SEG_CODE":"9","COUNT":13415}}
]}}&
IDField=SEG_CODE&
CountField=COUNT&OutputItem={
  "WorkspaceName":"Default Workspace",
  "ProjectName":"Default Project",
  "folderType":"esriFolderSegProfiles",
  "itemName":"sampleTargetSegProfile_TapestryProfileReport"
}&
f=PJSON

STEP 3: Execute the TapestryProfileReport request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/TapestryProfileReport/execute?
BaseProfile={"Item":{
  "WorkspaceName":"Default Workspace",
  "ProjectName":"Default Project",
  "folderType":"esriFolderSegProfiles",
  "itemName":"sampleBaseSegProfile_TapestryProfileReport"
}}&
TargetProfile={"Item":{
  "WorkspaceName":"Default Workspace",
  "ProjectName":"Default Project",
  "folderType":"esriFolderSegProfiles",
  "itemName":"sampleTargetSegProfile_TapestryProfileReport"
}}&StandardReportOptions={
  "ReportFormat":"PDF",
  "ReportHeader":[{"key":"subtitle","value":"Custom Report Title"}]
}&
OutputType=GetReport&
f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"Customer Tapestry Profile.PDF",
      "dataType":"GPDataFile",
      "value":
      {
        "url":"http://localhost/arcgisoutput/_ags_TF5DE895A0483EA56AFC65F7573E62.pdf"
      }
    }
  ],
  "messages":
  [
  ]
}