Summarize Nearby

sumNearbyLayer

(Required)

Point, line, or polygon features from which distances will be measured to features in the summaryLayer.

Syntax: As described in detail in the Feature input topic, this parameter can be one of the following:

• A URL to a feature service layer with an optional filter to select specific features
• A feature collection

Examples:

• {"url": <feature service layer url>, "filter": <where clause>}
• {"layerDefinition": {}, "featureSet": {}, "filter": <where clause>}

summaryLayer

(Required)

Point, line, or polygon features. Features in this layer that are within the specified distance to features in the sumNearbyLayer will be summarized.

Syntax: As described in detail in the Feature input topic, this parameter can be one of the following:

• A URL to a feature service layer with an optional filter to select specific features
• A feature collection

Examples:

• {"url": <feature service layer url>, "filter": <where clause>}
• {"layerDefinition": {}, "featureSet": {}, "filter": <where clause>}

nearType

Defines what type of distance measurement you want to use: straight-line distance, or by measuring travel time or travel distance along a street network using various modes of transportation known as travel modes. The default is StraightLine.

Valid values are a string, StraightLine, which indicates Euclidean distance will be used as the distance measure, or a JSON object representing settings for a travel mode.

Travel modes are managed in ArcGIS Online and can be configured by the administrator of your organization to better reflect your organization's workflows. You must specify the JSON object containing the settings for a travel mode supported by your organization. To get a list of supported travel modes, run the GetTravelModes operation from the Utilities service.

When using a travel mode for the nearType parameter, use a JSON object representing travel mode settings for the value. When you use the GetTravelModes operation from the Utilities service, the result is a string representing the travel mode JSON object. You must convert this string to a valid JSON object using the API and pass the JSON object as the value for the nearType parameter.

For example, the following is a string representing the Walking Time travel mode as returned by the GetTravelModes operation:

1
"{\"attributeParameterValues\": [{\"parameterName\": \"Restriction Usage\", \"attributeName\": \"Walking\", \"value\": \"PROHIBITED\"}, {\"parameterName\": \"Restriction Usage\", \"attributeName\": \"Preferred for Pedestrians\", \"value\": \"PREFER_LOW\"}, {\"parameterName\": \"Walking Speed (km/h)\", \"attributeName\": \"WalkTime\", \"value\": 5}], \"description\": \"Follows paths and roads that allow pedestrian traffic and finds solutions that optimize travel time. The walking speed is set to 5 kilometers per hour.\", \"impedanceAttributeName\": \"WalkTime\", \"simplificationToleranceUnits\": \"esriMeters\", \"uturnAtJunctions\": \"esriNFSBAllowBacktrack\", \"restrictionAttributeNames\": [\"Preferred for Pedestrians\", \"Walking\"], \"useHierarchy\": false, \"simplificationTolerance\": 2, \"timeAttributeName\": \"WalkTime\", \"distanceAttributeName\": \"Miles\", \"type\": \"WALK\", \"id\": \"caFAgoThrvUpkFBW\", \"name\": \"Walking Time\"}"

Convert the value above to a valid JSON object and pass it as the value for the nearType parameter.

nearType=

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
33
34
{
 "attributeParameterValues": [
   {
     "parameterName": "Restriction Usage",
     "attributeName": "Walking",
     "value": "PROHIBITED"
   },
   {
     "parameterName": "Restriction Usage",
     "attributeName": "Preferred for Pedestrians",
     "value": "PREFER_LOW"
   },
   {
     "parameterName": "Walking Speed (km\/h)",
     "attributeName": "WalkTime",
     "value": 5
   }
 ],
 "description": "Follows paths and roads that allow pedestrian traffic and finds solutions that optimize travel time. The walking speed is set to 5 kilometers per hour.",
 "impedanceAttributeName": "WalkTime",
 "simplificationToleranceUnits": "esriMeters",
 "uturnAtJunctions": "esriNFSBAllowBacktrack",
 "restrictionAttributeNames": [
   "Preferred for Pedestrians",
   "Walking"
 ],
 "useHierarchy": false,
 "simplificationTolerance": 2,
 "timeAttributeName": "WalkTime",
 "distanceAttributeName": "Miles",
 "type": "WALK",
 "id": "caFAgoThrvUpkFBW",
 "name": "Walking Time"
}

Example: "nearType": "StraightLine"

distances

(Required)

A list of double values that defines the search distance (for StraightLine and distance-based travel modes) or time (for time-based travel modes). You can enter a single distance value or multiple values, separating each value with a space. Features that are within (or equal to) the distances you enter will be summarized. The units of the distance values are supplied by the units parameter.

Examples:

• "distances": [4.0]
• "distances": [4.0, 5.0, 6.0]

units

If nearType is StraightLine or a distance-based travel mode, this is the linear unit to be used with the distance values specified in distances.

Values: Meters | Kilometers | Feet | Yards | Miles

