generateExecutiveDashboardReport
Enqueues generation of an executive report from a dashboard's metrics
generateExecutiveDashboardReport(
input: GenerateExecutiveDashboardReportInput!
): GenerateExecutiveDashboardReportPayload
Arguments
generateExecutiveDashboardReport.input ● GenerateExecutiveDashboardReportInput! non-null input
Parameters for GenerateExecutiveDashboardReport
Type
GenerateExecutiveDashboardReportPayload object
Autogenerated return type of GenerateExecutiveDashboardReport.
Example request
This generated mutation 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":"mutation MutateGenerateExecutiveDashboardReport($input: GenerateExecutiveDashboardReportInput!) {\n generateExecutiveDashboardReport(input: $input) { clientMutationId enqueued }\n}","variables":{"input":{"companyId":"<company_id>","dashboard":"APPSEC_KPI"}}}'
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: "mutation MutateGenerateExecutiveDashboardReport($input: GenerateExecutiveDashboardReportInput!) {\n generateExecutiveDashboardReport(input: $input) { clientMutationId enqueued }\n}",
variables: {
"input": {
"companyId": "<company_id>",
"dashboard": "APPSEC_KPI"
}
},
}),
});
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': "mutation MutateGenerateExecutiveDashboardReport($input: GenerateExecutiveDashboardReportInput!) {\n generateExecutiveDashboardReport(input: $input) { clientMutationId enqueued }\n}",
'variables': json.loads("{\"input\":{\"companyId\":\"<company_id>\",\"dashboard\":\"APPSEC_KPI\"}}"),
},
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