Filter agent history

Filter agent history. See the OpenAPI-defined parameters, request body, and responses below.

POST /AgentHistory/filter

Filter agent history. See the OpenAPI-defined parameters, request body, and responses below.

OpenAPI description: Este endpoint permite filtrar o histórico por agente (obrigatório), usuário, tipo de ação e período. Suporta paginação.

Authentication

Authentication required. Send your user API key in the X-API-Key header.

Parameters

This operation has no path, query, or header parameters.

Request body

Content type: application/json · Schema: AgentHistoryFilterDto

PropertyTypeRequiredDescriptionConstraints
agentIdinteger · int32Yes——
userIdinteger · int32No—nullable
actionTypeAgentHistoryActionTypeNo——
createdAtStartstring · date-timeNo—nullable
createdAtEndstring · date-timeNo—nullable
pageinteger · int32No——
pageSizeinteger · int32No——

Example request

curl --request POST \
  --url 'https://api.zild.ai/AgentHistory/filter' \
  --header 'X-API-Key: YOUR_USER_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "agentId": 0,
  "userId": 0,
  "actionType": 0,
  "createdAtStart": "2026-09-22T18:00:00Z",
  "createdAtEnd": "2026-09-22T18:00:00Z",
  "page": 0,
  "pageSize": 0
}'

Responses

StatusDescriptionResponse body
200Sucesso ao retornar o histórico filtradoapplication/json · AgentHistoryPagedResultDto
400AgentId é obrigatórioNo response body is defined.

Example response (200):

{
  "items": [
    {
      "id": 0,
      "agentId": 0,
      "agentName": "string",
      "userId": 0,
      "userName": "string",
      "userEmail": "string",
      "actionType": 0,
      "actionTypeDescription": "string",
      "description": "string",
      "previousState": "string",
      "newState": "string",
      "changedFields": "string",
      "createdAt": "2026-09-22T18:00:00Z",
      "version": 0
    }
  ],
  "totalCount": 0,
  "page": 0,
  "pageSize": 0,
  "totalPages": 0,
  "hasNextPage": true,
  "hasPreviousPage": true
}

Data models

AgentHistoryActionType

0 = Created; 1 = Updated; 2 = Deleted; 3 = FileAdded; 4 = FileRemoved; 5 = DynamicVariableAdded; 6 = DynamicVariableUpdated; 7 = DynamicVariableRemoved; 8 = DataCollectionAdded; 9 = DataCollectionUpdated; 10 = DataCollectionRemoved; 11 = ToolAdded; 12 = ToolUpdated; 13 = ToolRemoved; 14 = TaskAdded; 15 = TaskUpdated; 16 = TaskRemoved; 17 = PermissionChanged

integer

AgentHistoryDto
PropertyTypeRequiredDescriptionConstraints
idinteger · int32No——
agentIdinteger · int32No——
agentNamestringNo—nullable
userIdinteger · int32No——
userNamestringNo—nullable
userEmailstringNo—nullable
actionTypeAgentHistoryActionTypeNo——
actionTypeDescriptionstringNo—nullable
descriptionstringNo—nullable
previousStatestringNo—nullable
newStatestringNo—nullable
changedFieldsstringNo—nullable
createdAtstring · date-timeNo——
versioninteger · int32No——
AgentHistoryFilterDto
PropertyTypeRequiredDescriptionConstraints
agentIdinteger · int32Yes——
userIdinteger · int32No—nullable
actionTypeAgentHistoryActionTypeNo——
createdAtStartstring · date-timeNo—nullable
createdAtEndstring · date-timeNo—nullable
pageinteger · int32No——
pageSizeinteger · int32No——
AgentHistoryPagedResultDto
PropertyTypeRequiredDescriptionConstraints
itemsarray<AgentHistoryDto>No—nullable
totalCountinteger · int32No——
pageinteger · int32No——
pageSizeinteger · int32No——
totalPagesinteger · int32No——
hasNextPagebooleanNo——
hasPreviousPagebooleanNo——