Skip to main content

validateCustomDashboardImport

Read-only validation and preview of a definition file

validateCustomDashboardImport(
companyId: ID!
file: String!
): CustomDashboardImportPreview!

Arguments​

validateCustomDashboardImport.companyId ● ID! non-null scalar​

validateCustomDashboardImport.file ● String! non-null scalar​

The definition file as raw JSON text

Type​

CustomDashboardImportPreview object​

Read-only validation of a definition file. Fatal errors block the import; unavailable references do not.

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 GetValidateCustomDashboardImport($companyId: ID!, $file: String!) {\n validateCustomDashboardImport(companyId: $companyId, file: $file) { dashboards { name description key } errors { code message path } valid }\n}","variables":{"companyId":"<company_id>","file":"example"}}'

Contribute to the Docs

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

How to contribute