Skip to main content

previewCustomDashboardWidget

Validates and computes an unsaved widget

previewCustomDashboardWidget(
companyId: ID!
definition: JSON!
runtime: JSON
): CustomDashboardWidgetResult!

Arguments​

previewCustomDashboardWidget.companyId ● ID! non-null scalar​

previewCustomDashboardWidget.definition ● JSON! non-null scalar​

Unsaved DefinitionV1 holding exactly the one widget to preview

previewCustomDashboardWidget.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 --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetPreviewCustomDashboardWidget($companyId: ID!, $definition: JSON!) {\n previewCustomDashboardWidget(companyId: $companyId, definition: $definition) { additive buckets { end index start } dimensions { label additive key } }\n}","variables":{"companyId":"<company_id>","definition":"<JSON>"}}'

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute