(Required)

The date field used to determine which bin each feature falls into.

binField=<dateField>

binField=birthdate

(Required)

A JSON parameter that describes the characteristics of the bins, such as the size of the bin and its starting position. The size of each bin is determined by the number of time units denoted by the number and unit properties.

The starting position of the bin is the earliest moment in the specified unit. For example, each year begins at midnight of January 1. An offset inside the bin parameter can provide an offset to the starting position of the bin. This can contain a positive or negative integer value.

A bin can take two forms: either a calendar bin or a fixed bin. A calendar bin is aware of calendar-specific adjustments, such as daylight saving time and leap seconds. Fixed bins are, by contrast, always a specific unit of measurement (for example, 60 seconds in a minute, 24 hours in a day) regardless of where the date and time of the bin starts. For this reason, some calendar-specific units are only supported as calendar bins.

The timezone property will convert the bin ranges into the given time zone. Time zones are provided as IANA strings.

The offset and timezone properties are optional. If timezone is not provided, the default UTC zone is used.

//Calendar Bin syntax
{
  "calendarBin": {
    "unit": "<minute | hour | day | week | month | quarter | year>",
    "timezone": "<IANA Timezone description>",
    "offset": {
      "number": <integer>,
      "unit": "<second | minute | hour | day>"
    }
  }
}

//Fixed Bin syntax
{
  "fixedBin": {
    "unit": "<second | minute | hour | day>",
    "number": "<integer>",
    "offset": {
      "number": <integer>,
      "unit": "<second | minute | hour | day>"
    }
  }
}

//Calendar Bin example
{
  "calendarBin": {
    "unit": "year",
    "timezone": "US/Arizona",
    "offset": {
      "number": 5,
      "unit": "hour"
    }
  }
}

//Fixed Bin example
{
  "fixedBin": {
    "number": 12,
    "unit": "hour",
    "offset": {
      "number": 5,
      "unit": "hour"
    }
  }
}

Defines the beginning and end of the data in binField as epoch milliseconds. This acts as both a filter on the results (in addition to any other filters you apply) and as a strict designation of the first and last points of data, even if there are no data points present at those points.

If the first or last bin does not fall evenly into the division of data, the bin will contain data that is cropped to the time extent. For example, if you have yearly bins from January to December, but the data is defined to be from July to July, the first and last bins will show as a full year but contain only six months of data.

If no time is specified, the range of data encompasses the earliest and latest data points.

time=<startTime>, <endTime>

//1 January 2008 00:00:00 GMT to 1 January 2009 00:00:00 GMT
time=1199145600000, 1230768000000

A null value specified for either the start or end time will represent infinity.

time=null, 1230768000000

Results can be returned in ascending or descending order. The default is ascending (ASC).

binOrder=<ASC | DESC>

(Required)

The definitions for one or more field-based statistics to be calculated.

outStatistics=[
  {
    "statisticType": "<count | sum | min | max | avg | stddev | var>",
    "onStatisticField": "Field1", 
    "outStatisticFieldName": "Out_Field_Name1"
  },
  {
    "statisticType": "<count | sum | min | max | avg | stddev | var>",
    "onStatisticField": "Field2",
    "outStatisticFieldName": "Out_Field_Name2"
  }  
]

outStatistics=[
  {
    "statisticType": "sum",
    "onStatisticField": "gender",
    "outStatisticFieldName": "PopulationByGender"
  },
  {
    "statisticType": "avg",
    "onStatisticField": "income",
    "outStatisticFieldName": "AverageIncome"
  }
]

A WHERE clause for the query filter.

SQL-92 WHERE clause syntax on the fields in the layer is supported for most data sources. Some data sources have restrictions on what is supported. Hosted feature services in ArcGIS Enterprise running on a spatiotemporal data source only support a subset of SQL-92. For example, spatiotemporal-based feature services support the like operator but do not support the not like operator or field equivalency expressions such as field1 = field2. The following is a list of supported SQL-92 with spatiotemporal-based feature services:

( '<=' | '>=' | '<' | '>' | '=' | '!=' | '<>' | LIKE )
(AND | OR)
(IS | IS_NOT)
(IN | NOT_IN) ( '(' ( expr ( ',' expr )* )? ')' )
COLUMN_NAME BETWEEN LITERAL_VALUE AND LITERAL_VALUE

