Skip to main content
Answer “what breaks if I change or delete this?” for one resource. The tool returns everything that references the resource — compensations and their plans, reports, dashboards, saved views, variables, lookup fields, plan simulation pipelines — each as a uniform row naming the dependent, the object it lives inside, and the sandbox it belongs to (null on live). Reach for it before advising on a change to a quota, data table, group, group dimension, plan or report, and to answer “is this still used?”. One call returns every dependent — there is no pagination and no cap, because a partial impact analysis is worse than none. counts_by_type rolls the same rows up per nature so you can read the shape of the impact at a glance, and a total of 0 means nothing references the resource, so changing or deleting it breaks nothing. Dependents are reported in full even when you could not open one yourself: withholding one would read as “nothing uses this”, which is the wrong conclusion to act on. Each dependent carries only its id and name, never its contents.

​
Permissions

Reading a resource’s dependents needs full read access to that kind of resource — a resource merely shared with you does not admit you, since the question exists to be asked before changing or deleting it. The tool is visible as soon as your role can read any of the six resource types, but each call is checked against the permission the resource_type argument selects: you can only analyze the kinds you may read. Analyzing a report additionally requires the reporting feature to be enabled for your company. This tool is read-only: it says what would break and changes nothing.

​
Parameters

Body

​
string
required
What kind of resource resource_id names. One of: quota, data_table, group, group_dimension, plan, report. Each kind is read under its own permission, so you can analyze only the kinds you may read.
​
string
required
Id of the resource to analyze — the id the matching list tool returns (list_quotas, list_data_tables, list_groups, list_group_dimensions, list_plans, list_reports). An id, never a name.

​
Response

Body

​
string
The kind of resource that was analyzed. One of: quota, data_table, group, group_dimension, plan, report.
​
object
The resource whose dependents were analyzed.
​
integer
Total dependents across every nature — the length of dependencies. Zero means nothing references this resource, so changing or deleting it breaks nothing.
​
object[]
Per-nature rollup of dependencies, to read the shape of the impact at a glance. Natures with no dependent are omitted.
​
object[]
Every dependent, ordered by nature then name. The whole set, never a page and never capped — total is always its length.