Skip to content

Zonal statistics per interval

POST
/v1/statistics
curl --request POST \
--url https://api.satellitedata.net/v1/statistics \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "input": { "bounds": { "geometry": { "type": "Polygon", "coordinates": [ [ [ -93.262, 44.941 ], [ -93.252, 44.941 ], [ -93.252, 44.947 ], [ -93.262, 44.947 ], [ -93.262, 44.941 ] ] ] } }, "data": [ { "type": "optical-sr", "dataFilter": { "timeRange": { "from": "2026-06-01T00:00:00Z", "to": "2026-07-31T23:59:59Z" }, "maxCloudCoverage": 60 }, "processing": { "harmonize": "bandpass_adjusted", "cloudMask": { "exclude": [ "nodata", "saturated_defective", "cloud", "cloud_shadow", "cirrus", "cloud_adjacent" ], "dilate_m": 150 } } } ] }, "aggregation": { "timeRange": { "from": "2026-06-01T00:00:00Z", "to": "2026-07-31T23:59:59Z" }, "aggregationInterval": { "of": "P1M" }, "outputs": { "ndvi": "ndvi" }, "resx": 30, "resy": 30 }, "calculations": { "percentiles": [ 10, 50, 90 ], "histogram": { "bins": 4, "low": 0, "high": 1 } } }'

Computes zonal statistics for a geometry per time interval: min, max, mean, standard deviation, counts, percentiles and histograms for up to five named outputs. Every scene in each interval is read, cloud-masked with the defaultExclude classes unless overridden, and reduced in linear space. Capped at 120 intervals and 1,000 scenes per call.

Statistics request.

Media typeapplication/json

Zonal statistics request, modelled on the Sentinel Hub Statistical API.

object
input
required

Inputs.

object
bounds
required

Area of interest: bbox or geometry, not both.

object
bbox

Bounding box as [west, south, east, north] in CRS84 longitude and latitude, or six numbers with heights.

Array<number>
>= 4 items <= 6 items
geometry

A GeoJSON geometry.

object
type
required

GeoJSON geometry type.

string
Allowed values: Point MultiPoint LineString MultiLineString Polygon MultiPolygon
coordinates
required

GeoJSON coordinates in CRS84 longitude and latitude (RFC 7946).

array
properties

Bounds properties.

object
crs

CRS of bbox or geometry as an OGC URI.

string
default: http://www.opengis.net/def/crs/OGC/1.3/CRS84
data
required

Input collections.

Array<object>
>= 1 items <= 4 items

One input collection.

object
type
required

Collection id or alias, for example optical-sr or S2L2A.

string
id

Name for this source when the request fuses several, used as a prefix in expressions (s1.vv).

string
/^[a-z][a-z0-9_]{0,15}$/
dataFilter
required

Which scenes feed the request.

object
timeRange
required

Acquisition time window.

object
from
required

Inclusive start, RFC 3339 UTC.

string format: date-time
to
required

Inclusive end, RFC 3339 UTC.

string format: date-time
maxCloudCoverage

Maximum scene cloud cover percentage.

number
default: 100 <= 100
mosaickingOrder

Scene order for mosaics.

string
default: mostRecent
Allowed values: mostRecent leastRecent leastCC
platform

Normalized platform names such as landsat-9 or sentinel-2c.

Array<string>
Allowed values: landsat-1 landsat-2 landsat-3 landsat-4 landsat-5 landsat-7 landsat-8 landsat-9 sentinel-1a sentinel-1b sentinel-1c sentinel-1d sentinel-2a sentinel-2b sentinel-2c sentinel-2d tandem-x
sourcePreference

On optical-sr, which copy wins when native and HLS observe the same overpass.

Array<string>
Allowed values: native hls
filter

Extra CQL2 JSON filter on queryables.

object
key
additional properties
any
processing

How values are converted.

object
units

Output unit. Defaults per band from schema v1.

string
Allowed values: REFLECTANCE DN KELVIN CELSIUS LINEAR_POWER DB METERS DEGREES FRACTION
harmonize

Harmonization level. Default offset_removed on native collections and bandpass_adjusted on optical-sr.

string
Allowed values: none offset_removed bandpass_adjusted nbar
cloudMask

Unified cloud mask settings from schema v1.

object
exclude

Mask classes to drop. Defaults to schema v1 defaultExclude for statistics and time series and to the preset value for tiles.

Array<string>
unique items
Allowed values: nodata saturated_defective cloud cloud_shadow cirrus cloud_adjacent snow_ice water dark_terrain_shadow unclassified clear
scl7

How Sentinel-2 SCL class 7 is treated.

string
default: unclassified
Allowed values: unclassified cloud clear
dilate_m

Buffer in metres around cloud and cloud_shadow on sources without one.

integer
0 <= 600
cloudConfidence

Minimum Landsat QA_PIXEL cloud confidence counted as cloud.

string
default: medium
Allowed values: low medium high
clipNegative

Clip negative reflectance to 0.

boolean
resampling

Resampling method.

string
default: nearest
Allowed values: nearest bilinear cubic
pixelSelection

How overlapping scenes combine into one value.

string
default: first
Allowed values: first highest lowest mean median stdev lastbandhigh lastbandlow
egm

DEM only: return ellipsoidal heights instead of orthometric.

boolean
aggregation
required

Aggregation.

object
timeRange
required

Acquisition time window.

object
from
required

Inclusive start, RFC 3339 UTC.

string format: date-time
to
required

Inclusive end, RFC 3339 UTC.

string format: date-time
aggregationInterval
required

Interval length.

object
of
required

ISO 8601 duration such as P1D, P10D or P1M.

string
lastIntervalBehavior

What to do with a final partial interval.

string
default: SHORTEN
Allowed values: SKIP SHORTEN EXTEND
outputs
required

Output name to expression or index id, at most 5.

object
<= 5 properties
key
additional properties
string
resx

Pixel size in metres; default is the finest native gsd of the bands used.

number
resy

Pixel size in metres.

number
calculations

Extra calculations.

object
percentiles

Percentiles to compute.

Array<number>
<= 10 items
histogram

Histogram request.

object
bins
required

Bin count.

integer
>= 1 <= 256
low

Lower edge.

number
high

Upper edge.

number

Example

{
"input": {
"bounds": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-93.262,
44.941
],
[
-93.252,
44.941
],
[
-93.252,
44.947
],
[
-93.262,
44.947
],
[
-93.262,
44.941
]
]
]
}
},
"data": [
{
"type": "optical-sr",
"dataFilter": {
"timeRange": {
"from": "2026-06-01T00:00:00Z",
"to": "2026-07-31T23:59:59Z"
},
"maxCloudCoverage": 60
},
"processing": {
"harmonize": "bandpass_adjusted",
"cloudMask": {
"exclude": [
"nodata",
"saturated_defective",
"cloud",
"cloud_shadow",
"cirrus",
"cloud_adjacent"
],
"dilate_m": 150
}
}
}
]
},
"aggregation": {
"timeRange": {
"from": "2026-06-01T00:00:00Z",
"to": "2026-07-31T23:59:59Z"
},
"aggregationInterval": {
"of": "P1M"
},
"outputs": {
"ndvi": "ndvi"
},
"resx": 30,
"resy": 30
},
"calculations": {
"percentiles": [
10,
50,
90
],
"histogram": {
"bins": 4,
"low": 0,
"high": 1
}
}
}

Statistics per interval.

Media typeapplication/json

Zonal statistics.

object
status
required

OK, or PARTIAL when an interval failed.

string
Allowed values: OK PARTIAL
intervals
required

One entry per interval.

Array<object>

One interval.

object
interval
required

Interval.

object
from
required

Start.

string format: date-time
to
required

End.

string format: date-time
observations
required

Scenes read in the interval.

integer
outputs
required

Statistics per output name.

object
key
additional properties

Statistics for one output in one interval.

object
min

Minimum.

number | null
max

Maximum.

number | null
mean

Mean.

number | null
stDev

Standard deviation.

number | null
sampleCount
required

Pixel observations in the geometry: pixels times scenes read in the interval.

integer
noDataCount
required

Pixel observations masked or without data; the statistics use the rest.

integer
percentiles

Requested percentiles keyed p10, p50 and so on.

object
key
additional properties
number | null
histogram

Histogram.

object
bins
required

Bins.

Array<object>

Bin.

object
low
required

Lower edge.

number
high
required

Upper edge.

number
count
required

Pixels.

integer
error

Why this interval failed, when status is PARTIAL.

string
harmonize

Harmonization level applied.

