HomeDocumentationAPI Reference
Log In
API Reference

Get results

post
https://{sandfly-api-host}/v4/results

Gets all of the results.

Body Params

Results search parameters.

Search criteria for retrieving results. The result_ids, filter, and time_since properties are mutually exclusive; provide only one of them per request.

result_ids
array of strings

A list of result IDs. Mutually exclusive with filter and time_since.

result_ids
filter
object

Filter value from UI to pass into search. Mutually exclusive with result_ids and time_since.

boolean

Optional request to flatten returned data structure.

int32

Optional number of results to return on this call and subsequent scroll requests.

int32
Defaults to 1

Optional number of the page to return based on the size.

sort
array of objects

List of sort criteria applied to the results. Each entry specifies a field and a direction. If omitted, results are ordered by "id" descending (most recently results first).

sort
boolean

Optional request to return summary result data and not full dataset.

date-time
deprecated

A correctly formatted time entry for searching time since this date. Mutually exclusive with result_ids and filter. Deprecated. Do not use result timestamp for incremental synchronization; older results may commit to the database out-of-order with newer commits. Instead, synchronize using the result sequence ID, which is guaranteed to never have new, lower values than the current value returned by the getMaxID operation.

Responses

Updated 19 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago