Skip to main content
Version: 1.7.0

Fetch information and stats about your bulk searches

POSThttps://app.icypeas.com/api/search-files/read

When you launch a bulk search, a file is created by Icypeas. This file allows you to fetch stats about your bulk search and follow progression

tip

This route is paginated. To know how it works, please see here

A call with an empty body gives you information about all your files.

{}

You can also ask to get only files that are in progress:

{
"status": "in_progress"
}

Or files that are done:

{
"status": "done"
}

Of course, you can also retrieve stats about a specific file:

{
"file": "kbn5421aeteb0989"
}
caution
  • Maximum number of files per request in 50.
  • Files are sorted by creation date.
  • We apply rate limits of all routes, please see here.
POSThttps://app.icypeas.com/api/search-files/read
Get all your bulk searches.
BODY PARAMS
limitnumber(default value is 10, max value is 50)

Limit of files to fetch.

namestring

If you want to filter your search by file names, use this field.

filestring

If you want to get a specifc bulk, please use this field with your file id

statusstring(has to be either 'in_progress' or 'done')

If you want to fetch only bulk searches that are in progress or that are done

nextboolean

If you want to paginate, use this field. true = next page | false = previous page

sortsarray

Array used to paginate your files, it is this item you need to pass in your requests if you want to paginate further

creationDate*number

I don't know what to write here.

/search-files/read
{
"limit": 2
}
RESPONSES