string
Allowed values: none offset_removed bandpass_adjusted nbar
attribution
required

Credit line.

string

Example

{
"status": "OK",
"harmonize": "bandpass_adjusted",
"attribution": "Contains modified Copernicus Sentinel data 2026; Landsat data courtesy of the U.S. Geological Survey",
"intervals": [
{
"interval": {
"from": "2026-06-01T00:00:00Z",
"to": "2026-07-01T00:00:00Z"
},
"observations": 13,
"outputs": {
"ndvi": {
"min": 0.21,
"max": 0.88,
"mean": 0.61,
"stDev": 0.11,
"sampleCount": 7722,
"noDataCount": 3861,
"percentiles": {
"p10": 0.42,
"p50": 0.63,
"p90": 0.77
},
"histogram": {
"bins": [
{
"low": 0,
"high": 0.25,
"count": 77
},
{
"low": 0.25,
"high": 0.5,
"count": 401
},
{
"low": 0.5,
"high": 0.75,
"count": 1606
},
{
"low": 0.75,
"high": 1,
"count": 1777
}
]
}
}
}
},
{
"interval": {
"from": "2026-07-01T00:00:00Z",
"to": "2026-07-31T23:59:59Z"
},
"observations": 12,
"outputs": {
"ndvi": {
"min": 0.21,
"max": 0.88,
"mean": 0.74,
"stDev": 0.11,
"sampleCount": 7128,
"noDataCount": 2970,
"percentiles": {
"p10": 0.6,
"p50": 0.76,
"p90": 0.84
},
"histogram": {
"bins": [
{
"low": 0,
"high": 0.25,
"count": 19
},
{
"low": 0.25,
"high": 0.5,
"count": 125
},
{
"low": 0.5,
"high": 0.75,
"count": 1134
},
{
"low": 0.75,
"high": 1,
"count": 2880
}
]
}
}
}
}
]
}
X-Request-Id
string

Request id for support and logs.

Example
01JQ7Z3M8R5V2W6X9Y0A1B2C3D
X-Units-Spent
number

Units charged for this response; 0 for cache hits and free routes.

Example
1.333
X-Units-Remaining
number

Units left this month before restricted mode.

Example
8664.2
RateLimit
string

Remaining units and seconds to reset in the current window (IETF RateLimit header draft).

Example
"units";r=287;t=41
RateLimit-Policy
string

Quota policy of the caller (IETF RateLimit header draft).

Example
"units";q=300;w=60
X-Attribution
string

Credit lines for the data in the response, separated by semicolons.

Example
Contains modified Copernicus Sentinel data 2026; Landsat data courtesy of the U.S. Geological Survey

Malformed body.

Media typeapplication/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object
type
required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri
title
required

Short summary of the problem type. It does not change between occurrences.

string
status
required

HTTP status code, repeated for clients that lose the status line.

integer
>= 400 <= 599
detail
required

Explanation specific to this occurrence, written for a developer.

string
instance

Path of the request that failed.

string
code

Machine-readable problem code; equals the last path segment of type.

string
/^[a-z0-9-]+$/
requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string
errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object
pointer
required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string
detail
required

What is wrong with that member.

string
retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer
limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object
key
additional properties
number
unitsEstimated

Units the request would have cost, computed before execution.

number
error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string
Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope
error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string
message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string
key
additional properties
any

Example

{
"type": "https://docs.satellitedata.net/problems/invalid-body",
"title": "Invalid request body",
"status": 400,
"detail": "aggregation.aggregationInterval.of must be an ISO 8601 duration such as P1M.",
"instance": "/v1/statistics",
"code": "invalid-body",
"requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D",
"errors": [
{
"pointer": "/aggregation/aggregationInterval/of",
"detail": "not an ISO 8601 duration"
}
]
}
X-Request-Id
string

Request id for support and logs.

Example
01JQ7Z3M8R5V2W6X9Y0A1B2C3D

The API key or bearer token is missing, unknown, revoked or expired.

Media typeapplication/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object
type
required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri
title
required

Short summary of the problem type. It does not change between occurrences.

string
status
required

HTTP status code, repeated for clients that lose the status line.

integer
>= 400 <= 599
detail
required

Explanation specific to this occurrence, written for a developer.

string
instance

Path of the request that failed.

string
code

Machine-readable problem code; equals the last path segment of type.

string
/^[a-z0-9-]+$/
requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string
errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object
pointer
required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string
detail
required

What is wrong with that member.

string
retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer
limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object
key
additional properties
number
unitsEstimated

Units the request would have cost, computed before execution.

number
error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string
Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope
error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string
message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string
key
additional properties
any

Example

{
"type": "https://docs.satellitedata.net/problems/invalid-key",
"title": "Invalid or missing credentials",
"status": 401,
"detail": "Send a verified key in X-API-Key or a bearer token from /oauth/token.",
"instance": "/v1/process",
"code": "invalid-key",
"requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D"
}
X-Request-Id
string

Request id for support and logs.

Example
01JQ7Z3M8R5V2W6X9Y0A1B2C3D
WWW-Authenticate
string

Challenge naming the accepted schemes.

Example
Bearer realm="satellitedata.net", ApiKey header="X-API-Key"

The credentials are valid but cannot use this route, for example before email verification or without the scope.

Media typeapplication/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object
type
required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri
title
required

Short summary of the problem type. It does not change between occurrences.

string
status
required

HTTP status code, repeated for clients that lose the status line.

integer
>= 400 <= 599
detail
required

Explanation specific to this occurrence, written for a developer.

string
instance

Path of the request that failed.

string
code

Machine-readable problem code; equals the last path segment of type.

string
/^[a-z0-9-]+$/
requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string
errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object
pointer
required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string
detail
required

What is wrong with that member.

string
retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer
limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object
key
additional properties
number
unitsEstimated

Units the request would have cost, computed before execution.

number
error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string
Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope
error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string
message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string
key
additional properties
any

Example

{
"type": "https://docs.satellitedata.net/problems/email-unverified",
"title": "Email not verified",
"status": 403,
"detail": "Keys work only after the account email is verified. Check your inbox or resend from the dashboard.",
"instance": "/v1/process",
"code": "email-unverified",
"requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D"
}
X-Request-Id
string

Request id for support and logs.

Example
01JQ7Z3M8R5V2W6X9Y0A1B2C3D

Too many intervals or scenes, or an unknown output band.

Media typeapplication/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object
type
required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri
title
required

Short summary of the problem type. It does not change between occurrences.

string
status
required

HTTP status code, repeated for clients that lose the status line.

integer
>= 400 <= 599
detail
required

Explanation specific to this occurrence, written for a developer.

string
instance

Path of the request that failed.

string
code

Machine-readable problem code; equals the last path segment of type.

string
/^[a-z0-9-]+$/
requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string
errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object
pointer
required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string
detail
required

What is wrong with that member.

string
retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer
limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object
key
additional properties
number
unitsEstimated

Units the request would have cost, computed before execution.

number
error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string
Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope
error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string
message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string
key
additional properties
any

Example

{
"type": "https://docs.satellitedata.net/problems/too-many-scenes",
"title": "Too many scenes",
"status": 422,
"detail": "The request would read 1,840 scenes; the cap is 1,000 per call. Split the time range.",
"instance": "/v1/statistics",
"code": "too-many-scenes",
"requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D",
"limits": {
"maxScenes": 1000,
"requestedScenes": 1840
},
"unitsEstimated": 184.4
}
X-Request-Id
string

Request id for support and logs.

Example
01JQ7Z3M8R5V2W6X9Y0A1B2C3D

A per-minute, concurrency, monthly or per-IP limit was hit. Retry-After says when to retry.

Media typeapplication/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object
type
required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri
title
required

Short summary of the problem type. It does not change between occurrences.

string
status
required

HTTP status code, repeated for clients that lose the status line.

integer
>= 400 <= 599
detail
required

Explanation specific to this occurrence, written for a developer.

string
instance

Path of the request that failed.

string
code

Machine-readable problem code; equals the last path segment of type.

string
/^[a-z0-9-]+$/
requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string
errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object
pointer
required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string
detail
required

What is wrong with that member.

string
retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer
limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object
key
additional properties
number
unitsEstimated

Units the request would have cost, computed before execution.

number
error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string
Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope
error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string
message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string
key
additional properties
any

Example

