Objects - Charter Docs

Model tree

SearchBody

The body of a search request.

Field	Type	Description
`query`	`string`	The text to match against page and data source titles. Omit it to list everything the integration can see.
`filter`	SearchFilter	Restrict the results to pages or to data sources.
`sort`	SearchSort	How to order the results.
`startCursor`	`string`	A `next_cursor` from a previous response.
`pageSize`	`integer`	How many results to return. Maximum 100. ≥ 1; ≤ 100

Which kinds of object a search returns.

Field	Type	Description
`property`	`string`	Always `object`. Required alongside `value`.
`value`	`"page" \| "data_source"`	Whether to return only pages or only data sources.
`inTrash`	`boolean`	Whether to search the trash instead of live content.

SearchSort

How to order search results.

Field	Type	Description
`timestamp`	`string`	Sort by when the result was last edited.
`direction`	`"ascending" \| "descending"`	The sort order. Required alongside `timestamp`.
`property`	`string`	Sort by how well the result matches the query.