Generate Governance Reports

Governance API reference guide

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

Additional fields may be included in some responses you receive; however, these attributes

are for internal purposes and are therefore undocumented.

Endpoints

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

GET /governance/reports/user/allUserDataSources

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

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/user/allUserStatus

Generate a report of all current users and details about them.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/user/{userId}/dataSource

Generate a report of the data sources the specified user is currently subscribed to.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/user/{userId}/group

Generate a report of the groups the specified user is currently a member of.

Request parameter

Parameter	Description	Required or optional
userId number	The unique identifier of the user.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/user/{userId}/project

Generate a report of the projects the specified user is currently a member of.

Request parameter

Parameter	Description	Required or optional
userId number	The unique identifier of the user.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/user/{userId}/dataSourcePurposeAccess

Generate a report of all the purposes the user has accessed data for during the specified date range.

Request parameter

Parameter	Description	Required or optional
userId number	The unique identifier of the user.	Required

Query parameters

Parameter	Description	Required or optional
startDate string	The beginning date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
endDate string	The ending date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/user/{userId}/dataSourceUserAccess

Generate a report of all the data sources the user has directly accessed during the specified date range.

Request parameter

Parameter	Description	Required or optional
userId number	The unique identifier of the user.	Required

Query parameters

Parameter	Description	Required or optional
startDate string	The beginning date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
endDate string	The ending date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/user/{userId}/attribute

Generate a report of all the attributes the specified user currently has.

Request parameter

Parameter	Description	Required or optional
userId number	The unique identifier of the user.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/group/allGroupDataSourceAccess

Generate a report of all the data sources that any member in any group is subscribed to.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/group/{groupId}/user

Generate a report of all the users who are currently a member of the group.

Request parameter

Parameter	Description	Required or optional
groupId number	The unique identifier of the group.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/group/{groupId}/dataSource

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

Request parameter

Parameter	Description	Required or optional
groupId number	The unique identifier of the group.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/group/{groupId}/project

Generate a report of all the projects that the members of the group are currently subscribed to.

Request parameter

Parameter	Description	Required or optional
groupId number	The unique identifier of the group.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/group/{groupId}/attribute

Generate a report of all the attributes currently assigned to the specified group.

Request parameter

Parameter	Description	Required or optional
groupId number	The unique identifier of the group.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/project/{projectId}/user

Generate a report of all the data sources and members currently in the project.

Request parameter

Parameter	Description	Required or optional
projectId number	The unique identifier of the project.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/project/{projectId}/dataSource

Generate a report of all the data sources currently in the specified project.

Request parameter

Parameter	Description	Required or optional
projectId number	The unique identifier of the project.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/project/{projectId}/purpose

Generate a report of all the purposes currently assigned to the specified project.

Request parameter

Parameter	Description	Required or optional
projectId number	The unique identifier of the project.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/dataSource/allDataSourceUsers

Generate a report of every user and group currently subscribed to any data source.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/dataSource/{dataSourceId}/user

Generate a report of the all the users and groups currently subscribed to the specified data source.

Request parameter

Parameter	Description	Required or optional
dataSourceId number	The unique identifier of the data source.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/dataSource/{dataSourceId}/project

Generate a report of the projects that currently have the specified data source.

Request parameter

Parameter	Description	Required or optional
dataSourceId number	The unique identifier of the data source.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/dataSource/{dataSourceId}/purpose

Generate a report of the purpose of every project that has the specified data source.

Request parameter

Parameter	Description	Required or optional
dataSourceId number	The unique identifier of the data source.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/dataSource/{dataSourceId}/dataSourceUserAccess

Generate a report of the users that have accessed the data source during the specified date range.

Request parameter

Parameter	Description	Required or optional
dataSourceId number	The unique identifier of the data source.	Required

Query parameters

Parameter	Description	Required or optional
startDate string	The beginning date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
endDate string	The ending date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/dataSource/{dataSourceId}/dataSourcePurposeAccess

Generate a report of the purposes the data source has been accessed for during the specified date range.

Request parameter

Parameter	Description	Required or optional
dataSourceId number	The unique identifier of the data source.	Required

Query parameters

Parameter	Description	Required or optional
startDate string	The beginning date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
endDate string	The ending date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/dataSource/{dataSourceId}/subscriptionHistory

Generate a report of the users and groups that have been subscribed to the data source during the specified data range.

Request parameter

Parameter	Description	Required or optional
dataSourceId number	The unique identifier of the data source.	Required

Query parameters

Parameter	Description	Required or optional
startDate string	The beginning date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
endDate string	The ending date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/dataSource/{dataSourceId}/dataSourceSddScoring

Generate a report of data discovery scoring information for every column in the specified data source.

Request parameter

Parameter	Description	Required or optional
dataSourceId number	The unique identifier of the data source.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/purpose/{purposeId}/user

Generate a report of all current members of the projects that use the specified purpose.

Request parameter

Parameter	Description	Required or optional
purposeId string	The unique identifier of the purpose.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/purpose/{purposeId}/dataSource

Generate a report of all current data sources of the projects that use the specified purpose.

Request parameter

Parameter	Description	Required or optional
purposeId string	The unique identifier of the purpose.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/purpose/{purposeId}/purpose

Generate a report of all other purposes currently combined with the specified purpose.

Request parameter

Parameter	Description	Required or optional
purposeId string	The unique identifier of the purpose.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/purpose/{purposeId}/project

Generate a report of projects with the specified purpose currently assigned.

Request parameter

Parameter	Description	Required or optional
purposeId string	The unique identifier of the purpose.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/purpose/{purposeId}/dataSourcePurposeAccess

