Skip to content

Asset Query Syntax

Any hyperlink to a collection of assets can accept query parameters that filter the returned assets.

  • /customers/{customer}/allImages
  • /customers/{customer}/spaces/{space}/images

Once you have registered images with the platform you can query it for information on them. One immediate use of this is to monitor the progress of ongoing registrations. For example, if you registered a batch of 100,000 images it will take some time for the platform to process them, and you would like to be able to monitor progress and view any errors that were encountered. You can also query for usage statistics.

Only the 6 built-in string and number fields are supported.

?string1=my-value
?number1=99
?string1=my-value&number1=99
?q={"string1":"my-value"}
?q={"number1":99}
?q={"string1":"my-value","number1":99}
?pageSize=10&page=2
?q={"string1":"my-value","number1":99}&pageSize=10&page=2