# Statistical API

The Statistical API (or shortly "Stats API") enables you to get statistics calculated based on satellite imagery without having to download images. In your Statistical API request, you can specify your area of interest, time period, evalscript and which statistical measures should be calculated. The requested statistics are returned in the API response. Using Statistical API you can calculate the percentage of cloudy pixels for a given area of interest and time period, or calculate mean, standard deviation, and histogram of band values for a parcel in a given time period. Find more examples here.

To familiarise yourself with the Statistical API, we recommend checking the Requests builder, our API reference and our Statistical API webinar.

## General approach

Based on parameters specified by users in requests (e.g. area of interest, time range, evalscript) the Statistical API processes satellite data in a similar way as Processing API. Instead of returning images, it calculates requested statistics and returns the results in a json format.

## Deployments

Statistical api is available on AWS (2 regions) and CreoDIAS. The API's endpoint depends on the chosen deployment as specified in the table below.

Deployment | URL end-point |
---|---|

AWS EU (Frankfurt) | https://services.sentinel-hub.com/api/v1/statistics |

AWS US (Oregon) | https://services-uswest2.sentinel-hub.com/api/v1/statistics |

CreoDIAS | https://creodias.sentinel-hub.com/api/v1/statistics |

## Statistical API and evalscript

All general rules for building evalscripts apply. However, there are some specifics when using evalscripts with the Statistical API:

- The
`evaluatePixel()`

function**must**, in addition to other output, always return also`dataMask`

output. This output defines which pixels are excluded from calculations. For more details and an example, see here. - The default value of
`sampleType`

is`FLOAT32`

. - The
`output.bands`

parameter in the`setup()`

function can be an array. This makes it possible to specify custom names for the output bands and different output`dataMask`

for different outputs, see this example.

## API's features

### Split requested timeRange into multiple time intervals

The Statistical API supports requesting statistics for multiple time intervals with only one request. For example, requesting the `aggregationInterval`

and `timeRange`

as:

..."timeRange": {"from": "2020-06-01T00:00:00Z","to": "2020-07-31T00:00:00Z"},"aggregationInterval": {"of": "P10D"}...

returns the requested statistics calculated for multiple 10-day intervals, see this example. The aggregation intervals should be at least one day long (e.g. "P5D", "P30D"). You can only use period OR time designator not both.

If a `timeRange`

is not divisible by an `aggregationInterval`

, the last ("not full") time interval will be dismissed by default (`SKIP`

option). The user can instead set the `lastIntervalBehavior`

to `SHORTEN`

(shortens the last interval so that it ends at the end of the provided time range) or `EXTEND`

(extends the last interval over the end of the provided time range so that all the intervals are of equal duration).

Note that the data is mosaicked for each of the time intervals (as defined with the `mosaicking`

parameter in an evalscript) before the statistics are calculated. To calculate statistics over time (for example, the maximum NDVI value in a month), you should set mosaicking to ORBIT or TILE and calculate the required value in an evalscript, see this example. If you use mosaicking SIMPLE, one **mosaicked** output for each time interval is a basis for calculating statistics.

### Histogram

Requesting histograms is optional. A variety of histogram customisations are available. Users can specify either of the following:

- arbitrary
`bins`

or - width of bins
`binWidth`

or - number of bins
`nBins`

.

Along with `binWidth`

and `nBins`

users can also provide values for `lowEdge`

and/or `highEdge`

parameters. Otherwise, their default
values will be used, which correspond to `min`

and `max`

statistics for particular output band.

This example demonstrates all three options.

### Percentile calculations

It is possible to get values for any percentile. For example, to get values for 33%, 75%, and 90% percentile, add the "percentiles" parameter to your requests as:

...{"percentiles": {"k": [33, 75, 90]}}...

See also this example.

### Exclude pixels from calculations (dataMask output)

It is possible to exclude certain pixels from the calculation of the statistics. The most common use cases are excluding no data and cloudy pixels.

With the Statistical API, this is achieved by defining a special output called "dataMask". This output should have value "0" assigned for the pixels that should be excluded from the calculations, and a value of "1" elsewhere. The values of the "dataMask" output are defined by the user in an evalscript. An illustrative example is excluding water pixels from statistics of NDVI, see this example.

Note that the Statistical API does not automatically exclude the no data pixels from calculating the statistics. We recommend that you always exclude those unless there is a good reason not to. This is especially important when you are requesting statistics for a polygon, as it will ensure that pixels outside of the polygon (and inside of the bounding box) are excluded. To exclude no data pixels you need to pass input `dataMask`

band to the `dataMask`

output, e.g.:

function evaluatePixel(samples) {return {...,dataMask: [samples.dataMask]}}

All evalscripts in the examples here exclude no data pixels.

### Multiple outputs and multi bands outputs

Statistics can be requested for multiple outputs. This is useful when we need to use different dataMasks or different sampleTypes for each output. Additionally, each output can have multiple bands. It is possible to request different statistics for each band and for each output. This example demonstrates how to do all this.

### Examples

### Tutorials and Other Related Materials

- To get you started, we created a detailed beginner webinar on statistical API, where you can learn how to get statistics for your data, how to manipulate the evalscript to return several outputs, each with its own statistical information, how to make use of powerful aggregations, exclude pixels from the calculation, make custom histograms and visualize your statistics in Python.