preventedRiskPromptById

Fetch a single persisted Prevented-Risk Prompt activity by id.

Examples

GraphQL

query PreventedRiskPromptById($input: RisksPreventedByIdInput!) {
  preventedRiskPromptById(input: $input) {
    id
    createdAt
    activityType
    oxAction
    userEmail
    userRole
    source
    appName
    threadId
    promptSizeBytes
    responseTokenCount
    model
    appliedGuidelines {
      oxGuidelineId
      displayName
      category
      createdBy
      prompt
      promptSizeBytes
      isFromCache
      tokenCount
    }
    secretRuleIds
    maskedSecrets
    secretTypeLabels
    blockedSecretCount
  }
}

Variables

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

{
  "input": {
    "id": "68b7c1f0a2e4d51234567890"
  }
}

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 PreventedRiskPromptById($input: RisksPreventedByIdInput!) { preventedRiskPromptById(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId promptSizeBytes responseTokenCount model appliedGuidelines { oxGuidelineId displayName category createdBy prompt promptSizeBytes isFromCache tokenCount } secretRuleIds maskedSecrets secretTypeLabels blockedSecretCount } }",
 "variables": {
    "input": {
      "id": "68b7c1f0a2e4d51234567890"
    }
  }
}'

Node.js

const query = 'query PreventedRiskPromptById($input: RisksPreventedByIdInput!) { preventedRiskPromptById(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId promptSizeBytes responseTokenCount model appliedGuidelines { oxGuidelineId displayName category createdBy prompt promptSizeBytes isFromCache tokenCount } secretRuleIds maskedSecrets secretTypeLabels blockedSecretCount } }';

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"
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query PreventedRiskPromptById($input: RisksPreventedByIdInput!) { preventedRiskPromptById(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId promptSizeBytes responseTokenCount model appliedGuidelines { oxGuidelineId displayName category createdBy prompt promptSizeBytes isFromCache tokenCount } secretRuleIds maskedSecrets secretTypeLabels blockedSecretCount } }'

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"
      }
    }
  }
)

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

Argument	Description	Supported fields
input RisksPreventedByIdInput! required		id ID!

Fields

Return type: PromptAgentActivity

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

Field	Description	Supported fields
id ID!	Unique identifier of the activity record
createdAt DateTime	When the activity was recorded
activityType AgentActivityType!	Kind of agent activity this record represents
oxAction OxAction!	Action OX took on this activity
userEmail String	Email address of the developer who triggered the activity
userRole String	Role of the developer who triggered the activity
source VibeCodeSource!	Coding agent the activity originated from
appName String	Application the activity was attributed to
threadId String	Identifier of the agent conversation the activity belongs to
promptSizeBytes Int	Size of the prompt, in bytes
responseTokenCount Int	Tokens of security guidance the model received for this prompt, as the hook injected it, wrapper text included
model String	AI model the prompt was sent to
appliedGuidelines [AppliedGuideline!]	OX guidelines injected into this prompt	oxGuidelineId String! displayName String! category String! createdBy String! prompt String! promptSizeBytes Int isFromCache Boolean tokenCount Int
secretRuleIds [String!]	Identifiers of the secret-detection rules that matched
maskedSecrets [String!]	Matched credentials, already masked by the hook
secretTypeLabels [String!]	Human-readable names of the secret types that matched (e.g. "AWS Access Token"), derived from secretRuleIds. Never derived from the credential itself
blockedSecretCount Int	How many secret matches the hook reported (capped at 10 by the hook)