getGuidelinesWeekly

Get security guidelines provided and applied, grouped by week.

Examples

GraphQL

query GetGuidelinesWeekly($input: ActiveUsersWeeklyInput) {
  getGuidelinesWeekly(input: $input) {
    week
    providedCount
    appliedCount
  }
}

Variables

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

{
  "input": {
    "dateRange": {
      "from": 1749000000000,
      "to": 1749900000000
    }
  }
}

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 GetGuidelinesWeekly($input: ActiveUsersWeeklyInput) { getGuidelinesWeekly(input: $input) { week providedCount appliedCount } }",
 "variables": {
    "input": {
      "dateRange": {
        "from": 1749000000000,
        "to": 1749900000000
      }
    }
  }
}'

Node.js

const query = 'query GetGuidelinesWeekly($input: ActiveUsersWeeklyInput) { getGuidelinesWeekly(input: $input) { week providedCount appliedCount } }';

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

Python

import requests

query = 'query GetGuidelinesWeekly($input: ActiveUsersWeeklyInput) { getGuidelinesWeekly(input: $input) { week providedCount appliedCount } }'

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": {
        "dateRange": {
          "from": 1749000000000,
          "to": 1749900000000
        }
      }
    }
  }
)

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

Argument	Description	Supported fields
input ActiveUsersWeeklyInput	Optional date range filter	dateRange VibeSecDateRange

Fields

Return type: [VibeSecGuidelinesWeeklyItem!]!

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

Field	Description	Supported fields
week String!	ISO date of the week start (Sunday)
providedCount Int!	Number of prompts that received security guidelines in the week
appliedCount Int!	Number of code writes where a provided guideline was applied in the week