SearchRequest-1

SearchRequest = object

Defined in: packages/cloud/src/client/types.gen.ts:7719

API request body for searching agent data

Properties

page_size?

optional page_size: number | null

Defined in: packages/cloud/src/client/types.gen.ts:7723

The maximum number of items to return. The service may return fewer than this value. If unspecified, a default page size will be used. The maximum value is typically 1000; values above this will be coerced to the maximum.

---

page_token?

optional page_token: string | null

Defined in: packages/cloud/src/client/types.gen.ts:7727

A page token, received from a previous list call. Provide this to retrieve the subsequent page.

---

filter?

optional filter: {[key: string]: FilterOperation; } | null

Defined in: packages/cloud/src/client/types.gen.ts:7731

A filter object or expression that filters resources listed in the response.

---

order_by?

optional order_by: string | null

Defined in: packages/cloud/src/client/types.gen.ts:7737

A comma-separated list of fields to order by, sorted in ascending order. Use 'field_name desc' to specify descending order.

---

agent_slug

agent_slug: string

Defined in: packages/cloud/src/client/types.gen.ts:7741

The agent deployment's agent_slug to search within

---

collection?

optional collection: string

Defined in: packages/cloud/src/client/types.gen.ts:7745

The logical agent data collection to search within

---

include_total?

optional include_total: boolean

Defined in: packages/cloud/src/client/types.gen.ts:7749

Whether to include the total number of items in the response

---

offset?

optional offset: number | null

Defined in: packages/cloud/src/client/types.gen.ts:7753

The offset to start from. If not provided, the first page is returned