Skip to main content

customDashboards

Dashboards the requesting user can access in a company: owned, shared with them, or both

customDashboards(
companyId: ID!
search: String
origin: CustomDashboardOrigin
ownership: CustomDashboardOwnershipFilter = OWNED
page: Int = 1
limit: Int = 25
): CustomDashboardPaginatedCollection!

Arguments​

customDashboards.companyId ● ID! non-null scalar​

customDashboards.origin ● CustomDashboardOrigin enum​

customDashboards.ownership ● CustomDashboardOwnershipFilter enum​

customDashboards.page ● Int scalar​

customDashboards.limit ● Int scalar​

Type​

CustomDashboardPaginatedCollection object​

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 GetCustomDashboards($companyId: ID!) {\n customDashboards(companyId: $companyId) { collection { id name accessRole } metadata { currentPage limitValue totalCount } }\n}","variables":{"companyId":"<company_id>"}}'

Contribute to the Docs

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

How to contribute