Skip to content
API Reference
/
/
sessions

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

listToolTypes

[String!]!,non-null

Return type

[String!]!

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Query sample
query listToolTypes {
  listToolTypes 
}
Response sample
{
  "data": [
    "Example String"
  ]
}

topToolByExternalType

(...args)
[ToolExternalTypeCount!]!,non-null

Arguments

limit
Int
before
DateTime
after
DateTime

Return type

[ToolExternalTypeCount!]!
type
String!,non-null
count
Int!,non-null
Query sample
query topToolByExternalType(
  $limit: Int
  $before: DateTime
  $after: DateTime
) {
  topToolByExternalType(
    limit: $limit
    before: $before
    after: $after
  ) {
    type 
    count 
  }
}
Variables
{
  "limit": 40,
  "before": "Example Custom Scalar",
  "after": "Example Custom Scalar"
}
Response sample
{
  "data": [
    {
      "type": "Example String",
      "count": 40
    }
  ]
}

listDataSourceTypes

[String!]!,non-null

Return type

[String!]!

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Query sample
query listDataSourceTypes {
  listDataSourceTypes 
}
Response sample
{
  "data": [
    "Example String"
  ]
}

listChannelTypes

[String!]!,non-null

Return type

[String!]!

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Query sample
query listChannelTypes {
  listChannelTypes 
}
Response sample
{
  "data": [
    "Example String"
  ]
}

sessionActivities

(sessionId)
[SessionSubActivity!]!,non-null

Arguments

sessionId
ID!,non-nullrequired

Return type

[SessionSubActivity!]!
PolicyEvaluatedActivity
UserMessageActivity
AgentMessageActivity
AgentReasoningActivity
ToolCallActivity
ErrorActivity
SessionStartedActivity
DataSourceAccessActivity
AccessChannelActivity
Query sample
query sessionActivities($sessionId: ID!) {
  sessionActivities(sessionId: $sessionId) {
    id 
    type 
    timestamp 
    agent {
      __typename
      # ...AgentFragment
    }
    message 
    policy {
      __typename
      # ...PolicyFragment
    }
    issue {
      __typename
      # ...IssueFragment
    }
  }
}
Variables
{
  "sessionId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": [
    {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "type": "SESSION",
      "timestamp": "Example Custom Scalar",
      "agent": {
        "__typename": "Agent"
      },
      "message": "Example String",
      "policy": {
        "__typename": "Policy"
      },
      "issue": {
        "__typename": "Issue"
      }
    }
  ]
}

sessions

(...args)
[Session!]!,non-null

Arguments

filter
SessionFilter
orderBy
[SessionOrderByInput!],non-null
limit
Int
Default:100
offset
Int
Default:0

Return type

[Session!]!
type
ActivityType!,non-null
timestamp
DateTime!,non-null
agent
Agent!,non-null
message
String
sessionId
ID!,non-null
detections
[Detection!]!,non-null

Detections that were created as part of the session

violations
[ViolationPreview!]!,non-null

Violations that were created as part of the session.

Query sample
query sessions(
  $filter: SessionFilter
  $orderBy: [SessionOrderByInput!]
  $limit: Int
  $offset: Int
) {
  sessions(
    filter: $filter
    orderBy: $orderBy
    limit: $limit
    offset: $offset
  ) {
    type 
    timestamp 
    agent {
      __typename
      # ...AgentFragment
    }
    message 
    sessionId 
    detections {
      __typename
      # ...DetectionFragment
    }
    violations {
      __typename
      # ...ViolationPreviewFragment
    }
  }
}
Variables
{
  "filter": {
    "sessionId": {
      "__typename": "StringFilter"
    },
    "activityType": {
      "__typename": "ActivityTypeFilter"
    },
    "dateRange": {
      "__typename": "DateTimeFilter"
    },
    "agent": {
      "__typename": "AgentReferenceFilter"
    },
    "search": "Example String",
    "findingType": {
      "__typename": "FindingTypeFilter"
    },
    "issue": {
      "__typename": "IssueReferenceFilter"
    },
    "detections": {
      "__typename": "DetectionFilter"
    },
    "tool": {
      "__typename": "ToolReferenceFilter"
    },
    "dataSource": {
      "__typename": "DataSourceReferenceFilter"
    },
    "accessChannel": {
      "__typename": "AccessChannelReferenceFilter"
    }
  },
  "orderBy": [
    {
      "field": "TIMESTAMP",
      "direction": "ASC"
    }
  ],
  "limit": 40,
  "offset": 40
}
Response sample
{
  "data": [
    {
      "type": "SESSION",
      "timestamp": "Example Custom Scalar",
      "agent": {
        "__typename": "Agent"
      },
      "message": "Example String",
      "sessionId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "detections": [
        {
          "__typename": "Detection"
        }
      ],
      "violations": [
        {
          "__typename": "ViolationPreview"
        }
      ]
    }
  ]
}

sessionsCount

(filter)
Int!,non-null

Arguments

filter
SessionFilter

Return type

