Scroll

InsightMaker.scroll(sample, append=True, raw=False) A scrolled search to provide additional results to those from a previous search using a scroll id.

Name
Type
Description

sample

DataSample or string

DataSample object to perform scrolled search for, or scroll id as a string.

append

boolean

Default, True – if true append the scrolled results to the provided DataSample object (making it larger), if false, return a new DataSample object containing only new results.

raw

boolean

Default False, if true, returns the raw REST JSON response as a python dictionary.

Response

DataSample object properties

DataSample.df A pandas DataFrame object containing all results

DataSample.scroll_id The scroll ID required for a scroll search

Example

results = im.search("*", dataset = "sharepoint")

extra_results = im.scoll(results, append=False)

Last updated