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
GET
Generate a report of all the data sources that all users are currently subscribed to.
GET
Generate a report of all current users and details about them.
GET
Generate a report of the data sources the specified user is currently subscribed to.
GET
Generate a report of the groups the specified user is currently a member of.
GET
Generate a report of the projects the specified user is currently a member of.
GET
Generate a report of all the purposes the user has accessed data for during the specified date range.
GET
Generate a report of all the data sources the user has directly accessed during the specified date range.
GET
Generate a report of all the attributes the specified user currently has.
GET
Generate a report of all the data sources that any member in any group is subscribed to.
GET
Generate a report of all the users who are currently a member of the group.
GET
Generate a report of all the data sources that members of the group are currently subscribed to.
GET
Generate a report of all the projects that the members of the group are currently subscribed to.
GET
Generate a report of all the attributes currently assigned to the specified group.
GET
Generate a report of all the data sources and members currently in the project.
GET
Generate a report of all the data sources currently in the specified project.
GET
Generate a report of all the purposes currently assigned to the specified project.
GET
Generate a report of every user and group currently subscribed to any data source.
GET
Generate a report of the all the users and groups currently subscribed to the specified data source.
GET
Generate a report of the projects that currently have the specified data source.
GET
Generate a report of the purpose of every project that has the specified data source.
GET
Generate a report of the users that have accessed the data source during the specified date range.
GET
Generate a report of the purposes the data source has been accessed for during the specified date range.
GET
Generate a report of the users and groups that have been subscribed to the data source during the specified data range.
GET
Generate a report of data discovery scoring information for every column in the specified data source.
GET
Generate a report of all current members of the projects that use the purpose.
GET
Generate a report of all current data sources of the projects that use the specified purpose.
GET
Generate a report of all other purposes currently combined with the specified purpose.
GET
Generate a report of projects with the specified purpose currently assigned.
GET
Generate a report of data sources that have been accessed for the purpose during the specified date range.
GET
Generate a report of the users who have subscribed to data sources that were tagged with any tag since the specified start date.
GET
Generate a report of the projects with data sources currently tagged with any tag.
GET
Generate a report of every data source currently tagged with any tag.
GET
Generate a report of the data sources currently tagged with the specified tag.
GET
Generate a report of users who have accessed data sources tagged with the specified tag during the specified date range.
GET
Generate a report of the purposes that have been used to access data with the specified tag during the specified date range.
GET
Generate a report of the projects that have data sources currently tagged with this tag.
GET
Generate a report of the data sources this data policy type is currently applied to.
GET
Generate a report of all disabled global policies.
GET
Generate a report of all policies currently in conflict.
GET
Generate a report of all data sources the specified policy has not been certified on.
GET
Generate a report of all data sources the specified policy has been certified on.
GET
Generate a report of all data sources the specified global policy is applied to.
GET
Generate a report of all columns with Discovered tags currently applied.
GET
Generate a report of all columns with legacy Discovered tags currently applied.
GET /governance/reports/user/allUserDataSources
GET /governance/reports/user/allUserDataSourcesGenerate a report of all the data sources that all users are currently subscribed to.
Query parameters
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
GET /governance/reports/user/allUserStatusGenerate a report of all current users and details about them.
Query parameters
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
GET /governance/reports/user/{userId}/dataSourceGenerate a report of the data sources the specified user is currently subscribed to.
Query parameters
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
GET /governance/reports/user/{userId}/groupGenerate a report of the groups the specified user is currently a member of.
Request parameter
userId number
The unique identifier of the user.
Required
Query parameters
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
GET /governance/reports/user/{userId}/projectGenerate a report of the projects the specified user is currently a member of.
Request parameter
userId number
The unique identifier of the user.
Required
Query parameters
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
GET /governance/reports/user/{userId}/dataSourcePurposeAccessGenerate a report of all the purposes the user has accessed data for during the specified date range.
Request parameter
userId number
The unique identifier of the user.
Required
Query parameters
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
GET /governance/reports/user/{userId}/dataSourceUserAccessGenerate a report of all the data sources the user has directly accessed during the specified date range.
Request parameter
userId number
The unique identifier of the user.
Required
Query parameters
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
GET /governance/reports/user/{userId}/attributeGenerate a report of all the attributes the specified user currently has.
Request parameter
userId number
The unique identifier of the user.
Required
Query parameters
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
GET /governance/reports/group/allGroupDataSourceAccessGenerate a report of all the data sources that any member in any group is subscribed to.
Query parameters
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
GET /governance/reports/group/{groupId}/userGenerate a report of all the users who are currently a member of the group.
Request parameter
groupId number
The unique identifier of the group.
Required
Query parameters
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
GET /governance/reports/group/{groupId}/dataSourceGenerate a report of all the data sources that members of the group are currently subscribed to.
Request parameter
groupId number
The unique identifier of the group.
Required
Query parameters
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
GET /governance/reports/group/{groupId}/projectGenerate a report of all the projects that the members of the group are currently subscribed to.
Request parameter
groupId number
The unique identifier of the group.
Required
Query parameters
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
GET /governance/reports/group/{groupId}/attributeGenerate a report of all the attributes currently assigned to the specified group.
Request parameter
groupId number
The unique identifier of the group.
Required
Query parameters
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
GET /governance/reports/project/{projectId}/userGenerate a report of all the data sources and members currently in the project.
Request parameter
projectId number
The unique identifier of the project.
Required
Query parameters
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
GET /governance/reports/project/{projectId}/dataSourceGenerate a report of all the data sources currently in the specified project.
Request parameter
projectId number
The unique identifier of the project.
Required
Query parameters
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
GET /governance/reports/project/{projectId}/purposeGenerate a report of all the purposes currently assigned to the specified project.
Request parameter
projectId number
The unique identifier of the project.
Required
Query parameters
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
GET /governance/reports/dataSource/allDataSourceUsersGenerate a report of every user and group currently subscribed to any data source.
Query parameters
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
GET /governance/reports/dataSource/{dataSourceId}/userGenerate a report of the all the users and groups currently subscribed to the specified data source.
Request parameter
dataSourceId number
The unique identifier of the data source.
Required
Query parameters
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
GET /governance/reports/dataSource/{dataSourceId}/projectGenerate a report of the projects that currently have the specified data source.
Request parameter
dataSourceId number
The unique identifier of the data source.
Required
Query parameters
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
GET /governance/reports/dataSource/{dataSourceId}/purposeGenerate a report of the purpose of every project that has the specified data source.
Request parameter
dataSourceId number
The unique identifier of the data source.
Required
Query parameters
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
GET /governance/reports/dataSource/{dataSourceId}/dataSourceUserAccessGenerate a report of the users that have accessed the data source during the specified date range.
Request parameter
dataSourceId number
The unique identifier of the data source.
Required
Query parameters
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
GET /governance/reports/dataSource/{dataSourceId}/dataSourcePurposeAccessGenerate a report of the purposes the data source has been accessed for during the specified date range.
Request parameter
dataSourceId number
The unique identifier of the data source.
Required
Query parameters
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
GET /governance/reports/dataSource/{dataSourceId}/subscriptionHistoryGenerate a report of the users and groups that have been subscribed to the data source during the specified data range.
Request parameter
dataSourceId number
The unique identifier of the data source.
Required
Query parameters
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
GET /governance/reports/dataSource/{dataSourceId}/dataSourceSddScoringGenerate a report of data discovery scoring information for every column in the specified data source.
Request parameter
dataSourceId number
The unique identifier of the data source.
Required
Query parameters
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
GET /governance/reports/purpose/{purposeId}/userGenerate a report of all current members of the projects that use the specified purpose.
Request parameter
purposeId string
The unique identifier of the purpose.
Required
Query parameters
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
GET /governance/reports/purpose/{purposeId}/dataSourceGenerate a report of all current data sources of the projects that use the specified purpose.
Request parameter
purposeId string
The unique identifier of the purpose.
Required
Query parameters
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
GET /governance/reports/purpose/{purposeId}/purposeGenerate a report of all other purposes currently combined with the specified purpose.
Request parameter
purposeId string
The unique identifier of the purpose.
Required
Query parameters
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
GET /governance/reports/purpose/{purposeId}/projectGenerate a report of projects with the specified purpose currently assigned.
Request parameter
purposeId string
The unique identifier of the purpose.
Required
Query parameters
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
GET /governance/reports/purpose/{purposeId}/dataSourcePurposeAccessGenerate a report of data sources that have been accessed for the specified purpose during the specified date range.
Request parameter
purposeId number
The unique identifier of the purpose.
Required
Query parameters
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
GET /governance/reports/tag/allDataSourceUserAccessGenerate a report of the users who have subscribed to data sources that were tagged with any tag since the specified start date.
Query parameters
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
GET /governance/reports/tag/allProjectsGenerate a report of the projects with data sources currently tagged with any tag.
Query parameters
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
GET /governance/reports/tag/allUserDataSourcesGenerate a report of every data source currently tagged with any tag.
Query parameters
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
GET /governance/reports/tag/{tagName}/dataSourceGenerate a report of the data sources currently tagged with the specified tag.
Request parameter
tagName string
The tag name.
Required
Query parameters
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
GET /governance/reports/tag/{tagName}/dataSourceUserAccessGenerate a report of users who have accessed data sources tagged with the specified tag during the specified date range.
Request parameter
tagName string
The tag name.
Required
Query parameters
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
GET /governance/reports/tag/{tagName}/dataSourcePurposeAccessGenerate a report of the purposes that have been used to access data with the specified tag during the specified date range.
Request parameter
tagName string
The tag name.
Required
Query parameters
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
GET /governance/reports/tag/{tagName}/projectGenerate a report of the projects that have data sources currently tagged with this tag.
Request parameter
tagName string
The tag name.
Required
Query parameters
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
GET /governance/reports/policy/{policyType}/dataSourceGenerate a report of the data sources this data policy type is currently applied to.
Request parameter
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
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
GET /governance/reports/globalPolicy/globalPolicyDisabledGenerate a report of all disabled global policies.
Query parameters
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
GET /governance/reports/globalPolicy/globalPolicyInConflictGenerate a report of all policies currently in conflict.
Query parameters
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
GET /governance/reports/globalPolicy/{policyId}/globalPolicyNotCertifiedGenerate a report of all data sources the specified policy has not been certified on.
Request parameter
policyId number
The unique identifier of the policy.
Required
Query parameters
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
GET /governance/reports/globalPolicy/{policyId}/globalPolicyCertifiedGenerate a report of all data sources the specified policy has been certified on.
Request parameter
policyId number
The unique identifier of the policy.
Required
Query parameters
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
GET /governance/reports/globalPolicy/{policyId}/dataSourceGenerate a report of all data sources the specified global policy is applied to.
Request parameter
policyId number
The unique identifier of the policy.
Required
Query parameters
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
GET /governance/reports/sdd/sddTagsOverviewGenerate a report of all columns with Discovered tags currently applied.
Query parameters
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
GET /governance/reports/sdd/legacySddTagsGenerate a report of all columns with legacy Discovered tags currently applied.
Query parameters
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
Example response
Last updated