curl --request POST \
--url https://api-external.ezyid.io/api/assets/query \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"logic": "and",
"clauses": [
{
"fieldId": "siteName",
"operator": "contains",
"value": "Warehouse"
},
{
"fieldId": "assetStatusId",
"operator": "in",
"value": [
1,
2
]
},
{
"fieldId": "serialNumber",
"operator": "isNotEmpty"
}
]
},
"timeRange": {
"preset": "last30Days"
},
"sort": [
{
"fieldId": "createdOn",
"direction": "desc"
}
],
"fields": [
"id",
"assetName",
"ezyid",
"siteName",
"createdOn"
],
"start": 0,
"rows": 50
}
'import requests
url = "https://api-external.ezyid.io/api/assets/query"
payload = {
"filters": {
"logic": "and",
"clauses": [
{
"fieldId": "siteName",
"operator": "contains",
"value": "Warehouse"
},
{
"fieldId": "assetStatusId",
"operator": "in",
"value": [1, 2]
},
{
"fieldId": "serialNumber",
"operator": "isNotEmpty"
}
]
},
"timeRange": { "preset": "last30Days" },
"sort": [
{
"fieldId": "createdOn",
"direction": "desc"
}
],
"fields": ["id", "assetName", "ezyid", "siteName", "createdOn"],
"start": 0,
"rows": 50
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
logic: 'and',
clauses: [
{fieldId: 'siteName', operator: 'contains', value: 'Warehouse'},
{fieldId: 'assetStatusId', operator: 'in', value: [1, 2]},
{fieldId: 'serialNumber', operator: 'isNotEmpty'}
]
},
timeRange: {preset: 'last30Days'},
sort: [{fieldId: 'createdOn', direction: 'desc'}],
fields: ['id', 'assetName', 'ezyid', 'siteName', 'createdOn'],
start: 0,
rows: 50
})
};
fetch('https://api-external.ezyid.io/api/assets/query', 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-external.ezyid.io/api/assets/query",
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([
'filters' => [
'logic' => 'and',
'clauses' => [
[
'fieldId' => 'siteName',
'operator' => 'contains',
'value' => 'Warehouse'
],
[
'fieldId' => 'assetStatusId',
'operator' => 'in',
'value' => [
1,
2
]
],
[
'fieldId' => 'serialNumber',
'operator' => 'isNotEmpty'
]
]
],
'timeRange' => [
'preset' => 'last30Days'
],
'sort' => [
[
'fieldId' => 'createdOn',
'direction' => 'desc'
]
],
'fields' => [
'id',
'assetName',
'ezyid',
'siteName',
'createdOn'
],
'start' => 0,
'rows' => 50
]),
CURLOPT_HTTPHEADER => [
"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-external.ezyid.io/api/assets/query"
payload := strings.NewReader("{\n \"filters\": {\n \"logic\": \"and\",\n \"clauses\": [\n {\n \"fieldId\": \"siteName\",\n \"operator\": \"contains\",\n \"value\": \"Warehouse\"\n },\n {\n \"fieldId\": \"assetStatusId\",\n \"operator\": \"in\",\n \"value\": [\n 1,\n 2\n ]\n },\n {\n \"fieldId\": \"serialNumber\",\n \"operator\": \"isNotEmpty\"\n }\n ]\n },\n \"timeRange\": {\n \"preset\": \"last30Days\"\n },\n \"sort\": [\n {\n \"fieldId\": \"createdOn\",\n \"direction\": \"desc\"\n }\n ],\n \"fields\": [\n \"id\",\n \"assetName\",\n \"ezyid\",\n \"siteName\",\n \"createdOn\"\n ],\n \"start\": 0,\n \"rows\": 50\n}")
req, _ := http.NewRequest("POST", url, payload)
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-external.ezyid.io/api/assets/query")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"logic\": \"and\",\n \"clauses\": [\n {\n \"fieldId\": \"siteName\",\n \"operator\": \"contains\",\n \"value\": \"Warehouse\"\n },\n {\n \"fieldId\": \"assetStatusId\",\n \"operator\": \"in\",\n \"value\": [\n 1,\n 2\n ]\n },\n {\n \"fieldId\": \"serialNumber\",\n \"operator\": \"isNotEmpty\"\n }\n ]\n },\n \"timeRange\": {\n \"preset\": \"last30Days\"\n },\n \"sort\": [\n {\n \"fieldId\": \"createdOn\",\n \"direction\": \"desc\"\n }\n ],\n \"fields\": [\n \"id\",\n \"assetName\",\n \"ezyid\",\n \"siteName\",\n \"createdOn\"\n ],\n \"start\": 0,\n \"rows\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-external.ezyid.io/api/assets/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"logic\": \"and\",\n \"clauses\": [\n {\n \"fieldId\": \"siteName\",\n \"operator\": \"contains\",\n \"value\": \"Warehouse\"\n },\n {\n \"fieldId\": \"assetStatusId\",\n \"operator\": \"in\",\n \"value\": [\n 1,\n 2\n ]\n },\n {\n \"fieldId\": \"serialNumber\",\n \"operator\": \"isNotEmpty\"\n }\n ]\n },\n \"timeRange\": {\n \"preset\": \"last30Days\"\n },\n \"sort\": [\n {\n \"fieldId\": \"createdOn\",\n \"direction\": \"desc\"\n }\n ],\n \"fields\": [\n \"id\",\n \"assetName\",\n \"ezyid\",\n \"siteName\",\n \"createdOn\"\n ],\n \"start\": 0,\n \"rows\": 50\n}"
response = http.request(request)
puts response.read_body{
"count": 123,
"start": 123,
"rows": 123,
"items": [
{}
]
}{
"error": "<string>"
}Query Assets
Retrieve a list of assets matching a dynamic filter.
curl --request POST \
--url https://api-external.ezyid.io/api/assets/query \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"logic": "and",
"clauses": [
{
"fieldId": "siteName",
"operator": "contains",
"value": "Warehouse"
},
{
"fieldId": "assetStatusId",
"operator": "in",
"value": [
1,
2
]
},
{
"fieldId": "serialNumber",
"operator": "isNotEmpty"
}
]
},
"timeRange": {
"preset": "last30Days"
},
"sort": [
{
"fieldId": "createdOn",
"direction": "desc"
}
],
"fields": [
"id",
"assetName",
"ezyid",
"siteName",
"createdOn"
],
"start": 0,
"rows": 50
}
'import requests
url = "https://api-external.ezyid.io/api/assets/query"
payload = {
"filters": {
"logic": "and",
"clauses": [
{
"fieldId": "siteName",
"operator": "contains",
"value": "Warehouse"
},
{
"fieldId": "assetStatusId",
"operator": "in",
"value": [1, 2]
},
{
"fieldId": "serialNumber",
"operator": "isNotEmpty"
}
]
},
"timeRange": { "preset": "last30Days" },
"sort": [
{
"fieldId": "createdOn",
"direction": "desc"
}
],
"fields": ["id", "assetName", "ezyid", "siteName", "createdOn"],
"start": 0,
"rows": 50
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
logic: 'and',
clauses: [
{fieldId: 'siteName', operator: 'contains', value: 'Warehouse'},
{fieldId: 'assetStatusId', operator: 'in', value: [1, 2]},
{fieldId: 'serialNumber', operator: 'isNotEmpty'}
]
},
timeRange: {preset: 'last30Days'},
sort: [{fieldId: 'createdOn', direction: 'desc'}],
fields: ['id', 'assetName', 'ezyid', 'siteName', 'createdOn'],
start: 0,
rows: 50
})
};
fetch('https://api-external.ezyid.io/api/assets/query', 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-external.ezyid.io/api/assets/query",
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([
'filters' => [
'logic' => 'and',
'clauses' => [
[
'fieldId' => 'siteName',
'operator' => 'contains',
'value' => 'Warehouse'
],
[
'fieldId' => 'assetStatusId',
'operator' => 'in',
'value' => [
1,
2
]
],
[
'fieldId' => 'serialNumber',
'operator' => 'isNotEmpty'
]
]
],
'timeRange' => [
'preset' => 'last30Days'
],
'sort' => [
[
'fieldId' => 'createdOn',
'direction' => 'desc'
]
],
'fields' => [
'id',
'assetName',
'ezyid',
'siteName',
'createdOn'
],
'start' => 0,
'rows' => 50
]),
CURLOPT_HTTPHEADER => [
"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-external.ezyid.io/api/assets/query"
payload := strings.NewReader("{\n \"filters\": {\n \"logic\": \"and\",\n \"clauses\": [\n {\n \"fieldId\": \"siteName\",\n \"operator\": \"contains\",\n \"value\": \"Warehouse\"\n },\n {\n \"fieldId\": \"assetStatusId\",\n \"operator\": \"in\",\n \"value\": [\n 1,\n 2\n ]\n },\n {\n \"fieldId\": \"serialNumber\",\n \"operator\": \"isNotEmpty\"\n }\n ]\n },\n \"timeRange\": {\n \"preset\": \"last30Days\"\n },\n \"sort\": [\n {\n \"fieldId\": \"createdOn\",\n \"direction\": \"desc\"\n }\n ],\n \"fields\": [\n \"id\",\n \"assetName\",\n \"ezyid\",\n \"siteName\",\n \"createdOn\"\n ],\n \"start\": 0,\n \"rows\": 50\n}")
req, _ := http.NewRequest("POST", url, payload)
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-external.ezyid.io/api/assets/query")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"logic\": \"and\",\n \"clauses\": [\n {\n \"fieldId\": \"siteName\",\n \"operator\": \"contains\",\n \"value\": \"Warehouse\"\n },\n {\n \"fieldId\": \"assetStatusId\",\n \"operator\": \"in\",\n \"value\": [\n 1,\n 2\n ]\n },\n {\n \"fieldId\": \"serialNumber\",\n \"operator\": \"isNotEmpty\"\n }\n ]\n },\n \"timeRange\": {\n \"preset\": \"last30Days\"\n },\n \"sort\": [\n {\n \"fieldId\": \"createdOn\",\n \"direction\": \"desc\"\n }\n ],\n \"fields\": [\n \"id\",\n \"assetName\",\n \"ezyid\",\n \"siteName\",\n \"createdOn\"\n ],\n \"start\": 0,\n \"rows\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-external.ezyid.io/api/assets/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"logic\": \"and\",\n \"clauses\": [\n {\n \"fieldId\": \"siteName\",\n \"operator\": \"contains\",\n \"value\": \"Warehouse\"\n },\n {\n \"fieldId\": \"assetStatusId\",\n \"operator\": \"in\",\n \"value\": [\n 1,\n 2\n ]\n },\n {\n \"fieldId\": \"serialNumber\",\n \"operator\": \"isNotEmpty\"\n }\n ]\n },\n \"timeRange\": {\n \"preset\": \"last30Days\"\n },\n \"sort\": [\n {\n \"fieldId\": \"createdOn\",\n \"direction\": \"desc\"\n }\n ],\n \"fields\": [\n \"id\",\n \"assetName\",\n \"ezyid\",\n \"siteName\",\n \"createdOn\"\n ],\n \"start\": 0,\n \"rows\": 50\n}"
response = http.request(request)
puts response.read_body{
"count": 123,
"start": 123,
"rows": 123,
"items": [
{}
]
}{
"error": "<string>"
}Query Parameters
Body
Every part is optional. An empty object returns the first page of the subscriber's assets.
Which rows to match, how to sort them, which fields to return and which page to read.
A set of clauses and nested groups joined by one operator. Groups may nest two levels deep and carry at most 20 clauses in total.
Show child attributes
Show child attributes
Shorthand window over the dataset's defaultDateFieldId. Supply either a preset or both from and to, never both. Windows are half-open in UTC: from is included, to is not.
Show child attributes
Show child attributes
At most two rules. The dataset's unique key always breaks ties, so paging is stable.
Show child attributes
Show child attributes
Field ids to return. Omit for every field in the dataset's catalog.
Rows to skip. Defaults to 0.
Page size, between 1 and 1000. Defaults to 100.