Int!

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Query sample
query sessionsCount($filter: SessionFilter) {
  sessionsCount(filter: $filter) 
}
Variables
{
  "filter": {
    "sessionId": {
      "__typename": "StringFilter"
    },
    "activityType": {
      "__typename": "ActivityTypeFilter"
    },
    "dateRange": {
      "__typename": "DateTimeFilter"
    },
    "agent": {
      "__typename": "AgentReferenceFilter"
    },
    "search": "Example String",
    "findingType": {
      "__typename": "FindingTypeFilter"
    },
    "issue": {
      "__typename": "IssueReferenceFilter"
    },
    "detections": {
      "__typename": "DetectionFilter"
    },
    "tool": {
      "__typename": "ToolReferenceFilter"
    },
    "dataSource": {
      "__typename": "DataSourceReferenceFilter"
    },
    "accessChannel": {
      "__typename": "AccessChannelReferenceFilter"
    }
  }
}
Response sample
{
  "data": 40
}

activitiesTimelineChart

(input)
ActivitiesTimelineChartResponse!,non-null

Arguments

input
TimelineQueryInput!,non-nullrequired

Return type

ActivitiesTimelineChartResponse!
metadata
TimelineQueryMetadata!,non-null
bins
[ActivitiesTimelineBin!]!,non-null
totalActivities
Int!,non-null
totalIndicators
Int!,non-null
Query sample
query activitiesTimelineChart($input: TimelineQueryInput!) {
  activitiesTimelineChart(input: $input) {
    metadata {
      __typename
      # ...TimelineQueryMetadataFragment
    }
    bins {
      __typename
      # ...ActivitiesTimelineBinFragment
    }
    totalActivities 
    totalIndicators 
  }
}
Variables
{
  "input": {
    "timeRange": {
      "__typename": "DateTimeFilter"
    },
    "binCount": 40,
    "timezone": "Example String",
    "filters": {
      "__typename": "SessionFilter"
    }
  }
}
Response sample
{
  "data": {
    "metadata": {
      "__typename": "TimelineQueryMetadata"
    },
    "bins": [
      {
        "__typename": "ActivitiesTimelineBin"
      }
    ],
    "totalActivities": 40,
    "totalIndicators": 40
  }
}

detections

(...args)
DetectionsResponse!,non-null

Arguments

limit
Int
Default:100
offset
Int
Default:0

Return type

DetectionsResponse!
items
[Detection!]!,non-null
total
Int!,non-null
Query sample
query detections($limit: Int, $offset: Int) {
  detections(limit: $limit, offset: $offset) {
    items {
      __typename
      # ...DetectionFragment
    }
    total 
  }
}
Variables
{
  "limit": 40,
  "offset": 40
}
Response sample
{
  "data": {
    "items": [
      {
        "__typename": "Detection"
      }
    ],
    "total": 40
  }
}

detection

(id)
Detection

Arguments

id
ID!,non-nullrequired

Return type

Detection
id
ID!,non-null
title
String!,non-null
type
DetectionType!,non-null
detectedAt
DateTime!,non-null
issue
Issue
session
Session
activities
[AuditEvent!]!,non-nulldeprecated
Deprecation reason

Use 'messages' field instead for typed message access

agent
Agent!,non-null
description
String
Query sample
query detection($id: ID!) {
  detection(id: $id) {
    id 
    title 
    type 
    detectedAt 
    issue {
      __typename
      # ...IssueFragment
    }
    session {
      __typename
      # ...SessionFragment
    }
    activities {
      __typename
      # ...AuditEventFragment
    }
    agent {
      __typename
      # ...AgentFragment
    }
    description 
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "title": "Example String",
    "type": "PII_LEAKAGE",
    "detectedAt": "Example Custom Scalar",
    "issue": {
      "__typename": "Issue"
    },
    "session": {
      "__typename": "Session"
    },
    "activities": [
      {
        "__typename": "AuditEvent"
      }
    ],
    "agent": {
      "__typename": "Agent"
    },
    "description": "Example String"
  }
}

flows

(...args)
FlowConnection!,non-null

Arguments

filter
FlowFilter
orderBy
[FlowOrderByInput!],non-null
first
Int
after
String
last
Int
before
String

Return type

