issuesAggregation
Searches for aggregated issues by title, asset, and failure type
issuesAggregation(
companyId: ID!
pagination: PaginationInput!
filters: IssuesAggregationFiltersInput = { ids: [], statuses: [], severities: [], failureTypes: [], projectTypes: [], assetIds: [], projectIds: [], integrationTypes: [], assetTags: [], createdAtRange: { }, title: "", partialTitle: "", cves: [], categories: [], statusChange: { from: [], to: [], date: { }, changedByEmails: [] }, statusInPeriod: { statuses: [], date: { } }, slaStates: [], riskAcceptedUntilRange: { }, scanIds: [], branchNames: [], reachableBy: [], assigneeTeamIds: [], aiAnalyzedAtRange: { }, lastUpdatedByIds: [], allBranches: false }
sortOptions: [IssueSortOptionInput!] = []
): IssuesAggregationCollection!
Arguments
issuesAggregation.companyId ● ID! non-null scalar
issuesAggregation.pagination ● PaginationInput! non-null input
issuesAggregation.filters ● IssuesAggregationFiltersInput input
issuesAggregation.sortOptions ● [IssueSortOptionInput!] list input
Type
IssuesAggregationCollection object
IssuesAggregationCollection type
Example request
This generated query uses placeholders for required values. Replace them with values available to your API key before running it.
Before you run it
Run the companies query first and use data.companies.collection[].id as companyId.
- cURL
- JavaScript
- Python
curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetIssuesAggregation($companyId: ID!, $pagination: PaginationInput!) {\n issuesAggregation(companyId: $companyId, pagination: $pagination) { collection { title asset { __typename } severities { __typename } } metadata { currentPage limitValue totalCount } }\n}","variables":{"companyId":"<company_id>","pagination":{}}}'
const response = await fetch('https://api.convisoappsec.com/graphql', {
method: 'POST',
headers: {
'content-type': 'application/json',
'x-api-key': process.env.CONVISO_API_KEY,
},
body: JSON.stringify({
query: "query GetIssuesAggregation($companyId: ID!, $pagination: PaginationInput!) {\n issuesAggregation(companyId: $companyId, pagination: $pagination) { collection { title asset { __typename } severities { __typename } } metadata { currentPage limitValue totalCount } }\n}",
variables: {
"companyId": "<company_id>",
"pagination": {}
},
}),
});
const { data, errors } = await response.json();
if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);
import json
import os
import requests
response = requests.post(
'https://api.convisoappsec.com/graphql',
headers={
'content-type': 'application/json',
'x-api-key': os.environ['CONVISO_API_KEY'],
},
json={
'query': "query GetIssuesAggregation($companyId: ID!, $pagination: PaginationInput!) {\n issuesAggregation(companyId: $companyId, pagination: $pagination) { collection { title asset { __typename } severities { __typename } } metadata { currentPage limitValue totalCount } }\n}",
'variables': json.loads("{\"companyId\":\"<company_id>\",\"pagination\":{}}"),
},
timeout=30,
)
response.raise_for_status()
payload = response.json()
if payload.get('errors'):
raise RuntimeError(payload['errors'])
print(payload['data'])
Contribute to the Docs
Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.
How to contribute