executeCustomDashboard
Computes a subset of a saved dashboard's widgets
executeCustomDashboard(
companyId: ID!
id: ID!
expectedVersion: Int!
widgetKeys: [String!]!
runtime: JSON
): [CustomDashboardWidgetResult!]!
Arguments
executeCustomDashboard.companyId ● ID! non-null scalar
executeCustomDashboard.id ● ID! non-null scalar
executeCustomDashboard.expectedVersion ● Int! non-null scalar
The lockVersion the viewer loaded; a newer revision answers CUSTOM_DASHBOARD_CONFLICT
executeCustomDashboard.widgetKeys ● [String!]! non-null scalar
Subset of widgets to compute; the viewer fans out with bounded concurrency
executeCustomDashboard.runtime ● JSON scalar
Temporary { timeRange, filters } replacing the dashboard defaults for this view
Type
CustomDashboardWidgetResult object
Standard result envelope for one widget; renderers never infer formulas from labels
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 GetExecuteCustomDashboard($companyId: ID!, $id: ID!, $expectedVersion: Int!, $widgetKeys: [String!]!) {\n executeCustomDashboard(companyId: $companyId, id: $id, expectedVersion: $expectedVersion, widgetKeys: $widgetKeys) { additive buckets { end index start } dimensions { label additive key } }\n}","variables":{"companyId":"<company_id>","id":"example-id","expectedVersion":1,"widgetKeys":["example"]}}'
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 GetExecuteCustomDashboard($companyId: ID!, $id: ID!, $expectedVersion: Int!, $widgetKeys: [String!]!) {\n executeCustomDashboard(companyId: $companyId, id: $id, expectedVersion: $expectedVersion, widgetKeys: $widgetKeys) { additive buckets { end index start } dimensions { label additive key } }\n}",
variables: {
"companyId": "<company_id>",
"id": "example-id",
"expectedVersion": 1,
"widgetKeys": [
"example"
]
},
}),
});
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 GetExecuteCustomDashboard($companyId: ID!, $id: ID!, $expectedVersion: Int!, $widgetKeys: [String!]!) {\n executeCustomDashboard(companyId: $companyId, id: $id, expectedVersion: $expectedVersion, widgetKeys: $widgetKeys) { additive buckets { end index start } dimensions { label additive key } }\n}",
'variables': json.loads("{\"companyId\":\"<company_id>\",\"id\":\"example-id\",\"expectedVersion\":1,\"widgetKeys\":[\"example\"]}"),
},
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