const events = await client.events.search({
filter: {
assetIds: [1, 2]
},
search: {
description: 'Pump'
}
});res = client.events.search(description="some description")curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"startTime": {
"max": 1,
"min": 1
},
"endTime": {
"max": 1,
"min": 1
},
"activeAtTime": {
"max": 1,
"min": 1
},
"metadata": {},
"assetIds": [
4503599627370496
],
"assetExternalIds": [
"my.known.id"
],
"assetSubtreeIds": [
{
"id": 4503599627370496
}
],
"dataSetIds": [
{
"id": 4503599627370496
}
],
"source": "<string>",
"type": "<string>",
"subtype": "<string>",
"createdTime": {
"max": 1,
"min": 1
},
"lastUpdatedTime": {
"max": 1,
"min": 1
},
"externalIdPrefix": "my.known.prefix"
},
"search": {
"description": "<string>"
},
"limit": 100
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/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([
'filter' => [
'startTime' => [
'max' => 1,
'min' => 1
],
'endTime' => [
'max' => 1,
'min' => 1
],
'activeAtTime' => [
'max' => 1,
'min' => 1
],
'metadata' => [
],
'assetIds' => [
4503599627370496
],
'assetExternalIds' => [
'my.known.id'
],
'assetSubtreeIds' => [
[
'id' => 4503599627370496
]
],
'dataSetIds' => [
[
'id' => 4503599627370496
]
],
'source' => '<string>',
'type' => '<string>',
'subtype' => '<string>',
'createdTime' => [
'max' => 1,
'min' => 1
],
'lastUpdatedTime' => [
'max' => 1,
'min' => 1
],
'externalIdPrefix' => 'my.known.prefix'
],
'search' => [
'description' => '<string>'
],
'limit' => 100
]),
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://{cluster}.cognitedata.com/api/v1/projects/{project}/events/search"
payload := strings.NewReader("{\n \"filter\": {\n \"startTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"endTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"activeAtTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"metadata\": {},\n \"assetIds\": [\n 4503599627370496\n ],\n \"assetExternalIds\": [\n \"my.known.id\"\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"source\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\"\n },\n \"search\": {\n \"description\": \"<string>\"\n },\n \"limit\": 100\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://{cluster}.cognitedata.com/api/v1/projects/{project}/events/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"startTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"endTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"activeAtTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"metadata\": {},\n \"assetIds\": [\n 4503599627370496\n ],\n \"assetExternalIds\": [\n \"my.known.id\"\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"source\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\"\n },\n \"search\": {\n \"description\": \"<string>\"\n },\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/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 \"filter\": {\n \"startTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"endTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"activeAtTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"metadata\": {},\n \"assetIds\": [\n 4503599627370496\n ],\n \"assetExternalIds\": [\n \"my.known.id\"\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"source\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\"\n },\n \"search\": {\n \"description\": \"<string>\"\n },\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 4503599627370496,
"lastUpdatedTime": 1730204346000,
"createdTime": 1730204346000,
"externalId": "my.known.id",
"dataSetId": 4503599627370496,
"startTime": 1730204346000,
"endTime": 1730204346000,
"type": "<string>",
"subtype": "<string>",
"description": "<string>",
"metadata": {},
"assetIds": [
4503599627370496
],
"source": "<string>"
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 429,
"message": "Project exceeded maximum number='50' of concurrent requests. Please try again later."
}
}Required capabilities:
eventsAcl:READ
Fulltext search for events based on result relevance. Primarily meant for human-centric use-cases, not for programs, since matching and ordering may change over time. Additional filters can also be specified. This operation doesn’t support pagination.
Request throttling
This endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage. It is a subject of the new throttling schema (limited request rate and concurrency). Please check Events resource description for more information.
const events = await client.events.search({
filter: {
assetIds: [1, 2]
},
search: {
description: 'Pump'
}
});res = client.events.search(description="some description")curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"startTime": {
"max": 1,
"min": 1
},
"endTime": {
"max": 1,
"min": 1
},
"activeAtTime": {
"max": 1,
"min": 1
},
"metadata": {},
"assetIds": [
4503599627370496
],
"assetExternalIds": [
"my.known.id"
],
"assetSubtreeIds": [
{
"id": 4503599627370496
}
],
"dataSetIds": [
{
"id": 4503599627370496
}
],
"source": "<string>",
"type": "<string>",
"subtype": "<string>",
"createdTime": {
"max": 1,
"min": 1
},
"lastUpdatedTime": {
"max": 1,
"min": 1
},
"externalIdPrefix": "my.known.prefix"
},
"search": {
"description": "<string>"
},
"limit": 100
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/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([
'filter' => [
'startTime' => [
'max' => 1,
'min' => 1
],
'endTime' => [
'max' => 1,
'min' => 1
],
'activeAtTime' => [
'max' => 1,
'min' => 1
],
'metadata' => [
],
'assetIds' => [
4503599627370496
],
'assetExternalIds' => [
'my.known.id'
],
'assetSubtreeIds' => [
[
'id' => 4503599627370496
]
],
'dataSetIds' => [
[
'id' => 4503599627370496
]
],
'source' => '<string>',
'type' => '<string>',
'subtype' => '<string>',
'createdTime' => [
'max' => 1,
'min' => 1
],
'lastUpdatedTime' => [
'max' => 1,
'min' => 1
],
'externalIdPrefix' => 'my.known.prefix'
],
'search' => [
'description' => '<string>'
],
'limit' => 100
]),
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://{cluster}.cognitedata.com/api/v1/projects/{project}/events/search"
payload := strings.NewReader("{\n \"filter\": {\n \"startTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"endTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"activeAtTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"metadata\": {},\n \"assetIds\": [\n 4503599627370496\n ],\n \"assetExternalIds\": [\n \"my.known.id\"\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"source\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\"\n },\n \"search\": {\n \"description\": \"<string>\"\n },\n \"limit\": 100\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://{cluster}.cognitedata.com/api/v1/projects/{project}/events/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"startTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"endTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"activeAtTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"metadata\": {},\n \"assetIds\": [\n 4503599627370496\n ],\n \"assetExternalIds\": [\n \"my.known.id\"\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"source\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\"\n },\n \"search\": {\n \"description\": \"<string>\"\n },\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/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 \"filter\": {\n \"startTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"endTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"activeAtTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"metadata\": {},\n \"assetIds\": [\n 4503599627370496\n ],\n \"assetExternalIds\": [\n \"my.known.id\"\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"source\": \"<string>\",\n \"type\": \"<string>\",\n \"subtype\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\"\n },\n \"search\": {\n \"description\": \"<string>\"\n },\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 4503599627370496,
"lastUpdatedTime": 1730204346000,
"createdTime": 1730204346000,
"externalId": "my.known.id",
"dataSetId": 4503599627370496,
"startTime": 1730204346000,
"endTime": 1730204346000,
"type": "<string>",
"subtype": "<string>",
"description": "<string>",
"metadata": {},
"assetIds": [
4503599627370496
],
"source": "<string>"
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 429,
"message": "Project exceeded maximum number='50' of concurrent requests. Please try again later."
}
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
Filter on events filter with exact match
Response
Paged response with list of events
Show child attributes
Show child attributes
Was this page helpful?