Summarize within

What is a summarize within analysis?

A summarize within analysis is the process of finding areas (and portions of areas) that overlap between two feature datasets and calculating statistics for the features that overlap. To execute the analysis, use the spatial analysis service and the SummarizeWithin operation.

Real-world examples of this analysis include the following:

• Calculating the total acreage of land-use type features within each polygon of a watershed feature layer.
• Summarizing the average value of vacant parcels with each city boundary polygon.
• Calculating the total mileage of roads by road type within each county polygon.

How summarize within works

The general steps to performing a summarize within analysis are as follows:

1. Review the parameters for the SummarizeWithin operation.
2. Send a request to get the spatial analysis service URL.
3. Execute a job request with the following URL and parameters:
   • URL: https://<YOUR_ANALYSIS_SERVICE>/arcgis/rest/services/tasks/GPServer/SummarizeWithin/submitJob
   • Parameters:
     • sumWithinLayer: The polygon features. Features, or portions of features, in the summaryLayer that fall within the boundaries of these polygons will be summarized.
     • summaryLayer: The polygon features into which the input points will be aggregated.
     • outputName: A string representing the name of the hosted feature layer to reutrn with the results.
4. Check the status.
5. Get the output layer results.

To see examples using ArcGIS API for Python, ArcGIS REST JS, and the ArcGIS REST API, go to Examples below.

URL Request

1
http://<YOUR_ANALYSIS_SERVICE>/arcgis/rest/services/tasks/GPServer/SummarizeWithin/submitJob?<parameters>

Required parameters

Key parameters

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
sumWithinLayer = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Summarize_Within/FeatureServer/2"
summaryLayer = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Summarize_Within/FeatureServer/1"

results = summarize_within(
    summary_layer=summaryLayer,
    sum_within_layer=sumWithinLayer,
    sum_shape=True,
    shape_units="Miles",
    group_by_field="ROUTE",
    minority_majority=False,
    # Outputs results as a hosted feature layer.
    output_name="Summarize within results"
)

print(f"Summarize within result item created {results.itemid}")

1
2
3
4
5
POST arcgis.com/sharing/rest/portals/self HTTP/1.1
Content-Type: application/x-www-form-urlencoded

&f=json
&token=<ACCESS_TOKEN>

1
2
3
4
5
6
7
8
9
10
11
{
  "helperServices": {
    // Other parameters
    "analysis": {
      "url": "https://<YOUR_ANALYSIS_SERVICE>/arcgis/rest/services/tasks/GPServer"
    },
    "geoenrichment": {
      "url": "https://geoenrich.arcgis.com/arcgis/rest/services/World/GeoenrichmentServer"
    }
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

POST <YOUR_ANALYSIS_SERVICE>/arcgis/rest/services/tasks/GPServer/SummarizeWithin/submitJob HTTP/1.1
Content-Type: application/x-www-form-urlencoded

f=json
&token=<ACCESS_TOKEN>
&summaryLayer={"url":"https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Summarize_Within/FeatureServer/1","name":"Bike Routes"}
&sumWithinLayer={"url":"https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Summarize_Within/FeatureServer/2","name":"Maintenance Assessment District"}
&sumShape=true
&shapeUnits=Miles
&groupByField=ROUTE
&minorityMajority=false
&outputName={"serviceProperties":{"name":"Summarize within results"}}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

{
  "jobId": "<JOB_ID>",
  "jobStatus": "esriJobSubmitted",
  "results": {},
  "inputs": {},
  "messages": []
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
POST <YOUR_ANALYSIS_SERVICE>/arcgis/rest/services/tasks/GPServer/SummarizeWithin/jobs/<JOB_ID> HTTP/1.1
Content-Type: application/x-www-form-urlencoded

f=json
&token=<ACCESS_TOKEN>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "jobId": "<JOB_ID>",
  "jobStatus": "esriJobSucceeded",
  "results": {
    "resultLayer": {
      "paramUrl": "results/resultLayer"
    },
    "groupBySummary": {
      "paramUrl": "results/groupBySummary"
    }
  },
  "inputs": {},
  "messages": []
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
POST <YOUR_ANALYSIS_SERVICE>/arcgis/rest/services/tasks/GPServer/SummarizeWithin/jobs/<JOB_ID>/results/resultLayer HTTP/1.1
Content-Type: application/x-www-form-urlencoded

f=json
&token=<ACCESS_TOKEN>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "paramName": "resultLayer",
  "dataType": "GPString",
  "value":  {
    "url": "<RESULT_ITEM_URL>",
    "itemId": "<RESULT_ITEM_ID>"
}
}

Tutorials

Learn how to perform related analyses interactively with Map Viewer and programmatically with ArcGIS API for Python, ArcGIS REST JS, and ArcGIS REST API.

Summarize data

Aggregate and summarize features using summarize analysis operations.

Map Viewer  Python ArcGIS REST JS  REST 

Services

API support

Tools