If nearType is a time-based travel mode, the following values can be used as units:

Values: Seconds | Minutes | Hours

The default is Meters

Example: "units": "Miles"

timeOfDay

Specify whether travel times should consider traffic conditions. To use traffic in the analysis, set nearType to a travel mode object whose impedanceAttributeName property is set to TravelTime and assign a value to timeOfDay. (A travel mode with other impedanceAttributeName values doesn't support traffic.) The timeOfDay value represents the time at which travel begins, or departs, from the input points. The time is specified as Unix time (milliseconds since midnight, January 1, 1970).

The service supports two types of traffic: typical and live. Typical traffic references travel speeds that are made up of historical averages for each five-minute interval spanning a week. Live traffic retrieves speeds from a traffic feed that processes phone probe records, sensors, and other data sources to record actual travel speeds and predict speeds for the near future.

The Data Coverage page shows the countries Esri currently provides traffic data for.

Typical Traffic:

To ensure the task uses typical traffic in locations where it is available, choose a time and day of the week, and then convert the day of the week to one of the following dates from 1990:

• Monday—1/1/1990
• Tuesday—1/2/1990
• Wednesday—1/3/1990
• Thursday—1/4/1990
• Friday—1/5/1990
• Saturday—1/6/1990
• Sunday—1/7/1990

Set the time and date as Unix time in milliseconds.

For example, to solve for 1:03 p.m. on Thursdays, set the time and date to 1:03 p.m., 4 January 1990, and convert to milliseconds (631458180000).

Live Traffic:

To use live traffic when and where it is available, choose a time and date and convert to Unix time.

Esri saves live traffic data for 4 hours and references predictive data extending 4 hours into the future. If the time and date you specify for this parameter is outside the 8-hour time window, or the travel time in the analysis continues past the predictive data window, the task falls back to typical traffic speeds.

Syntax: The number of milliseconds since the Unix epoch (January 1, 1970).

Examples:

• "timeOfDay": 631458180000 // 13:03, 4 January 1990. Typical traffic on Thursdays at 1:03 p.m.
• "timeOfDay": 631731600000 // 17:00, 7 January 1990. Typical traffic on Sundays at 5:00 p.m.
• "timeOfDay": 1413964800000 // 8:00, 22 October 2014. If the current time is between 8:00 p.m., 21 Oct. 2014 and 8:00 p.m., 22 Oct. 2014, live traffic speeds are referenced in the analysis; otherwise, typical traffic speeds are referenced.
• "timeOfDay": 1426674000000 // 10:20, 18 March 2015. If the current time is between 10:20 p.m., 17 Mar. 2015, and 10:20 p.m., 18 Mar. 2015, live traffic speeds are referenced in the analysis; otherwise, typical traffic speeds are referenced.

timeZoneForTimeOfDay

Specify the time zone or zones of the timeOfDay parameter. There are two options: GeoLocal (default) and UTC.

GeoLocal:

The timeOfDay value refers to the time zone or zones in which the input points are located. This option causes the analysis to have rolling start times across time zones.

GeoLocal illustration: Setting timeOfDay to 9:00 a.m., 4 January 1990 (631443600000 milliseconds) and timeZoneForTimeOfDay to GeoLocal and submitting a valid request causes the drive times for points in the Eastern Time Zone to start at 9:00 a.m. Eastern Time and 9:00 a.m. Central Time for points in the Central Time Zone. (The start times are offset by an hour in real or UTC time.)

UTC:

The timeOfDay value refers to Coordinated Universal Time (UTC). The start times for all points are simultaneous, regardless of time zones.

UTC illustration: Setting timeOfDay to 9:00 a.m., 4 January 1990 (631443600000 milliseconds), and timeZoneForTimeOfDay to UTC, the start time for points in the Eastern Time Zone is 4:00 a.m. Eastern Time and 3:00 a.m. Central Time for those in the Central Time Zone.

Values: GeoLocal | UTC

returnBoundaries

If true, the resultLayer will contain areas defined by the specified nearType. For example, if using a StraightLine value of 5 miles, the resultLayer will contain areas with a 5-mile radius around the input sumNearbyLayer features.

If false, the resultLayer will contain the same features as the sumNearbyLayer layer.

The default is true.

Values: true | false

sumShape

A Boolean value that instructs the task to calculate statistics based on shape type of the summaryLayer, such as the count of points, the total length of lines, or the total area of polygons of the summaryLayer within each polygon in the sumNearbyLayer. If the summaryLayer is lines or polygons, the count of features within each summary polygon is returned.

The default is true.

Values: true | false

If sumShape is set to false , at least one value for summaryFields must be provided.

shapeUnits

(Required if sumShape is true)

If sumShape is true, you must specify the units of the shape summary.

Values:

• When summaryLayer contains polygons: Acres | Hectares | SquareMeters | SquareKilometers | SquareFeet | SquareYards | SquareMiles
• When summaryLayer contains lines: Meters | Kilometers | Feet | Yards | Miles

summaryFields

(Required if sumShape is false)

A list of field names and statistical summary types that you want to calculate for all nearby features.

Syntax: ["fieldName summaryType","fieldName summaryType", ...]

fieldName is one of the numeric or date fields from the summaryLayer parameter.

summaryType is one of the following:

• Sum—Adds the total value of all the features in each polygon. This statistic type is not supported for date fields.
• Mean—Calculates the average of all the features in each polygon. This statistic type is not supported for date fields.
• Min—Finds the smallest value of all the features in each polygon. This statistic type is supported for date fields.
• Max—Finds the largest value of all the features in each polygon. This statistic type is supported for date fields.
• Stddev—Finds the standard deviation of all the features in each polygon. This statistic type is not supported for date fields.

Example:

• "summaryFields": ["Lot_Value Sum", "Lot_Value Mean"]

groupByField

This is a field of the summaryLayer features that you can use to calculate statistics separately for each unique attribute value. For example, suppose the summaryLayer contains point locations of businesses that store hazardous materials, and one of the fields is HazardClass, which contains codes that describe the type of hazardous material stored. To calculate summaries by each unique value of HazardClass, use HazardClass as the groupByField field.

Example:

• "groupByField": "HazardClass"

When a groupByField field is provided, two results are created: the result layer and a related groupBySummary table containing the statistics.

minorityMajority

This Boolean parameter is applicable only when a groupByField is specified. If true, the minority (least dominant) or the majority (most dominant) attribute values for each group field within each nearby area are calculated. Two new fields are added to the resultLayer prefixed with Majority_ and Minority_.

The default is false.

Values: true | false

percentShape

This Boolean parameter is applicable only when a groupByField is specified. If set to true, the percentage of each unique groupByField value is calculated for each sumNearbyLayer feature. The default is false.

Values: true | false

outputName

If provided, the task will create a feature service of the results. You define the name of the service. If an outputName value is not provided, the task will return a feature collection.

Syntax:

1
2
3
4
5
{
  "serviceProperties": {
    "name": "<service name>"
  }
}

In ArcGIS Online or ArcGIS Enterprise 10.9.1 and later, you can overwrite an existing feature service by providing the itemId value of the existing feature service and setting the overwrite property to true. Including the serviceProperties parameter is optional. As described in the Feature output topic, you must either be the owner of the feature service or have administrative privileges to perform the overwrite.

Syntax:

1
2
3
4
5
6
7
{

  "itemProperties": {
			"itemId": "<itemID of the existing feature service>",
			"overwrite": true
	}
}

or

1
2
3
4
5
6
7
8
9
{
"serviceProperties": {
    "name": "<existing service name>"
  },
"itemProperties": {
				"itemId": "<itemID of the existing feature service>",
				"overwrite": true
	}
}

context

The Context parameter contains the following additional settings that affect task operation:

• Extent (extent)—A bounding box that defines the analysis area. Only input features that intersect the bounding box will be analyzed.
• Output spatial reference (outSR)—The output features will be projected into the output spatial reference.

Syntax:

1
2
3
4
{
  "extent" : {extent},
  "outSR" : {spatial reference}
}

f

The response format. The default response format is html.

Values: html | json

resultLayer

Example:

1
{"url":"http://<analysis url>/SummarizeNearby/jobs/<jobId>/results/resultLayer"}

The result has properties for parameter name, data type, and value. The contents of value depend on the outputName parameter provided in the initial request.

• If outputName was provided, value contains the URL to the feature service layer.

1
2
3
4
5
{
"paramName":"resultLayer",
"dataType":"GPString",
"value":{"url":"<hosted featureservice layer url>"}
}

• If outputName was not provided, value contains a layer definition and feature set.

1
2
3
4
5
{
"paramName":"resultLayer",
"dataType":"GPString",
"value":{"layerDefinition": {}, "featureSet": {}}
}

See Feature Output for more information about how the result layer or collection is accessed.

groupBySummary

If a groupByField field was provided as input, the result will have a groupBySummary table that contains the calculated statistics for each unique group. Tables are a subset of features; that is, they contain attributes but no geometry. Example:

1
{"url":"http://<analysis url>/SummarizeNearby/jobs/<jobId>/results/groupBySummary"}

The result has properties for parameter name, data type, and value. The contents of value depend on the outputName parameter provided in the initial request.

• If outputName was provided, value contains the URL to the feature service layer.

1
2
3
4
5
{
"paramName":"groupBySummary",
"dataType":"GPString",
"value":{"url":"<hosted featureservice layer url>"}
}

• If outputName was not provided, value contains a layer definition and feature set.

1
2
3
4
5
{
"paramName":"groupBySummary",
"dataType":"GPString",
"value":{"layerDefinition": {}, "featureSet": {}}
}

See Feature Output for more information about how the result layer or collection is accessed.