Post v2workspaces search

Generic search API to query or aggregate events & DSUL objects

POST /v2/workspaces/{workspaceId}/search

cURL

cURL

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

import requests

url = "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/search"

payload = {
    "query": {},
    "scope": "events",
    "limit": 123,
    "page": 123,
    "aggs": {},
    "runtime_mappings": {},
    "source": ["<string>"],
    "sort": [{}],
    "track_total_hits": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: {},
    scope: 'events',
    limit: 123,
    page: 123,
    aggs: {},
    runtime_mappings: {},
    source: ['<string>'],
    sort: [{}],
    track_total_hits: true
  })
};

fetch('https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => [
        
    ],
    'scope' => 'events',
    'limit' => 123,
    'page' => 123,
    'aggs' => [
        
    ],
    'runtime_mappings' => [
        
    ],
    'source' => [
        '<string>'
    ],
    'sort' => [
        [
                
        ]
    ],
    'track_total_hits' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/search"

	payload := strings.NewReader("{\n  \"query\": {},\n  \"scope\": \"events\",\n  \"limit\": 123,\n  \"page\": 123,\n  \"aggs\": {},\n  \"runtime_mappings\": {},\n  \"source\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {}\n  ],\n  \"track_total_hits\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": {},\n  \"scope\": \"events\",\n  \"limit\": 123,\n  \"page\": 123,\n  \"aggs\": {},\n  \"runtime_mappings\": {},\n  \"source\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {}\n  ],\n  \"track_total_hits\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": {},\n  \"scope\": \"events\",\n  \"limit\": 123,\n  \"page\": 123,\n  \"aggs\": {},\n  \"runtime_mappings\": {},\n  \"source\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {}\n  ],\n  \"track_total_hits\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "size": 123,
  "documents": [
    {}
  ],
  "aggs": {}
}

{
  "error": "BadParameters",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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[]

track_total_hits · boolean

Get real total instead of 10000

Response

200

application/json

Success Response

size · number

documents · object[]

aggs · object