Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Tracking_Asset

Get Asset List

get/skynet/asset/list

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.

tagsstring
Example:tags=tag_1,tag_2

This parameter will be deprecated soon! Please use the include_all_of_attributes or include_any_of_attributes parameters to provide labels or markers for the assets to be retrieved.

tags can be used to filter the assets. Only those assets which have all the tags provided, will be included in the result. In case multiple tags need to be specified, use , to separate them.

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.

sortstring field:order
Example:updated_at:desc

Provide a single field to sort the results by. Only updated_at or created_at fields can be selected for ordering the results.

By default, the result is sorted by created_at field in the descending order. Allowed values for specifying the order are asc for ascending order and desc for descending order.

include_all_of_attributesstring key_1:value_1|key_2:value_2
Example:include_all_of_attributes=vehicle_type:pickup_truck|driver_name:John

Use this parameter to filter the assets by their attributes. Only the assets having all the attributes added to this parameter, will be returned in the response. Multiple attributes can be separated using pipes (|).

Please note the attributes are case sensitive. Also, this parameter can not be used in conjunction with include_any_of_attributes parameter.

include_any_of_attributesstring key1:value1|key2:value2|...
Example:include_any_of_attributes=vehicle_type:pickup_truck|driver_name:John

Use this parameter to filter the assets by their attributes. Assets having at least one of the attributes added to this parameter, will be returned in the response. Multiple attributes can be separated using pipes (|).

Please note the attributes are case sensitive. Also, this parameter can not be used in conjunction with include_all_of_attributes parameter.

Response

OK

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.