Sign in
Beta
Agent Data

Search Agent Data

Changed on

Search agent data with filtering, sorting, and pagination.

post/api/v1/beta/agent-data/:search

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

page_sizeinteger nullable

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_tokenstring nullable

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

filterobject nullable

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

order_bystring nullable

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

deployment_namestring required

The agent deployment's name to search within

collectionstring

The logical agent data collection to search within

include_totalboolean

Whether to include the total number of items in the response

offsetinteger nullable

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

Response

Successful Response

next_page_tokenstring nullable

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_sizeinteger nullable

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.

Changes

  • 7a98f91d4000Revision changes
    • ○

      added the optional property // to the response with the status

  • d8e4a921c2deRevision changes
    • ▲

      added the new required request property

    • ▲

      removed the required property // from the response with the status

    • ●

      removed the request property

    • ○

      added the required property // to the response with the status