getExternalSaas

Get a paginated, filterable, sortable list of external SaaS tools in the AI BOM.

Examples

GraphQL

query GetExternalSaas($input: GetExternalSaasInput) {
  getExternalSaas(input: $input) {
    items {
      name
      description
      totalUsers
      totalCommands
      totalCalls
      lastActivity
      userTotalCalls
      userLastUsedAt
      firstSeen
    }
    total
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "input": {
    "filter": {
      "name": ["api.github.com"],
      "command": ["curl"],
      "user": ["[e-mail]"],
      "source": ["Cursor"]
    },
    "sort": {
      "field": "Name",
      "direction": "Asc"
    },
    "limit": 100,
    "offset": 0,
    "dateRange": {
      "from": 1749000000000,
      "to": 1749900000000
    },
    "includeAggregateTotals": true
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetExternalSaas($input: GetExternalSaasInput) { getExternalSaas(input: $input) { items { name description totalUsers totalCommands totalCalls lastActivity userTotalCalls userLastUsedAt firstSeen } total } }",
 "variables": {
    "input": {
      "filter": {
        "name": ["api.github.com"],
        "command": ["curl"],
        "user": ["[e-mail]"],
        "source": ["Cursor"]
      },
      "sort": {
        "field": "Name",
        "direction": "Asc"
      },
      "limit": 100,
      "offset": 0,
      "dateRange": {
        "from": 1749000000000,
        "to": 1749900000000
      },
      "includeAggregateTotals": true
    }
  }
}'

Node.js

const query = 'query GetExternalSaas($input: GetExternalSaasInput) { getExternalSaas(input: $input) { items { name description totalUsers totalCommands totalCalls lastActivity userTotalCalls userLastUsedAt firstSeen } total } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      input: {
        filter: {
          name: ["api.github.com"],
          command: ["curl"],
          user: ["[e-mail]"],
          source: ["Cursor"]
        },
        sort: {
          field: "Name",
          direction: "Asc"
        },
        limit: 100,
        offset: 0,
        dateRange: {
          from: 1749000000000,
          to: 1749900000000
        },
        includeAggregateTotals: true
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetExternalSaas($input: GetExternalSaasInput) { getExternalSaas(input: $input) { items { name description totalUsers totalCommands totalCalls lastActivity userTotalCalls userLastUsedAt firstSeen } total } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "input": {
        "filter": {
          "name": ["api.github.com"],
          "command": ["curl"],
          "user": ["[e-mail]"],
          "source": ["Cursor"]
        },
        "sort": {
          "field": "Name",
          "direction": "Asc"
        },
        "limit": 100,
        "offset": 0,
        "dateRange": {
          "from": 1749000000000,
          "to": 1749900000000
        },
        "includeAggregateTotals": true
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your getExternalSaas query.

Argument	Description	Supported fields
input GetExternalSaasInput		filter ExternalSaasFilterInput sort ExternalSaasSortInput limit Int offset Int dateRange VibeSecDateRange includeAggregateTotals Boolean

Fields

Return type: GetExternalSaasResponse!

You can use the following field(s) to specify what information your getExternalSaas query will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
items [ExternalSaasItem!]!	List of external SaaS services matching the query criteria	name String! description String totalUsers Int! totalCommands Int! totalCalls Int! lastActivity DateTime userTotalCalls Int userLastUsedAt DateTime firstSeen DateTime
data [ExternalSaasItem!]! ⚠️	Deprecated: Use items	name String! description String totalUsers Int! totalCommands Int! totalCalls Int! lastActivity DateTime userTotalCalls Int userLastUsedAt DateTime firstSeen DateTime
total Int!	Total number of external SaaS services matching the query criteria