{
"type": "https://docs.satellitedata.net/problems/rate-limited",
"title": "Rate limit exceeded",
"status": 429,
"detail": "This key spent 300 of its 300 units in the current minute.",
"instance": "/v1/process",
"code": "rate-limited",
"requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D",
"retryAfter": 17,
"limits": {
"unitsPerMinute": 300,
"unitsSpentThisMinute": 300
}
}
X-Request-Id
string

Request id for support and logs.

Example
01JQ7Z3M8R5V2W6X9Y0A1B2C3D
Retry-After
integer

Seconds to wait before retrying.

Example
17
RateLimit
string

Remaining units and seconds to reset in the current window (IETF RateLimit header draft).

Example
"units";r=287;t=41
RateLimit-Policy
string

Quota policy of the caller (IETF RateLimit header draft).

Example
"units";q=300;w=60

An unexpected server error. No units are charged.

Media typeapplication/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object
type
required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri
title
required

Short summary of the problem type. It does not change between occurrences.

string
status
required

HTTP status code, repeated for clients that lose the status line.

integer
>= 400 <= 599
detail
required

Explanation specific to this occurrence, written for a developer.

string
instance

Path of the request that failed.

string
code

Machine-readable problem code; equals the last path segment of type.

string
/^[a-z0-9-]+$/
requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string
errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object
pointer
required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string
detail
required

What is wrong with that member.

string
retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer
limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object
key
additional properties
number
unitsEstimated

Units the request would have cost, computed before execution.

number
error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string
Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope
error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string
message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string
key
additional properties
any

Example

{
"type": "https://docs.satellitedata.net/problems/internal",
"title": "Internal error",
"status": 500,
"detail": "The request failed on our side and was logged. No units were charged.",
"instance": "/v1/process",
"code": "internal",
"requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D"
}
X-Request-Id
string

Request id for support and logs.

Example
01JQ7Z3M8R5V2W6X9Y0A1B2C3D

An upstream catalog or bucket is unavailable, or the service is in maintenance. No units are charged.

Media typeapplication/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object
type
required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri
title
required

Short summary of the problem type. It does not change between occurrences.

string
status
required

HTTP status code, repeated for clients that lose the status line.

integer
>= 400 <= 599
detail
required

Explanation specific to this occurrence, written for a developer.

string
instance

Path of the request that failed.

string
code

Machine-readable problem code; equals the last path segment of type.

string
/^[a-z0-9-]+$/
requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string
errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object
pointer
required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string
detail
required

What is wrong with that member.

string
retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer
limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object
key
additional properties
number
unitsEstimated

Units the request would have cost, computed before execution.

number
error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string
Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope
error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string
message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string
key
additional properties
any

Example

{
"type": "https://docs.satellitedata.net/problems/upstream-unavailable",
"title": "Upstream unavailable",
"status": 503,
"detail": "NASA Earthdata returned 503 for the HLS credentials endpoint; HLS scenes are temporarily unavailable.",
"instance": "/v1/process",
"code": "upstream-unavailable",
"requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D",
"retryAfter": 120
}
X-Request-Id
string

Request id for support and logs.

Example
01JQ7Z3M8R5V2W6X9Y0A1B2C3D
Retry-After
integer

Seconds to wait before retrying.

Example
17

The render did not finish within the 29-second API Gateway limit. No units are charged.

Media typeapplication/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object
type
required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri
title
required

Short summary of the problem type. It does not change between occurrences.

string
status
required

HTTP status code, repeated for clients that lose the status line.

integer
>= 400 <= 599
detail
required

Explanation specific to this occurrence, written for a developer.

string
instance

Path of the request that failed.

string
code

Machine-readable problem code; equals the last path segment of type.

string
/^[a-z0-9-]+$/
requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string
errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object
pointer
required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string
detail
required

What is wrong with that member.

string
retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer
limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object
key
additional properties
number
unitsEstimated

Units the request would have cost, computed before execution.

number
error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string
Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope
error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string
message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string
key
additional properties
any

Example

{
"type": "https://docs.satellitedata.net/problems/render-timeout",
"title": "Render timed out",
"status": 504,
"detail": "The render read 41 scenes and did not finish in 29 seconds. Narrow the time range or lower the output size.",
"instance": "/v1/process",
"code": "render-timeout",
"requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D"
}
X-Request-Id
string

Request id for support and logs.

Example
01JQ7Z3M8R5V2W6X9Y0A1B2C3D