For information on how to format time and date information, see the Date-time queries section.

where=POP2000 > 350000

where=CITY_NAME = 'Barrington'

Returns the geometry centroid associated with all the features in the bin. If true, the result includes the geometry centroid. The default is false. This parameter is only supported on point data.

Values: true | false

The geometry to apply as the spatial filter. The structure of the geometry is the same as the structure of the JSON geometry objects returned by ArcGIS REST API. In addition to the JSON structures, you can specify the geometry of envelopes and points with a simple comma-separated syntax.

//JSON structures
geometryType=<geometryType>&geometry={ geometry}

//Envelope simple syntax
geometryType=esriGeometryEnvelope&geometry=<xmin>,<ymin>,<xmax>,<ymax>

//Point simple syntax
geometryType=esriGeometryPoint&geometry=<x>,<y>

//Envelop example
geometryType=esriGeometryEnvelope&geometry={xmin: -104, ymin: 35.6, xmax: -94.32, ymax: 41}

//Envelope example
geometryType=esriGeometryEnvelope&geometry=-104,35.6,-94.32,41

//Point example
geometryType=esriGeometryPoint&geometry=-104,35.6

The spatial reference of the input geometry. The spatial reference can be specified as either a well-known ID or as a spatial reference JSON object. If the inSR is not specified, the geometry is assumed to be in the spatial reference of the layer.

The spatial reference of the returned geometry. The spatial reference can be specified as either a well-known ID or as a spatial reference JSON object. If outSR is not specified, the geometry is returned in the spatial reference of the map.

When using outSR with the pbf output format, the pbf format will use coordinate quantization for layer queries. When an output spatial reference is not provided for a query operation, the feature service derives coordinate quantization parameters from the layer's spatial reference. If the precision in the layer's spatial reference is inadequate for the client applicant's use, it should pass in a spatial reference with suitable precision as the output spatial reference. If the layer's source spatial reference has the desired precision and it is suitable for the client's use, the client can use the source layer's spatial reference as the output spatial reference.

The spatial relationship to be applied to the input geometry while performing the query. The supported spatial relationships include intersects, contains, envelop intersects, within, and so on. The default spatial relationship is intersects (esriSpatialRelIntersects).

Values: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

A JSON object used to project the geometry onto a virtual grid, likely representing pixels on the screen. The properties of the JSON object include extent, mode, originPosition, and tolerance. For more information, see the Quantization parameters JSON properties section below.

//upperLeft origin position
{
  "mode": "view",
  "originPosition": "upperLeft",
  "tolerance": 1.0583354500042335,
  "extent": {
    "type": "extent",
    "xmin": -18341377.47954369,
    "ymin": 2979920.6113554947,
    "xmax": -7546517.393554582,
    "ymax": 11203512.89298139,
    "spatialReference": {
      "wkid": 102100,
      "latestWkid": 3857
    }
  }
}

//lowerLeft origin position
{
  "mode": "view",
  "originPosition": "lowerLeft",
  "tolerance": 1.0583354500042335,
  "extent": {
    "type": "extent",
    "xmin": -18341377.47954369,
    "ymin": 2979920.6113554947,
    "xmax": -7546517.393554582,
    "ymax": 11203512.89298139,
    "spatialReference": {
      "wkid": 102100,
      "latestWkid": 3857
    }
  }
}

This parameter fetches query results by skipping the specified number of records and starting from the next record (that is, resultOffset + 1). The default is 0. You can also set this option to fetch records that are beyond maxRecordCount.

resultOffset=100

This parameter fetches query results up to the resultRecordCount value specified. When resultOffset is specified, but this parameter is not, the map service defaults it to maxRecordCount. The maximum value for this parameter is the value of the layer's maxRecordCount property. The minimum value entered for this parameter cannot be below 1.

resultRecordCount=100

When set to true, features are returned even when the results include "exceededTransferLimit": true. This allows a client to find the resolution in which the transfer limit is no longer exceeded without making multiple calls. The default value is false.

Values: true | false

Introduced at ArcGIS Enterprise 11.1. This parameter changes the default name of the boundary property returned in the response to a user-specified name. The boundary property indicates the value at the edge of each bin that is returned in a response. Unless changed using the binBoundaryAlias parameter, this field will be named boundary by default.

binBoundaryAlias=temperatureBinValue

The response format. The default format is html.

Values: html | json | pjson | pbf