Sign in

v1

latestOpenAPI 3.0.02026-07-243964175.3 KB
coverage

v4 /coverage.json

Returns survey resources at a particular location, filtered by date.

get/coverage.json

Query parameters

polygonstring

The polygon to check for coverage, as a set of points where the first and last point must be the same.

It cannot be used with the point parameter.

pointstring

The point to check for coverage, as a comma separate longitude and latitude.

It cannot be used with the polygon query parameter.

sincestring

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.

untilstring

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.

bulkboolean

Bulk determines whether if the request is part of a large batch of requests, meaning requests will not be rate-limited.

prereleaseboolean

When set to true, causes pre-release system versions to be included in results.

perspectivestring

Accepts a comma-separated list of perspectives, limiting the coverage lookup to just those perspectives. The available perspectives are Vert and TrueOrtho.

This parameter is ignored if used with an empty value.

3dCoverageboolean

When set to true, performs coverage check using the 3D attribute coverage boundary of the resource.

systemVersionstring

If specified, causes the API to only consider the given system version when choosing which survey resource to use for serving the request.

systemVersionPrefixstring

If specified, causes the API to only consider system versions that match the prefix when choosing which survey resource to use for serving the request.

excludePartialResourcesboolean

Partial resources are AI resources that only has prediction generated at certain areas of the survey boundary as compared to our conventional fully processed resource. These types of resources are generally available by default. This flag opts-out from serving partial resources.

postcat'true' | 'false' | 'any'

When set, the API will consider only postcat resources (true), only non-postcat resources (false), or any resource (any) for results. This parameter is only available for users on the new pricing platforms. For users on the legacy pricing platform, the selection of postcat or non-postcat resources is determined by the packs (or classes) requested.

Response

OK

Example response

{
  "result": [
    {
      "id": "ae6f93cc-befc-4538-b87b-4733909c5cc1",
      "surveyId": "aa8fd559-c2e9-4e9a-82e6-449c37f0b363",
      "captureDate": "2019-09-27",
      "systemVersion": "gen3-winter_sunrise-1.1",
      "perspective": "Vert",
      "classes": [
        {
          "id": "2a29365e-e1c9-4be6-b5c2-233f2de6d845"
        }
      ]
    }
  ]
}