getArtifactsTopFilters

Retrieves artifacts top filters.

Examples

GraphQL

query GetArtifactsTopFilters($getArtifactsInput: GetArtifactsInput) {
  getArtifactsTopFilters(getArtifactsInput: $getArtifactsInput) {
    name
    label
    count
    delta
    trend
  }
}

Variables

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

{
  "getArtifactsInput": {
    "limit": 100,
    "offset": 0,
    "sort": {
      "field": ["AppName"],
      "order": ["ASC"]
    },
    "dateRange": {
      "from": 1749000000000,
      "to": 1749900000000
    },
    "filters": {
      "apps": ["example"],
      "artifactType": ["example"],
      "artifactName": ["example"],
      "artifactFullName": ["example"],
      "version": ["example"],
      "sourceType": ["example"],
      "sourceTools": ["example"],
      "registryType": ["example"],
      "registryName": ["example"],
      "cloud": ["example"],
      "cluster": ["example"],
      "namespace": ["example"],
      "cloudDeployments": ["example"],
      "categories": ["example"],
      "issueSeverities": ["example"],
      "reachability": ["example"],
      "artifactIntegrity": ["example"],
      "artifactSha": ["example"],
      "imageSource": ["example"]
    },
    "artifactTopFilters": ["WithHighSeverityIssues"],
    "owners": ["example"],
    "tagIds": ["example"],
    "search": "example",
    "openItems": ["digest"]
  }
}

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 GetArtifactsTopFilters($getArtifactsInput: GetArtifactsInput) { getArtifactsTopFilters(getArtifactsInput: $getArtifactsInput) { name label count delta trend } }",
 "variables": {
    "getArtifactsInput": {
      "limit": 100,
      "offset": 0,
      "sort": {
        "field": ["AppName"],
        "order": ["ASC"]
      },
      "dateRange": {
        "from": 1749000000000,
        "to": 1749900000000
      },
      "filters": {
        "apps": ["example"],
        "artifactType": ["example"],
        "artifactName": ["example"],
        "artifactFullName": ["example"],
        "version": ["example"],
        "sourceType": ["example"],
        "sourceTools": ["example"],
        "registryType": ["example"],
        "registryName": ["example"],
        "cloud": ["example"],
        "cluster": ["example"],
        "namespace": ["example"],
        "cloudDeployments": ["example"],
        "categories": ["example"],
        "issueSeverities": ["example"],
        "reachability": ["example"],
        "artifactIntegrity": ["example"],
        "artifactSha": ["example"],
        "imageSource": ["example"]
      },
      "artifactTopFilters": ["WithHighSeverityIssues"],
      "owners": ["example"],
      "tagIds": ["example"],
      "search": "example",
      "openItems": ["digest"]
    }
  }
}'

Node.js

const query = 'query GetArtifactsTopFilters($getArtifactsInput: GetArtifactsInput) { getArtifactsTopFilters(getArtifactsInput: $getArtifactsInput) { name label count delta trend } }';

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: {
      getArtifactsInput: {
        limit: 100,
        offset: 0,
        sort: {
          field: ["AppName"],
          order: ["ASC"]
        },
        dateRange: {
          from: 1749000000000,
          to: 1749900000000
        },
        filters: {
          apps: ["example"],
          artifactType: ["example"],
          artifactName: ["example"],
          artifactFullName: ["example"],
          version: ["example"],
          sourceType: ["example"],
          sourceTools: ["example"],
          registryType: ["example"],
          registryName: ["example"],
          cloud: ["example"],
          cluster: ["example"],
          namespace: ["example"],
          cloudDeployments: ["example"],
          categories: ["example"],
          issueSeverities: ["example"],
          reachability: ["example"],
          artifactIntegrity: ["example"],
          artifactSha: ["example"],
          imageSource: ["example"]
        },
        artifactTopFilters: ["WithHighSeverityIssues"],
        owners: ["example"],
        tagIds: ["example"],
        search: "example",
        openItems: ["digest"]
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetArtifactsTopFilters($getArtifactsInput: GetArtifactsInput) { getArtifactsTopFilters(getArtifactsInput: $getArtifactsInput) { name label count delta trend } }'

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": {
      "getArtifactsInput": {
        "limit": 100,
        "offset": 0,
        "sort": {
          "field": ["AppName"],
          "order": ["ASC"]
        },
        "dateRange": {
          "from": 1749000000000,
          "to": 1749900000000
        },
        "filters": {
          "apps": ["example"],
          "artifactType": ["example"],
          "artifactName": ["example"],
          "artifactFullName": ["example"],
          "version": ["example"],
          "sourceType": ["example"],
          "sourceTools": ["example"],
          "registryType": ["example"],
          "registryName": ["example"],
          "cloud": ["example"],
          "cluster": ["example"],
          "namespace": ["example"],
          "cloudDeployments": ["example"],
          "categories": ["example"],
          "issueSeverities": ["example"],
          "reachability": ["example"],
          "artifactIntegrity": ["example"],
          "artifactSha": ["example"],
          "imageSource": ["example"]
        },
        "artifactTopFilters": ["WithHighSeverityIssues"],
        "owners": ["example"],
        "tagIds": ["example"],
        "search": "example",
        "openItems": ["digest"]
      }
    }
  }
)

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

Argument	Description	Supported fields
getArtifactsInput GetArtifactsInput		limit Int offset Int sort ArtifactsSort dateRange DateRange filters ArtifactFilters artifactTopFilters [ArtifactTopFilters] owners [String] tagIds [String] search String openItems [FilterTypes]

Fields

Return type: [ArtifactsTopFiltersResponse]

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

Field	Description	Supported fields
name ArtifactTopFilters
label String
count Int
delta Int
trend String