NEnextbillion-ai
Tracking_Search

Polygon Search

Changed on
post/skynet/search/polygon

Request

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

filterstring

tags parameter will be deprecated soon! Please use the include_any_of_attributes or include_all_of_attributes parameters to match assets based on their labels or markers.

Use this parameter to filter the assets found inside the specified area by their tag. Multiple tag can be separated using comma (,).

Please note the tags are case sensitive.

pninteger

Denotes page number. Use this along with the ps parameter to implement pagination for your searched results. This parameter does not have a maximum limit but would return an empty response in case a higher value is provided when the result-set itself is smaller.

psinteger

Denotes number of search results per page. Use this along with the pn parameter to implement pagination for your searched results. Please note that ps has a default value of 20 and accepts integers only in the range of [1, 100].

max_search_limitboolean

if ture, can get 16x bigger limitation in search.

Example request

{
  "filter": "\"tag:delivery,truck\"",
  "match_filter": {
    "include_all_of_attributes": "\"shift_timing\": \"0800-1700\",\"driver_name\": \"John\""
  }
}

Response

statusstring

A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the API Error Codes section below for more information.

messagestring

Displays the error message in case of a failed request. If the request is successful, this field is not present in the response.

Changes

  • 7ee76f0ff679Revision changes
    • breaking

      removed the enum value car of the request property /

    • breaking

      removed the enum value distance of the request property /

    • breaking

      removed the enum value duration of the request property /

    • breaking

      removed the enum value straight_distance of the request property /

    • breaking

      removed the enum value truck of the request property /

    • info

      the request property default value changed from car to car

    • info

      added the new car enum value to the request property /

    • info

      added the new distance enum value to the request property /

    • info

      added the new duration enum value to the request property /

    • info

      added the new straight_distance enum value to the request property /

    • info

      added the new truck enum value to the request property /

  • a800b73f11c1Revision changes
    • breaking

      removed the enum value car of the request property /

    • breaking

      removed the enum value distance of the request property /

    • breaking

      removed the enum value duration of the request property /

    • breaking

      removed the enum value straight_distance of the request property /

    • breaking

      removed the enum value truck of the request property /

    • info

      the request property default value changed from car to car

    • info

      added the new car enum value to the request property /

    • info

      added the new distance enum value to the request property /

    • info

      added the new duration enum value to the request property /

    • info

      added the new straight_distance enum value to the request property /

    • info

      added the new truck enum value to the request property /