Aggregate Points

pointLayer (Required)

The point features that will be aggregated into the polygons in the polygonLayer or bins of the specified binSize.

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

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

REST examples

1
2
3
4
//REST web example
{"url": "https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}
//REST scripting example
"pointLayer" : {"url": "https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}

binType (Optional)

The type of bin that will be generated and into which points will be aggregated. When generating bins for Square, the number and units specified determine the height and length of the square. For Hexagon, the number and units specified determine the distance between parallel sides. Analysis using Square or Hexagon bins requires a projected coordinate system. If a projected coordinate system is not specified when running analysis, a projection will be picked based on the extent of the data. Analysis using H3 bins is supported at 11.2 or later and requires World Geodetic System 1984 (WKID 4326). If a different coordinate system is specified when running analysis with H3 bins, the input points will automatically be transformed into World Geodetic System 1984.

Values: H3 | Hexagon | Square (default)

REST examples

1
2
3
4
//REST web example
Hexagon
//REST scripting example
"binType": "Hexagon"

binSize (Required if binType is used and binResolution is not used)

The distance for the bins of type binType that the pointLayer will be aggregated into. When generating bins for Square the number and units specified determine the height and length of the square. For Hexagon, the number and units specified determine the distance between parallel sides. For H3, an H3 resolution will be chosen that produces bins with a distance between parallel sides closest to the number and units specified.

REST examples

1
2
3
4
//REST web example
108.3
//REST scripting example
"binSize": 100

binSizeUnit (Required if binSize is used)

The distance unit for the bins that the pointLayer will be aggregated into.

Values: Meters | Kilometers | Feet | FeetInt | FeetUS | Miles |MilesInt | MilesUS | NauticalMiles | NauticalMilesInt | NauticalMilesUS | Yards | YardsInt | YardsUS

REST examples

1
2
3
4
//REST web example
Meters
//REST scripting example
"binSizeUnit": "Miles"

binResolution (Required if binType is H3 and binSize is not used)

This parameter is available at ArcGIS GeoAnalytics Server 11.2 or later. The resolution of H3 bins that the pointLayer will be aggregated into. This value is only used when binType is H3 and binSize is not specified. Choose a resolution between 0 and 15, where 0 produces the largest bins and 15 produces the smallest bins.

REST examples

1
2
3
4
//REST web example
6
//REST scripting example
"binResolution": 6

polygonLayer (Required if binType is not used)

The polygon features (areas) into which the input points will be aggregated. This operation is not required if binSize and binSizeUnit have been defined.

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

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

REST examples

1
2
3
4
//REST web example
{"url": "https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}
//REST scripting example
"pointLayer": {"url": "https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}

timeStepInterval (Optional)

A numeric value that specifies duration of the time step interval. The default is none. This option is only available if the input points are time enabled and represent an instant in time.

REST examples

1
2
3
4
//REST web example
20
//REST scripting example
"timeStepInterval": 20

timeStepIntervalUnit (Optional)

A string that specifies units of the time step interval. The default is none. This option is only available if the input points are time enabled and represent an instant in time.

REST examples

1
2
3
4
//REST web example
Minutes
//REST scripting example
"timeStepIntervalUnit": "Minutes"

timeStepRepeatInterval (Optional)

A numeric value that specifies how often the time step repeat occurs. The default is none. This option is only available if the input points are time enabled and of time type instant.

REST examples

1
2
3
4
//REST web example
1
//REST scripting example
"timeStepRepeatInterval": 1

timeStepRepeatIntervalUnit (Optional)

A string that specifies the temporal unit of the step repeat. The default is none. This option is only available if the input points are time enabled and of time type instant.

REST examples

1
2
3
4
//REST web example
Hours
//REST scripting example
"timeStepRepeatIntervalUnit": "Hours"

timeStepReference (Optional)

A date that specifies the reference time to align the time slices to, represented in milliseconds from epoch. The default is January 1, 1970, at 12:00 a.m. (epoch time stamp 0). This option is only available if the input points are time enabled and of time type instant.

REST examples

1
2
3
4
//REST web example
946684800000
//REST scripting example
"timeStepReference": 946684800000

summaryFields (Optional)

A list of field names and statistical summary types you want to calculate. Note that the count is always returned. By default, all statistics are returned.

Note that the count of points within each polygon is always returned. onStatisticField specifies the name of the fields in the target layer. statisticType is one of the following for numeric fields:

• Count— For numeric fields, this totals the number of values of all the points in each polygon. For string fields, this totals the number of strings for all the points in each polygon.
• Sum— Adds the total value of all the points in each polygon. For numeric fields.
• Mean— Calculates the average of all the points in each polygon. For numeric fields.
• Max— Calculates the largest value of all the points in each polygon. For numeric fields.
• Range— Finds the difference between the Min and Max values. For numeric fields.
• Stddev— Finds the standard deviation of all the points in each polygon. For numeric fields.
• Var— Finds the variance of all the points in each polygon. For numeric fields.
• Any— Returns a sample string of a point in each polygon. For string fields.

REST examples

1
2
3
4
5
6
//REST web example
[{"statisticType": "Mean", "onStatisticField": "Annual_Sales"},{"statisticType": "Sum", "onStatisticField": "Annual_Sales"}]
//REST scripting example
"summaryFields": ["statisticType": "Mean", "onStatisticField": "Annual_Sales"},{"statisticType": "Sum", "onStatisticField": "Annual_Sales"}]
//Only return Count
"summaryFields": []

outputName (Required)

The task will create a feature service of the results. You define the name of the service.

REST examples

1
2
3
4
//REST web example
myOutput
//REST scripting example
"outputName": "myOutput"

context (Optional)

The context parameter contains additional settings that affect task execution. For this task, there are four settings:

• Extent (extent )—A bounding box that defines the analysis area. Only those features that intersect the bounding box will be analyzed.
• Processing spatial reference (processSR )—The features will be projected into this coordinate system for analysis.
• Output spatial reference (outSR )—The features will be projected into this coordinate system after the analysis to be saved. The output spatial reference for the spatiotemporal big data store is always WGS84.
• Data store (dataStore )—Results will be saved to the specified data store. The default is the spatiotemporal big data store.

Syntax:

1
2
3
4
5
6
{
  "extent": {extent},
  "processSR": {spatial reference},
  "outSR": {spatial reference},
  "dataStore": {data store}
}

f

The response format. The default response format is html .

Values: html | json | pjson

output

output will always contain polygon features. The number of resulting polygons is based on the location of inputPoints. The layer will inherit all the attributes of the input polygon layer; will have a Count attribute, which is the number of points that are enclosed by the polygon; and by default, will calculate all statistics for each field in the pointsLayer. If a summaryFields parameter is specified in the task request, the layer will compute the anything specified in the summaryFields. For example, if you had requested:

1
"summaryFields" :[{"statisticType": "Mean", "fieldName": "Annual_Sales"]

the resulting polygon features would have two attributes, Count and mean_Annual_Sales, to contain the calculated values.

1
{"url": "https://<analysis-url>/AggregatePoints/jobs/<jobId>/results/output"}

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. The value contains the URL of the feature service layer.

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

See Feature output for more information about how the result layer is accessed.