API Reference

Aggregate Objects

POST/api/v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate

Perform functions on object fields in the specified ontology and object type.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.

Path parameters

ontologyRid

string

The unique Resource Identifier (RID) of the Ontology that contains the objects.

objectType

string

The type of the object to aggregate on.

Request body

AggregateObjectsRequest

object

Hide child attributes

aggregation

list<Aggregation>

optional

Show child attributes

Aggregation

union

Specifies an aggregation function.

Show child attributes

approximateDistinct

object

optional

Computes an approximate number of distinct values for the provided field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

name

string

optional

A user-specified alias for an aggregation metric name.

min

object

optional

Computes the minimum value for the provided field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

name

string

optional

A user-specified alias for an aggregation metric name.

avg

object

optional

Computes the average value for the provided field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

name

string

optional

A user-specified alias for an aggregation metric name.

max

object

optional

Computes the maximum value for the provided field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

name

string

optional

A user-specified alias for an aggregation metric name.

count

object

optional

Computes the total count of objects.

Show child attributes

name

string

optional

A user-specified alias for an aggregation metric name.

sum

object

optional

Computes the sum of values for the provided field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

name

string

optional

A user-specified alias for an aggregation metric name.

query

union

optional

Show child attributes

object

optional

Returns objects where at least 1 query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

Show child attributes

object

optional

Returns objects where at least 1 query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

prefix

object

optional

Returns objects where the specified field starts with the provided value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

object

optional

Returns objects where the specified field is less than a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

allTerms

object

optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

Setting fuzzy to true allows approximate matching in search queries that support it.

object

optional

Returns objects where the specified field is equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

object

optional

Returns objects where the specified field is greater than a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

contains

object

optional

Returns objects where the specified array contains a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not

object

optional

Returns objects where the query is not satisfied.

Show child attributes

value

union

phrase

object

optional

Returns objects where the specified field contains the provided value as a substring.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

and

object

optional

Returns objects where every query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

isNull

object

optional

Returns objects based on the existence of the specified field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

boolean

gte

object

optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

anyTerm

object

optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

Setting fuzzy to true allows approximate matching in search queries that support it.

lte

object

optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

prefix

object

optional

Returns objects where the specified field starts with the provided value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

object

optional

Returns objects where the specified field is less than a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

allTerms

object

optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

Setting fuzzy to true allows approximate matching in search queries that support it.

object

optional

Returns objects where the specified field is equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

object

optional

Returns objects where the specified field is greater than a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

contains

object

optional

Returns objects where the specified array contains a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not

object

optional

Returns objects where the query is not satisfied.

Show child attributes

value

union

Show child attributes

object

optional

Returns objects where at least 1 query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

prefix

object

optional

Returns objects where the specified field starts with the provided value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

object

optional

Returns objects where the specified field is less than a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

allTerms

object

optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

Setting fuzzy to true allows approximate matching in search queries that support it.

object

optional

Returns objects where the specified field is equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

object

optional

Returns objects where the specified field is greater than a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

contains

object

optional

Returns objects where the specified array contains a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not

object

optional

Returns objects where the query is not satisfied.

Show child attributes

value

union

phrase

object

optional

Returns objects where the specified field contains the provided value as a substring.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

and

object

optional

Returns objects where every query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

isNull

object

optional

Returns objects based on the existence of the specified field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

boolean

gte

object

optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

anyTerm

object

optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

Setting fuzzy to true allows approximate matching in search queries that support it.

lte

object

optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

phrase

object

optional

Returns objects where the specified field contains the provided value as a substring.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

and

object

optional

Returns objects where every query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

Show child attributes

object

optional

Returns objects where at least 1 query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

prefix

object

optional

Returns objects where the specified field starts with the provided value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

object

optional

Returns objects where the specified field is less than a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

allTerms

object

optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

Setting fuzzy to true allows approximate matching in search queries that support it.

object

optional

Returns objects where the specified field is equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

object

optional

Returns objects where the specified field is greater than a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

contains

object

optional

Returns objects where the specified array contains a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not

object

optional

Returns objects where the query is not satisfied.

Show child attributes

value

union

phrase

object

optional

Returns objects where the specified field contains the provided value as a substring.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

and

object

optional

Returns objects where every query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

isNull

object

optional

Returns objects based on the existence of the specified field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

boolean

gte

object

optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

anyTerm

object

optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

Setting fuzzy to true allows approximate matching in search queries that support it.

lte

object

optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

isNull

object

optional

Returns objects based on the existence of the specified field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

boolean

gte

object

optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

anyTerm

object

optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

Setting fuzzy to true allows approximate matching in search queries that support it.

lte

object

optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

groupBy

list<AggregationGroupBy>

optional

Show child attributes

AggregationGroupBy

union

Specifies a grouping for aggregation results.

Show child attributes

duration

object

optional

Divides objects into groups according to an interval. Note that this grouping applies only on date types. The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

duration

string

An ISO 8601 formatted duration.

fixedWidth

object

optional

Divides objects into groups with the specified width.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

fixedWidth

integer

ranges

object

optional

Divides objects into groups according to specified ranges.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

ranges

list<AggregationRange>

optional

Show child attributes

AggregationRange

object

Specifies a date range from an inclusive start date to an exclusive end date.

Show child attributes

any

optional

Exclusive end date.

lte

any

optional

Inclusive end date.

any

optional

Exclusive start date.

gte

any

optional

Inclusive start date.

exact

object

optional

Divides objects into groups according to an exact value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

maxGroupCount

integer

optional

Response body

AggregateObjectsResponse

object

Success response.

Hide child attributes

excludedItems

integer

optional

nextPageToken

string

optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

data

list<AggregateObjectsResponseItem>

optional

Show child attributes

AggregateObjectsResponseItem

object

Show child attributes

group

map<AggregationGroupKey, AggregationGroupValue>

optional

Show child attributes

AggregationGroupKey

string

AggregationGroupValue

any

metrics

list<AggregationMetricResult>

optional

Show child attributes

AggregationMetricResult

object

Show child attributes

name

string

value

number

optional

TBD

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objects/employee/aggregate" \
	-d '{"aggregation":[{"type":"min","field":"properties.tenure","name":"min_tenure"},{"type":"avg","field":"properties.tenure","name":"avg_tenure"}],"query":{"not":{"field":"properties.name","eq":"john"}},"groupBy":[{"field":"properties.startDate","type":"range","ranges":[{"gte":"2020-01-01","lt":"2020-06-01"}]},{"field":"properties.city","type":"exact"}]}'

Response

Copied!

{
  "data": [
    {
      "metrics": [
        {
          "name": "min_tenure",
          "value": 1
        },
        {
          "name": "avg_tenure",
          "value": 3
        }
      ],
      "group": {
        "properties.startDate": {
          "gte": "2020-01-01",
          "lt": "2020-06-01"
        },
        "properties.city": "New York City"
      }
    },
    {
      "metrics": [
        {
          "name": "min_tenure",
          "value": 2
        },
        {
          "name": "avg_tenure",
          "value": 3
        }
      ],
      "group": {
        "properties.startDate": {
          "gte": "2020-01-01",
          "lt": "2020-06-01"
        },
        "properties.city": "San Francisco"
      }
    }
  ]
}