GET list¶
List the images present in your API. By default GET list returns information about 20 images for each call.
Resource URL¶
https://mobileengine.tineye.com/<company>/rest/list/
Notes¶
The list method’s output order is stable, so you can use offset and limit to implement pagination.
Parameters¶
In addition to the Common parameters there are:
Key |
Description |
|---|---|
name_filter (optional) |
Retrieve only images whose names match this filter (see Name Filtering for details). |
path_filter (optional) |
Retrieve only images whose paths match this filter (see Name Filtering for details). |
after_date_filter (optional) |
Retrieve only images inserted after this date (see Date Filtering for details). |
before_date_filter (optional) |
Retrieve only images inserted before this date (see Date Filtering for details). |
offset (optional) |
Skips that many images in the collection, defaults to 0. 0 means to not skip any items. Should be at least 0. |
limit (optional) |
Limits the results to this many images, defaults to 20. A value of 0 indicates no limit. |
Request example¶
curl https://mobileengine.tineye.com/<company>/rest/list/ --get \
-d "name_filter=^image_.*\.jpg$" \
-d "path_filter=^path/folder/" \
-d "after_date_filter=2023-02-20" \
-d "offset=1" \
-d "limit=2"
Response examples¶
JSON¶
{
"method": "list",
"status": "ok",
"error": [],
"result": [
"path/folder/image_2.jpg",
"path/folder/image_3.jpg"
],
"stats": {
"time_list": 2.71,
"time_total": 3.06
}
}
XML¶
<?xml version="1.0" encoding="utf-8"?>
<data>
<method>list</method>
<status>ok</status>
<error/>
<result>
<item>path/folder/image_2.jpg</item>
<item>path/folder/image_3.jpg</item>
</result>
<stats>
<time_list>2.71</time_list>
<time_total>3.06</time_total>
</stats>
</data>