Skip to main content
Answer “what breaks if I change or delete this?” for one resource: every dependent, as a uniform row. Reach for it before advising on a change to a quota, data table, group, group dimension, plan, report or integration, and to answer “is this still used?”. Each row names the dependent (its id and name, never its contents), its parent, the object it lives inside, and the sandbox it belongs to (null on live). What is reported depends on resource_type:
  • quota: compensations and reports.
  • data_table: compensations, lookup fields on other tables and record reports.
  • group: compensations, saved views, reports, plan simulation pipelines and the plans the group is attributed to.
  • group_dimension: the same as a group, plus request views and the dimension’s own groups.
  • plan: compensations of other plans that use one of its compensations as their scope.
  • report: dashboards and Facets.
  • integration: the data tables and quotas it syncs. It does not cover the users, user attributes and groups an HRIS connection syncs, which disconnecting would unsync too. So a total of 0 on an integration doesn’t prove disconnecting it is safe, though it does mean the web app badges it as unused.
Not every dependent blocks a deletion. A group’s plan attributions (plan_attribution rows) do not: deleting the group removes it from those plans instead, so its members leave them and their statements change. Check for these rows before deleting a group. One call returns every dependent, with 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. Dependents are reported even when you could not open one yourself: withholding one would read as “nothing uses this”, which is the wrong conclusion to act on.

​
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 seven 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 an integration needs read access to company settings’ integrations. 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
Kind of resource resource_id names. It needs full read access to that kind (a share is not enough). One of: quota, data_table, group, group_dimension, plan, report, integration.
​
string
required
Id from list_quotas, list_data_tables, list_groups, list_group_dimensions, list_plans, list_reports or list_integrations, never a name.

​
Response

Body

​
string
The kind of resource that was analyzed. One of: quota, data_table, group, group_dimension, plan, report, integration.
​
object
The resource whose dependents were analyzed.
​
integer
Number of dependents, the length of dependencies. Zero means nothing references the resource.
​
object[]
Rollup of dependencies per nature; natures with no dependent are omitted.
​
object[]
Every dependent, ordered by nature then name.