getExternalSaasCommandStats

Get per-command stats: total users and total calls.

Examples

GraphQL

query GetExternalSaasCommandStats($input: ExternalSaasStatsInput) {
  getExternalSaasCommandStats(input: $input) {
    items {
      command
      patternDescription
      userEmails
      totalCalls
    }
    total
  }
}

Variables

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

{
  "input": {
    "name": "api.github.com",
    "limit": 100,
    "offset": 0
  }
}

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 GetExternalSaasCommandStats($input: ExternalSaasStatsInput) { getExternalSaasCommandStats(input: $input) { items { command patternDescription userEmails totalCalls } total } }",
 "variables": {
    "input": {
      "name": "api.github.com",
      "limit": 100,
      "offset": 0
    }
  }
}'

Node.js

const query = 'query GetExternalSaasCommandStats($input: ExternalSaasStatsInput) { getExternalSaasCommandStats(input: $input) { items { command patternDescription userEmails totalCalls } 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: {
        name: "api.github.com",
        limit: 100,
        offset: 0
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetExternalSaasCommandStats($input: ExternalSaasStatsInput) { getExternalSaasCommandStats(input: $input) { items { command patternDescription userEmails totalCalls } 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": {
        "name": "api.github.com",
        "limit": 100,
        "offset": 0
      }
    }
  }
)

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 getExternalSaasCommandStats query.

Argument	Description	Supported fields
input ExternalSaasStatsInput		name String limit Int offset Int

Fields

Return type: ExternalSaasCommandStatsResponse!

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

Field	Description	Supported fields
items [ExternalSaasCommandStatItem!]!	List of external SaaS command statistics matching the query criteria	command String! patternDescription String! userEmails [String!]! totalCalls Int!
data [ExternalSaasCommandStatItem!]! ⚠️	Deprecated: Use items	command String! patternDescription String! userEmails [String!]! totalCalls Int!
total Int!	Total number of commands matching the query criteria