API to Create Reports for Structured Datasource

---

1. Authentication

Obtain 'x-access-token'

Authenticate with the system to obtain an x-access-token. This token must be included in all client requests for server validation.

It can be obtained from this end-point.

Request URL

Method	URL
POST	auth/realms/master/protocol/openid-connect/token

Headers

Key	Values
Content-Type	application/x-www-form-urlencoded

Body (each key value in 'x-www-form-urlencoded' form)

Key	Values
grant_type	password
client_id	admin-cli
username	<username>
password	<password>

---

2. Get Datasource ID

Request URL

Method	URL
GET	api/datasources

Headers

Key	Values
x-access-token	string

This will fetch a list of all available data sources in the system. Copy the ID of the datasource for which the report is to be fetched.

3. Create new reports

Request URL

Method	URL
POST	/api/reports

Headers

Key	Values
x-access-token	string

Request

Key	Values
reportFormat	enum [CSV, JSON] CSV -> Generate Report in CSV format JSON -> Generate Report in JSON format
reportType	enum [TABLE_LIST, FILE_LIST, ENTITY-LIST, DSR_REQUEST_LIST] TABLE_LIST -> For structured datasource, TABLE_LIST option is to be used to generate table view reports. FILE LIST -> To generate file view report. ENTITY-LIST -> To generate entity view reports. DSR_REQUEST_LIST -> To generate a DSR ticket report.
parameters	list[objects] [{ “key”: <string>, “value”: <string> },...] Individual objects (Parameters -> objects) are defined below.
Parameters -> objects
key	enum [DATASOURCE_ID, CURSOR] DATASOURCE_ID -> ID of the structured data source whose report needs to be generated. CURSOR -> This is internal field used to pagination, since only full report generation is supported you need to pass this as empty (i.e “”)
values	string

Sample Request Body

{
  "reportFormat": "CSV",
  "reportType": "TABLE_LIST",
  "parameters": [
    {
      "key": "DATASOURCE_ID",
      "values": "640594b9b09f97ee2e49adeb"
    },
    {
      "key": "CURSOR",
      "values": ""
    }
  ]
}

Sample Response Body

Instance Name,Database Name,Table Name,Schema,Column Name,Attribute Type,Attribute Instance Count,Attribute Sensitivity,Maybe Sensitive - Yes/No,Maybe PII Reason,Data Type,Review Status,Datasource Name
35.192.10.4:3306,lightbeam,basic_info,default,address,address,Count unavailable since Table cluster is not created,medium,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,lightbeam,basic_info,default,email,EMAIL_ADDRESS,Count unavailable since Table cluster is not created,medium,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,lightbeam,basic_info,default,gender,GENDER,Count unavailable since Table cluster is not created,low,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,arpit_test_db,credit_card_2_2_1,default,Borrower1SSN,US_SSN,Count unavailable since Table cluster is not created,high,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,arpit_test_db,credit_card_2_2_1,default,BorrowerSSN,US_SSN,Count unavailable since Table cluster is not created,high,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,arpit_test_db,credit_card_2_2_1,default,TIN,US_ITIN,Count unavailable since Table cluster is not created,high,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,lightbeam,email,default,email,EMAIL_ADDRESS,Count unavailable since Table cluster is not created,medium,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,lightbeam,entities,default,ssn,US_SSN,100000,high,No,N/A,varchar,Reviewed,mysql

Include Row Count in Report for SQL datasources

For SQL datasources we can include Non Null Row Count for a specific column in TABLE_LIST report.

While Upgrade change structDataIncludeNonNullRowCounts value to true to include Row Count columns in report.

structDataIncludeNonNullRowCounts:
  enabled: true

After enabling this flag report should have Row Count and Row Count Fetch Time columns.

Sample Response (Including Row Count)

The report output now includes an new column named Row Count , which represents the total number of non null rows returned for the column in the result set.

Instance Name,Database Name,Table Name,Schema,Column Name,Row Count,Row Count Fetch Time,Attribute Type,Attribute Instance Count,Attribute Sensitivity,Maybe Sensitive - Yes/No,Maybe PII Reason,Data Type,Review Status,Datasource Name
35.192.10.4:3306,lightbeam,basic_info,default,address,5000,2026-01-14 10:52:25 UTC,address,Count unavailable since Table cluster is not created,medium,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,lightbeam,basic_info,default,email,5000,2026-01-14 10:52:25 UTC,EMAIL_ADDRESS,Count unavailable since Table cluster is not created,medium,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,lightbeam,basic_info,default,gender,5000,2026-01-14 10:52:25 UTC,GENDER,Count unavailable since Table cluster is not created,low,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,arpit_test_db,credit_card_2_2_1,default,Borrower1SSN,16,2026-01-14 10:52:25 UTC,US_SSN,Count unavailable since Table cluster is not created,high,No,N/A,text,Unreviewed,mysql
35.192.10.4:3306,arpit_test_db,credit_card_2_2_1,default,BorrowerSSN,16,2026-01-14 10:52:25 UTC,US_SSN,Count unavailable since Table cluster is not created,high,No,N/A,text,Unreviewed,mysql

Response Codes

Status	Response	Description
200	File will be downloaded.	Indicates a successful operation.
422	{"error":"Validation error."}	A validation error occurred.
401	{"error":"Unauthorized."}	The user is not authorized.
500	{"error":"Something went wrong. Please try again later."}	A server-side error occurred.

---

Postman Collection

3KB

Lightbeam APIs.postman_collection.json

Open

Postman collection for Lightbeam APIs

744B

Lightbeam APIs.postman_environment.json

Open

Postman Environment for Lightbeam APIs

---

About LightBeam

LightBeam automates Privacy, Security, and AI Governance, so businesses can accelerate their growth in new markets. Leveraging generative AI, LightBeam has rapidly gained customers’ trust by pioneering a unique privacy-centric and automation-first approach to security. Unlike siloed solutions, LightBeam ties together sensitive data cataloging, control, and compliance across structured and unstructured data applications providing 360-visibility, redaction, self-service DSRs, and automated ROPA reporting ensuring ultimate protection against ransomware and accidental exposures while meeting data privacy obligations efficiently. LightBeam is on a mission to create a secure privacy-first world helping customers automate compliance against a patchwork of existing and emerging regulations.

For any questions or suggestions, please get in touch with us at: [email protected].