/coverage/v2 /surveyresources/boundaries.{fileFormat}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required
Defaults to geojson

Response file format.

Allowed:
Query Params
string

The polygon for which the surveys are retrieved. The polygon is depicted by a set of lon,lat pairs, where the first and the last points must be the same. Either the polygon or line parameter must be specified.

string

The line for which the surveys are retrieved. The line is depicted by a set of lon,lat pairs. Either the polygon or line parameter must be specified.

int64

Number of survey resources to return.

int64

Zero-based index of first record in the result.

string

First day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents since 5 months ago.

string

Last day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents until 5 months ago.

string

Comma separated list of resource classes 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

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.

string

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

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

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 ascending.

Responses

400

On bad input parameter or if polygon is invalid.

404

On invalid fileformat input parameter.

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