AggregateRequest

AggregateRequest = object

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

API request body for aggregating agent data

Properties

page_size?

optional page_size: number | null

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

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:163

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:167

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:173

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:177

The agent deployment's agent_slug to aggregate data for

---

collection?

optional collection: string

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

The logical agent data collection to aggregate data for

---

group_by?

optional group_by: string[] | null

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

The fields to group by. If empty, the entire dataset is grouped on. e.g. if left out, can be used for simple count operations

---

count?

optional count: boolean | null

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

Whether to count the number of items in each group

---

first?

optional first: boolean | null

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

Whether to return the first item in each group (Sorted by created_at)

---

offset?

optional offset: number | null

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

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