FlowConnection!
nodes
[Flow!]!,non-null
edges
[FlowEdge!]!,non-null
pageInfo
PageInfo!,non-null
totalCount
Int!,non-null
aggregations
FlowAggregations
Query sample
query flows(
  $filter: FlowFilter
  $orderBy: [FlowOrderByInput!]
  $first: Int
  $after: String
  $last: Int
  $before: String
) {
  flows(
    filter: $filter
    orderBy: $orderBy
    first: $first
    after: $after
    last: $last
    before: $before
  ) {
    nodes {
      id 
      externalId 
      name 
      description 
      platform {
        __typename
        # ...PlatformFragment
      }
      environment {
        __typename
        # ...EnvironmentFragment
      }
      owner {
        __typename
        # ...OwnerFragment
      }
      status 
      mode 
      version 
      graph {
        __typename
        # ...FlowGraphFragment
      }
      agents {
        __typename
        # ...AgentPreviewFragment
      }
      tools {
        __typename
        # ...ToolPreviewFragment
      }
      dataSources {
        __typename
        # ...DataSourcePreviewFragment
      }
      findings {
        __typename
        # ...FindingFragment
      }
      issues {
        __typename
        # ...IssueFragment
      }
      createdAt 
      updatedAt 
      capturedAt 
      platformCreatedAt 
      platformUpdatedAt 
      metadata 
    }
    edges {
      node {
        id 
        externalId 
        name 
        description 
        platform {
          __typename
          # ...PlatformFragment
        }
        environment {
          __typename
          # ...EnvironmentFragment
        }
        owner {
          __typename
          # ...OwnerFragment
        }
        status 
        mode 
        version 
        graph {
          __typename
          # ...FlowGraphFragment
        }
        agents {
          __typename
          # ...AgentPreviewFragment
        }
        tools {
          __typename
          # ...ToolPreviewFragment
        }
        dataSources {
          __typename
          # ...DataSourcePreviewFragment
        }
        findings {
          __typename
          # ...FindingFragment
        }
        issues {
          __typename
          # ...IssueFragment
        }
        createdAt 
        updatedAt 
        capturedAt 
        platformCreatedAt 
        platformUpdatedAt 
        metadata 
      }
      cursor 
    }
    pageInfo {
      hasNextPage 
      hasPreviousPage 
      startCursor 
      endCursor 
    }
    totalCount 
    aggregations {
      __typename
      # ...FlowAggregationsFragment
    }
  }
}
Variables
{
  "filter": {
    "id": {
      "__typename": "StringFilter"
    },
    "search": "Example String",
    "status": {
      "__typename": "FlowStatusFilter"
    },
    "platform": {
      "__typename": "PlatformFilter"
    },
    "environment": {
      "__typename": "EnvironmentFilter"
    },
    "owner": {
      "__typename": "OwnerFilter"
    },
    "mode": {
      "__typename": "FlowModeFilter"
    },
    "hasExternalTrigger": {
      "__typename": "BooleanFilter"
    },
    "severity": {
      "__typename": "SeverityFilter"
    },
    "findings": {
      "__typename": "FindingFilter"
    },
    "agents": {
      "__typename": "FlowAgentFilter"
    },
    "createdAt": {
      "__typename": "DateTimeFilter"
    },
    "updatedAt": {
      "__typename": "DateTimeFilter"
    }
  },
  "orderBy": [
    {
      "field": "NAME",
      "direction": "ASC"
    }
  ],
  "first": 40,
  "after": "Example String",
  "last": 40,
  "before": "Example String"
}
Response sample
{
  "data": {
    "nodes": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "description": "Example String",
        "platform": {
          "__typename": "Platform"
        },
        "environment": {
          "__typename": "Environment"
        },
        "owner": {
          "__typename": "Owner"
        },
        "status": "ACTIVE",
        "mode": "SYNC",
        "version": "Example String",
        "graph": {
          "__typename": "FlowGraph"
        },
        "agents": [
          {
            "__typename": "AgentPreview"
          }
        ],
        "tools": [
          {
            "__typename": "ToolPreview"
          }
        ],
        "dataSources": [
          {
            "__typename": "DataSourcePreview"
          }
        ],
        "findings": [
          {
            "__typename": "Finding"
          }
        ],
        "issues": [
          {
            "__typename": "Issue"
          }
        ],
        "createdAt": "Example Custom Scalar",
        "updatedAt": "Example Custom Scalar",
        "capturedAt": "Example Custom Scalar",
        "platformCreatedAt": "Example Custom Scalar",
        "platformUpdatedAt": "Example Custom Scalar",
        "metadata": "Example Custom Scalar"
      }
    ],
    "edges": [
      {
        "node": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "description": "Example String",
          "platform": {
            "__typename": "Platform"
          },
          "environment": {
            "__typename": "Environment"
          },
          "owner": {
            "__typename": "Owner"
          },
          "status": "ACTIVE",
          "mode": "SYNC",
          "version": "Example String",
          "graph": {
            "__typename": "FlowGraph"
          },
          "agents": [
            {
              "__typename": "AgentPreview"
            }
          ],
          "tools": [
            {
              "__typename": "ToolPreview"
            }
          ],
          "dataSources": [
            {
              "__typename": "DataSourcePreview"
            }
          ],
          "findings": [
            {
              "__typename": "Finding"
            }
          ],
          "issues": [
            {
              "__typename": "Issue"
            }
          ],
          "createdAt": "Example Custom Scalar",
          "updatedAt": "Example Custom Scalar",
          "capturedAt": "Example Custom Scalar",
          "platformCreatedAt": "Example Custom Scalar",
          "platformUpdatedAt": "Example Custom Scalar",
          "metadata": "Example Custom Scalar"
        },
        "cursor": "Example String"
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "Example String",
      "endCursor": "Example String"
    },
    "totalCount": 40,
    "aggregations": {
      "__typename": "FlowAggregations"
    }
  }
}

Mutations

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview