API Reference

Beta

Agent Data

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Aggregate Agent Data

POST/api/v1/beta/agent-data/:aggregate

Aggregate agent data with grouping and optional counting/first item retrieval.

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

Body ParametersJSONExpand Collapse

deployment_name: string

The agent deployment’s name to aggregate data for

collection: optional string

The logical agent data collection to aggregate data for

count: optional boolean

Whether to count the number of items in each group

filter: optional map[object { eq, excludes, gt, 5 more } ]

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

eq: optional number or string or string

One of the following:

number

string

string

excludes: optional array of number or string or string

One of the following:

number

string

string

gt: optional number or string or string

One of the following:

number

string

string

gte: optional number or string or string

One of the following:

number

string

string

includes: optional array of number or string or string

One of the following:

number

string

string

lt: optional number or string or string

One of the following:

number

string

string

lte: optional number or string or string

One of the following:

number

string

string

ne: optional number or string or string

One of the following:

number

string

string

first: optional boolean

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

group_by: optional array of string

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

offset: optional number

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

maximum1000

minimum0

order_by: optional string

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

page_size: optional number

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 string

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

ReturnsExpand Collapse

items: array of object { group_key, count, first_item }

The list of items.

group_key: map[unknown]

count: optional number

first_item: optional map[unknown]

next_page_token: optional string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: optional number

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Aggregate Agent Data

HTTP

HTTP

TypeScript

Python

Java

Go

CLI Tool

curl https://api.cloud.llamaindex.ai/api/v1/beta/agent-data/:aggregate \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
    -d '{
          "deployment_name": "deployment_name"
        }'

200 example

{
  "items": [
    {
      "group_key": {
        "foo": "bar"
      },
      "count": 0,
      "first_item": {
        "foo": "bar"
      }
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "group_key": {
        "foo": "bar"
      },
      "count": 0,
      "first_item": {
        "foo": "bar"
      }
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}