getGuidelineUsage

Get usage statistics for a specific guideline including total count and recent usage details.

Examples

GraphQL

query GetGuidelineUsage($input: GetGuidelineUsageInput!) {
  getGuidelineUsage(input: $input) {
    usage {
      count
      usagePerDay {
        date
        count
      }
    }
    recent {
      timestamp
      user
      appName
      source
    }
  }
}

Variables

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

{
  "input": {
    "id": "68b7c1f0a2e4d51234567890",
    "dateRange": {
      "startDate": "example",
      "endDate": "example"
    },
    "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 GetGuidelineUsage($input: GetGuidelineUsageInput!) { getGuidelineUsage(input: $input) { usage { count usagePerDay { date count } } recent { timestamp user appName source } } }",
 "variables": {
    "input": {
      "id": "68b7c1f0a2e4d51234567890",
      "dateRange": {
        "startDate": "example",
        "endDate": "example"
      },
      "limit": 100,
      "offset": 0
    }
  }
}'

Node.js

const query = 'query GetGuidelineUsage($input: GetGuidelineUsageInput!) { getGuidelineUsage(input: $input) { usage { count usagePerDay { date count } } recent { timestamp user appName source } } }';

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: {
        id: "68b7c1f0a2e4d51234567890",
        dateRange: {
          startDate: "example",
          endDate: "example"
        },
        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 GetGuidelineUsage($input: GetGuidelineUsageInput!) { getGuidelineUsage(input: $input) { usage { count usagePerDay { date count } } recent { timestamp user appName source } } }'

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": {
        "id": "68b7c1f0a2e4d51234567890",
        "dateRange": {
          "startDate": "example",
          "endDate": "example"
        },
        "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 getGuidelineUsage query.

Argument	Description	Supported fields
input GetGuidelineUsageInput! required	Input object for getting guideline usage	id String! dateRange DateRangeInput limit Int offset Int

Fields

Return type: GuidelineUsageResponse!

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

Field	Description	Supported fields
usage GuidelineUsage!	Usage statistics for the specified date range	count Float! usagePerDay [GuidelineUsagePerDay!]!
recent [GuidelineRecentUsage!]!	List of recent guideline usages	timestamp DateTime user String! appName String! source String!