customDashboardDrilldown

Contributing records of one cell of a saved widget, under the viewer's current access

customDashboardDrilldown(
  companyId: ID!
  context: String!
  selection: JSON
  page: Int = 1
  limit: Int = 25
): CustomDashboardDrilldownRecords!

Arguments

customDashboardDrilldown.companyId ● ID! non-null scalar

customDashboardDrilldown.context ● String! non-null scalar

The widget result's drilldownContext

customDashboardDrilldown.selection ● JSON scalar

The row's drilldown selection; omitted means the widget's total

customDashboardDrilldown.page ● Int scalar

customDashboardDrilldown.limit ● Int scalar

Type

CustomDashboardDrilldownRecords object

A page of the records behind one widget cell, read live under the viewer's current access

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

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"query GetCustomDashboardDrilldown($companyId: ID!, $context: String!) {\n  customDashboardDrilldown(companyId: $companyId, context: $context) { at evaluatedAt interval { end start } }\n}","variables":{"companyId":"<company_id>","context":"example"}}'

JavaScript

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 GetCustomDashboardDrilldown($companyId: ID!, $context: String!) {\n  customDashboardDrilldown(companyId: $companyId, context: $context) { at evaluatedAt interval { end start } }\n}",
    variables: {
    "companyId": "<company_id>",
    "context": "example"
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

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 GetCustomDashboardDrilldown($companyId: ID!, $context: String!) {\n  customDashboardDrilldown(companyId: $companyId, context: $context) { at evaluatedAt interval { end start } }\n}",
        'variables': json.loads("{\"companyId\":\"<company_id>\",\"context\":\"example\"}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])