/coverage/v2/aoi

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64

Number of survey records to return.

int64

Zero-based index of first record in the result.

string

Name of field to sort results by, with a prefix of "-" indicating to sort in descending order. Only one field can be specified. Default is by capture date descending.

string

Comma separated list of survey fields to include in the response. Default is all fields.

Body Params

The request of AOI query

string
required

Last day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD".

string
required

First day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD".

string
required

Comma separated list of resource types to include in the response in the form of "resourceClass:type" where ":type" is optional and represents all types of a resource class if not present. If not specified then all types are returned.

string
required

Overlap mode, can be "all" or "full", default is "all". "all" means input polygon intersect with content's polygon, "full" means input polygon within content's polygon.

aoi
object
required

Polygon or multipolygon describing the area of interest for the query

string
required

Specify tags survey resource should include, return survey resource that match AT LEAST ONE of exposed tag \ Comma separated tag query strings. Tag structure is TagType:TagName \ Single tag query can be TagType only, match same tag type with any tag value. \ Supported tag types are present in the coverage response

string
required

Specify tags survey resource should exclude, return survey resource does NOT match any exposed tag\ Comma separated tag query strings. Tag structure is TagType:TagName \ Single tag query can be TagType only, match same tag type with any tag value. \ Supported tag types are present in the coverage response

Responses

400

On bad input parameter or if polygon is invalid.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json