Skip to content
/Queries

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

agents

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

Arguments

filter
AgentFilter
limit
Int
Default:100

Return type

[Agent!]!
externalId
ID!,non-null
id
ID!,non-null
platform
Platform!,non-null
name
String!,non-null
environment
Environment!,non-null
owner
Owner!,non-null
accessibility
AgentAccessibility!,non-null
description
String
nodes
[Node!]!,non-null
edges
[Edge!]!,non-null
tools
[Tool!]!,non-null
createdAt
DateTime!,non-null
highestIssueSeverity
Issue
usage
Usage
Query sample
query agents($filter: AgentFilter, $limit: Int) {
  agents(filter: $filter, limit: $limit) {
    externalId 
    id 
    platform {
      __typename
      # ...PlatformFragment
    }
    name 
    environment {
      __typename
      # ...EnvironmentFragment
    }
    owner {
      __typename
      # ...OwnerFragment
    }
    accessibility 
    description 
    nodes {
      id 
      name 
      issues {
        __typename
        # ...IssueFragment
      }
    }
    edges {
      connectionA 
      connectionB 
      direction 
    }
    tools {
      __typename
      # ...ToolFragment
    }
    createdAt 
    highestIssueSeverity {
      __typename
      # ...IssueFragment
    }
    usage {
      __typename
      # ...UsageFragment
    }
  }
}
Variables
{
  "filter": {
    "search": "Example String",
    "severity": {
      "__typename": "SeverityFilter"
    },
    "platform": {
      "__typename": "PlatformFilter"
    },
    "environment": {
      "__typename": "EnvironmentFilter"
    },
    "accessibility": {
      "__typename": "AccessibilityFilter"
    },
    "owner": {
      "__typename": "OwnerFilter"
    },
    "tools": {
      "__typename": "ToolFilter"
    }
  },
  "limit": 40
}
Response sample
{
  "data": [
    {
      "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "platform": {
        "__typename": "Platform"
      },
      "name": "Example String",
      "environment": {
        "__typename": "Environment"
      },
      "owner": {
        "__typename": "Owner"
      },
      "accessibility": "PUBLIC",
      "description": "Example String",
      "nodes": [
        {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "issues": [
            {
              "__typename": "Issue"
            }
          ]
        }
      ],
      "edges": [
        {
          "connectionA": "Example String",
          "connectionB": "Example String",
          "direction": "ATOB"
        }
      ],
      "tools": [
        {
          "__typename": "Tool"
        }
      ],
      "createdAt": "Example Custom Scalar",
      "highestIssueSeverity": {
        "__typename": "Issue"
      },
      "usage": {
        "__typename": "Usage"
      }
    }
  ]
}

agent

(id)
Agent

Arguments

id
ID!,non-nullrequired

Return type

Agent
externalId
ID!,non-null
id
ID!,non-null
platform
Platform!,non-null
name
String!,non-null
environment
Environment!,non-null
owner
Owner!,non-null
accessibility
AgentAccessibility!,non-null
description
String
nodes
[Node!]!,non-null
edges
[Edge!]!,non-null
tools
[Tool!]!,non-null
createdAt
DateTime!,non-null
highestIssueSeverity
Issue
usage
Usage
Query sample
query agent($id: ID!) {
  agent(id: $id) {
    externalId 
    id 
    platform {
      __typename
      # ...PlatformFragment
    }
    name 
    environment {
      __typename
      # ...EnvironmentFragment
    }
    owner {
      __typename
      # ...OwnerFragment
    }
    accessibility 
    description 
    nodes {
      id 
      name 
      issues {
        __typename
        # ...IssueFragment
      }
    }
    edges {
      connectionA 
      connectionB 
      direction 
    }
    tools {
      __typename
      # ...ToolFragment
    }
    createdAt 
    highestIssueSeverity {
      __typename
      # ...IssueFragment
    }
    usage {
      __typename
      # ...UsageFragment
    }
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "platform": {
      "__typename": "Platform"
    },
    "name": "Example String",
    "environment": {
      "__typename": "Environment"
    },
    "owner": {
      "__typename": "Owner"
    },
    "accessibility": "PUBLIC",
    "description": "Example String",
    "nodes": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "issues": [
          {
            "__typename": "Issue"
          }
        ]
      }
    ],
    "edges": [
      {
        "connectionA": "Example String",
        "connectionB": "Example String",
        "direction": "ATOB"
      }
    ],
    "tools": [
      {
        "__typename": "Tool"
      }
    ],
    "createdAt": "Example Custom Scalar",
    "highestIssueSeverity": {
      "__typename": "Issue"
    },
    "usage": {
      "__typename": "Usage"
    }
  }
}

agentAudit

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

Arguments

agentId
ID!,non-nullrequired
limit
Int
before
DateTime
after
DateTime

Return type

AgentAuditResponse!
pageInfo
PageInfo!,non-null
items
[AgentAudit!],non-null
Query sample
query agentAudit(
  $agentId: ID!
  $limit: Int
  $before: DateTime
  $after: DateTime
) {
  agentAudit(
    agentId: $agentId
    limit: $limit
    before: $before
    after: $after
  ) {
    pageInfo {
      hasNextPage 
    }
    items {
      __typename
      # ...AgentAuditFragment
    }
  }
}
Variables
{
  "agentId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "limit": 40,
  "before": "Example Custom Scalar",
  "after": "Example Custom Scalar"
}
Response sample
{
  "data": {
    "pageInfo": {
      "hasNextPage": true
    },
    "items": [
      {
        "__typename": "AgentAudit"
      }
    ]
  }
}

topAgentCountByOwner

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

Arguments

limit
Int
before
DateTime
after
DateTime

Return type

[AgentCountByOwner!]!
owner
Owner!,non-null
count
Int!,non-null
Query sample
query topAgentCountByOwner(
  $limit: Int
  $before: DateTime
  $after: DateTime
) {
  topAgentCountByOwner(
    limit: $limit
    before: $before
    after: $after
  ) {
    owner {
      __typename
      # ...OwnerFragment
    }
    count 
  }
}
Variables
{
  "limit": 40,
  "before": "Example Custom Scalar",
  "after": "Example Custom Scalar"
}
Response sample
{
  "data": [
    {
      "owner": {
        "__typename": "Owner"
      },
      "count": 40
    }
  ]
}

topAgentCountByEnvironment

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

Arguments

limit
Int
before
DateTime
after
DateTime

Return type

[AgentCountByEnvironment!]!
environment
Environment!,non-null
count
Int!,non-null
Query sample
query topAgentCountByEnvironment(
  $limit: Int
  $before: DateTime
  $after: DateTime
) {
  topAgentCountByEnvironment(
    limit: $limit
    before: $before
    after: $after
  ) {
    environment {
      __typename
      # ...EnvironmentFragment
    }
    count 
  }
}
Variables
{
  "limit": 40,
  "before": "Example Custom Scalar",
  "after": "Example Custom Scalar"
}
Response sample
{
  "data": [
    {
      "environment": {
        "__typename": "Environment"
      },
      "count": 40
    }
  ]
}

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview