POST
/
v2
/
workspaces
/
{workspaceId}
/
search
curl --request POST \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/search \
  --header 'Content-Type: application/json' \
  --header 'X-Prismeai-API-Key: <api-key>' \
  --data '{
  "scope": "events",
  "limit": 123,
  "page": 123,
  "query": {},
  "aggs": {},
  "runtime_mappings": {},
  "source": [
    "<string>"
  ],
  "sort": [
    {}
  ],
  "track_total_hits": true
}'
{
  "size": 123,
  "documents": [
    {}
  ],
  "aggs": {}
}

Authorizations

X-Prismeai-API-Key
string
header
required
connect.sid
string
cookie
required

Path Parameters

workspaceId
string
required

ID of workspace to search in

Body

application/json
query
object
required

Elasticsearch DSL query to filter response documents

scope
enum<string>
Available options:
events
limit
number

Page size. Limit response documents, but aggregations still execute on all documents matching the given query

page
number

Page number returned by response's documents field

aggs
object

Elasticsearch aggregations executed on response documents

runtime_mappings
object

Elasticsearch runtime_mappings executed on runtime

source
string[]

Elasticsearch _source

sort
object[]

Elasticsearch sort

track_total_hits
boolean

Get real total instead of 10000

Response

200
application/json
Success Response
size
number
documents
object[]
aggs
object