Filtering surveys

By adding a filter, you can restrict the surveys which are considered for rendering. You can filter by date or by tag or by a combination of both, for a more powerful restriction.
Filter by date

Use the Since and Until parameters to restrict surveys by a date range.
Filter by tag

Use the Include and Exclude parameters to filter on tags. Tags are additional metadata attributes available for a s mall number of surveys that were flown after select events.

While each tag must have a type and a name, you can filter on any or both type and name. For example, post catastrophe captures are tagged with type “disaster” with the name corresponding to the nature of the event, e.g. “hurricane”, “tornado”, etc.

The include and exclude parameters only filter on tags, not on any other metadata.

The example below includes all surveys that have a disaster type of hurricane. NOTE that if the value for disaster tag is empty it is not tagged at all and will not return "include=disaster".

GET 'https://api.nearmap.com/coverage/v2/point/-78.2942417882549648,33.9229164227871252?apikey=APIKEY&include=disaster&fields=id,captureDate,tags'
{
    "limit": 20,
    "offset": 0,
    "surveys": [
        {
            "captureDate": "2019-09-06",
            "id": "c64e4b46-d1b0-11e9-8bdd-07792c721697",
            "tags": {
                "disaster": "hurricane"
            }
        }
    ],
    "total": 1
}

Current tags of Type = disaster

Note that this list is a guideline only.