> For the complete documentation index, see [llms.txt](https://documentation.immuta.com/SaaS/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.immuta.com/SaaS/developer-guides/api-intro/immuta-v1-api/generate-governance-reports.md).

# Generate Governance Reports

This page describes the `governance` endpoint of the Immuta API and its request parameters used to generate governance reports.

{% hint style="info" %}
Additional fields may be included in some responses you receive; however, these attributes

are for internal purposes and are therefore undocumented.
{% endhint %}

{% hint style="warning" %}
**Default 9-minute timeout**

Governance report queries will time out after 9 minutes to avoid overconsumption of resources. If your governance report was not generated because of this timeout, [submit a support ticket](https://support.immuta.com) to change the default setting.
{% endhint %}

## Endpoints

<table><thead><tr><th width="117">Method</th><th>Endpoint</th><th>Description</th></tr></thead><tbody><tr><td><strong>GET</strong></td><td><code>/governance/reports/user/allUserDataSources</code></td><td>Generate a report of all the data sources that all users are currently subscribed to.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/user/allUserStatus</code></td><td>Generate a report of all current users and details about them.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/user/{userId}/dataSource</code></td><td>Generate a report of the data sources the specified user is currently subscribed to.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/user/{userId}/group</code></td><td>Generate a report of the groups the specified user is currently a member of.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/user/{userId}/project</code></td><td>Generate a report of the projects the specified user is currently a member of.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/user/{userId}/dataSourcePurposeAccess</code></td><td>Generate a report of all the purposes the user has accessed data for during the specified date range.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/user/{userId}/dataSourceUserAccess</code></td><td>Generate a report of all the data sources the user has directly accessed during the specified date range.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/user/{userId}/attribute</code></td><td>Generate a report of all the attributes the specified user currently has.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/group/allGroupDataSourceAccess</code></td><td>Generate a report of all the data sources that any group is manually subscribed to.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/group/{groupId}/user</code></td><td>Generate a report of all the users who are currently a member of the group.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/group/{groupId}/dataSource</code></td><td>Generate a report of all the data sources that the group is manually subscribed to.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/group/{groupId}/project</code></td><td>Generate a report of all the projects that the members of the group are currently subscribed to.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/group/{groupId}/attribute</code></td><td>Generate a report of all the attributes currently assigned to the specified group.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/project/{projectId}/user</code></td><td>Generate a report of all the data sources and members currently in the project.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/project/{projectId}/dataSource</code></td><td>Generate a report of all the data sources currently in the specified project.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/project/{projectId}/purpose</code></td><td>Generate a report of all the purposes currently assigned to the specified project.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/dataSource/allDataSourceUsers</code></td><td>Generate a report of every user and group currently subscribed to any data source.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/dataSource/{dataSourceId}/user</code></td><td>Generate a report of all the users and groups currently subscribed to the specified data source.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/dataSource/{dataSourceId}/project</code></td><td>Generate a report of the projects that currently have the specified data source.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/dataSource/{dataSourceId}/purpose</code></td><td>Generate a report of the purpose of every project that has the specified data source.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/dataSource/{dataSourceId}/dataSourceUserAccess</code></td><td>Generate a report of the users that have accessed the data source during the specified date range.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/dataSource/{dataSourceId}/dataSourcePurposeAccess</code></td><td>Generate a report of the purposes the data source has been accessed for during the specified date range.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/dataSource/{dataSourceId}/subscriptionHistory</code></td><td>Generate a report of the users and groups that have been subscribed to the data source during the specified date range.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/dataSource/{dataSourceId}/dataSourceSddScoring</code></td><td>Generate a report of data discovery scoring information for every column in the specified data source.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/purpose/{purposeId}/user</code></td><td>Generate a report of all current members of the projects that use the purpose.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/purpose/{purposeId}/dataSource</code></td><td>Generate a report of all current data sources of the projects that use the specified purpose.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/purpose/{purposeId}/purpose</code></td><td>Generate a report of all other purposes currently combined with the specified purpose.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/purpose/{purposeId}/project</code></td><td>Generate a report of projects with the specified purpose currently assigned.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/purpose/{purposeId}/dataSourcePurposeAccess</code></td><td>Generate a report of data sources that have been accessed for the purpose during the specified date range.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/tag/allDataSourceUserAccess</code></td><td>Generate a report of the users who have subscribed to data sources that were tagged with any tag since the specified start date.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/tag/allProjects</code></td><td>Generate a report of the projects with data sources currently tagged with any tag.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/tag/allUserDataSources</code></td><td>Generate a report of every data source currently tagged with any tag.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/tag/{tagName}/dataSource</code></td><td>Generate a report of the data sources currently tagged with the specified tag.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/tag/{tagName}/dataSourceUserAccess</code></td><td>Generate a report of users who have accessed data sources tagged with the specified tag during the specified date range.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/tag/{tagName}/dataSourcePurposeAccess</code></td><td>Generate a report of the purposes that have been used to access data with the specified tag during the specified date range.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/tag/{tagName}/project</code></td><td>Generate a report of the projects that have data sources currently tagged with this tag.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/policy/{policyType}/dataSource</code></td><td>Generate a report of the data sources this data policy type is currently applied to.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/globalPolicy/globalPolicyDisabled</code></td><td>Generate a report of all disabled global policies.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/globalPolicy/globalPolicyInConflict</code></td><td>Generate a report of all policies currently in conflict.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/globalPolicy/{policyId}/globalPolicyNotCertified</code></td><td>Generate a report of all data sources the specified policy has not been certified on.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/globalPolicy/{policyId}/globalPolicyCertified</code></td><td>Generate a report of all data sources the specified policy has been certified on.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/globalPolicy/{policyId}/dataSource</code></td><td>Generate a report of all data sources the specified global policy is applied to.</td></tr><tr><td><strong>GET</strong></td><td><code>/governance/reports/sdd/sddTagsOverview</code></td><td>Generate a report of all columns with tags applied by identification.</td></tr></tbody></table>

## Example

<mark style="color:green;">`GET`</mark> <mark style="color:green;">`/governance/reports/user/allUserDataSources`</mark>

Generate a report of all the data sources that all users are currently subscribed to.

### **Query parameters**

| Parameter          | Description                                                                                                                                                       | Required or optional |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| size `integer`     | The number of results to return per page.                                                                                                                         | Optional             |
| offset `integer`   | The number of items from the beginning of the response to exclude. You can combine the `offset` and `size` parameters to return a specific set of report results. | Optional             |
| sortField `string` | Used to sort results by field.                                                                                                                                    | Optional             |
| sortOrder `string` | Sorts results by order, which must be `asc` or `desc`. **The default is `asc`.**                                                                                  | Optional             |
| export `boolean`   | If `true`, the response will be provided in a downloadable csv file.                                                                                              | Optional             |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.immuta.com/SaaS/developer-guides/api-intro/immuta-v1-api/generate-governance-reports.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
