Home
/
API reference
/
API documentation (JSON/XML)
/
Objects
/
General objects

View object

API reference (XML/JSON) · Updated 2023-10-25

Description

The view object is responsible for determining the range of the search result.

Structure

Key JSON	Key XML	Occurs	Type	Format	Description
-	offset	0 - 1	string		Defines the starting position of the returned result.
children	children	0 - 1	boolean		Query subusers false = Subusers are not queried true = Subusers are queried Default value = false For XML, 0 (false) and 1 (true) can also be used.
limit	limit	0 - 1	string		Maximum number of objects to be displayed.
from	to	0 - 1	string	date-time	End Date - Required for Historical Task. e.g. 2021-01-01 00:00:00
to	to	0 - 1	string	date-time	Start Date - Required for Historical Task. 2022-01-01 00:00:00

XML Example

"view": {
	 "children": true,
	 "limit": 10,
	 "offset": 0,
     "from": "2022-01-01 00:00:00",
	 "to": "2021-01-01 00:00:00"
}

<view>
    <limit>10</limit>
    <offset>0</offset>
    <children>0</children>
	<from>2022-01-01 00:00:00</from>
	<to>2021-01-01 00:00:00</to>
</view>