Summarize nearby

What is a nearby analysis?

A nearby analysis is the process of finding features within a specified distance of other feature data. To execute the analysis, use the spatial analysis service and the SummarizeNearby operation.

Use the Summarize nearby operation to calculate statistics on point, polyline, or polygon features within close proximity of another hosted feature layer.

For example, using Summarize nearby, you could:

• Calculate the total population within five minutes of driving time of a proposed new store location.
• Calculate the number of freeway access ramps within a one-mile driving distance of a proposed new store location to use as a measure of store accessibility.
• Calculate school walk zones.

How to perform a nearby analysis

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

1. Review the parameters for the SummarizeNearby 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/SummarizeNearby/submitJob
   • Parameters:
     • sumNearbyLayer: The feature data from which distances will be measured to features in the summaryLayer.
     • summaryLayer: Feature data that are within the specified distance to features in the sumNearbyLayer.
     • outputName: The name of the resulting feature layer.
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/SummarizeNearby/submitJob

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
21
22
23
nearLayer = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/obdb/FeatureServer/0"
summaryLayer = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Enriched_Portland_Neighborhoods/FeatureServer/0"

results = summarize_nearby(
    summary_layer=summaryLayer,
    sum_nearby_layer=nearLayer,
    near_type="StraightLine",
    distances=[0.25],
    units="Miles",
    return_boundaries=False,
    minorityMajority=True,
    percent_shape=True,
    group_by_field="brewery_type",
    #Outputs results as a hosted feature layer.
    output_name="Summarize nearby results"
)

print(f"summarize 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
26
27
28

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

f=json
&token=<ACCESS_TOKEN>
&sumNearbyLayer={"url":"https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/obdb/FeatureServer/0"}
&summaryLayer={"url":"https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Enriched_Portland_Neighborhoods/FeatureServer/0"}
&nearType=StraightLine
&distances=[0.25]
&units=Miles
&returnBoundaries=false
&outputName={"serviceProperties":{"name": "Summarize nearby results"}}
&sumShape=true
&groupByField=brewery_type
&minorityMajority=true

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
26
27
28
POST <ANALYSIS_SERVICE>/arcgis/rest/services/tasks/GPServer/SummarizeNearby/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
26
27
28
POST <ANALYSIS_SERVICE>/arcgis/rest/services/tasks/GPServer/SummarizeNearby/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": "<url>",
    "itemId": "<itemid>"
  }
}

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