Generate a report of data sources that have been accessed for the specified purpose during the specified date range.

Request parameter

Parameter	Description	Required or optional
purposeId number	The unique identifier of the purpose.	Required

Query parameters

Parameter	Description	Required or optional
startDate string	The beginning date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
endDate string	The ending date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/tag/allDataSourceUserAccess

Generate a report of the users who have subscribed to data sources that were tagged with any tag since the specified start date.

Query parameters

Parameter	Description	Required or optional
startDate string	The date to start the report at. Must be within 90 days of the current date. Ex: 2024-10-07	Required
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/tag/allProjects

Generate a report of the projects with data sources currently tagged with any tag.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/tag/allUserDataSources

Generate a report of every data source currently tagged with any tag.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/tag/{tagName}/dataSource

Generate a report of the data sources currently tagged with the specified tag.

Request parameter

Parameter	Description	Required or optional
tagName string	The tag name.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/tag/{tagName}/dataSourceUserAccess

Generate a report of users who have accessed data sources tagged with the specified tag during the specified date range.

Request parameter

Parameter	Description	Required or optional
tagName string	The tag name.	Required

Query parameters

Parameter	Description	Required or optional
startDate string	The beginning date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
endDate string	The ending date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/tag/{tagName}/dataSourcePurposeAccess

Generate a report of the purposes that have been used to access data with the specified tag during the specified date range.

Request parameter

Parameter	Description	Required or optional
tagName string	The tag name.	Required

Query parameters

Parameter	Description	Required or optional
startDate string	The beginning date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
endDate string	The ending date of the date range. Must be within 90 days of the current date. Ex: 2024-10-07	Required
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/tag/{tagName}/project

Generate a report of the projects that have data sources currently tagged with this tag.

Request parameter

Parameter	Description	Required or optional
tagName string	The tag name.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/policy/{policyType}/dataSource

Generate a report of the data sources this data policy type is currently applied to.

Request parameter

Parameter	Description	Required or optional
policyType string	The type of policy to generate a report on. Options include: exemption, visibility, masking, time, minimization, external, prerequisite, customWhere, and showRowsNever	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/globalPolicy/globalPolicyDisabled

Generate a report of all disabled global policies.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/globalPolicy/globalPolicyInConflict

Generate a report of all policies currently in conflict.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/globalPolicy/{policyId}/globalPolicyNotCertified

Generate a report of all data sources the specified policy has not been certified on.

Request parameter

Parameter	Description	Required or optional
policyId number	The unique identifier of the policy.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/globalPolicy/{policyId}/globalPolicyCertified

Generate a report of all data sources the specified policy has been certified on.

Request parameter

Parameter	Description	Required or optional
policyId number	The unique identifier of the policy.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/globalPolicy/{policyId}/dataSource

Generate a report of all data sources the specified global policy is applied to.

Request parameter

Parameter	Description	Required or optional
policyId number	The unique identifier of the policy.	Required

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/sdd/sddTagsOverview

Generate a report of all columns with Discovered tags currently applied.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

GET /governance/reports/sdd/legacySddTags

Generate a report of all columns with legacy Discovered tags currently applied.

Query parameters

Parameter	Description	Required or optional
size number	The number of results to return per page.	Optional
offset number	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 domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.	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

Example request

curl -X 'GET' \
  'https://www.organization.immuta.com/governance/reports/user/allUserDataSources' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer c3e78316bd2a4f329156a9c8fcd7dd8f'

Example response

{
  "hits": [
    {
      "User": "Taylor Smith",
      "Data Source ID": 996,
      "Data Source": "Public Patientinfo",
      "Owners": "Taylor Smith",
      "Role": "Owner",
      "Subscription Type": "Individual User",
      "Last Subscription Date": "2024-09-10 15:17 UTC",
      "Approvers": "Taylor Smith",
      "Subscription Expiration": null,
      "User Groups": null,
      "Attributes": null
    },
    {
      "User": "Taylor Smith",
      "Data Source ID": 999,
      "Data Source": "Public Fftest",
      "Owners": "Taylor Smith",
      "Role": "Owner",
      "Subscription Type": "Individual User",
      "Last Subscription Date": "2024-09-10 15:17 UTC",
      "Approvers": "Taylor Smith",
      "Subscription Expiration": null,
      "User Groups": null,
      "Attributes": null
    },
    {
      "User": "Taylor Smith",
      "Data Source ID": 1000,
      "Data Source": "Public Patientbilling",
      "Owners": "Taylor Smith",
      "Role": "Owner",
      "Subscription Type": "Individual User",
      "Last Subscription Date": "2024-09-10 15:17 UTC",
      "Approvers": "Taylor Smith",
      "Subscription Expiration": null,
      "User Groups": null,
      "Attributes": null
    },
    {
      "User": "John Doe",
      "Data Source ID": 417,
      "Data Source": "Builtin Classifier Test2",
      "Owners": "John Doe",
      "Role": "Owner",
      "Subscription Type": "Group: Discover Team",
      "Last Subscription Date": "2024-05-30 19:42 UTC",
      "Approvers": "John Doe",
      "Subscription Expiration": null,
      "User Groups": "Discover Team",
      "Attributes": null
    },
    {
      "User": "John Doe",
      "Data Source ID": 775,
      "Data Source": "Classify Test Case",
      "Owners": "John Doe",
      "Role": "Owner",
      "Subscription Type": "Individual User",
      "Last Subscription Date": "2024-06-12 22:30 UTC",
      "Approvers": "John Doe",
      "Subscription Expiration": null,
      "User Groups": "Discover Team",
      "Attributes": null
    }
  ]
}