Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Results Summary

Share Results Summary

Use this API to share data discovery results summary with the data subject via email. The API supports sharing results in CSV or PDF format. When sharing as PDF, you must provide a report template ID to customize the output format.

🗒 Things to Know

  • The report template ID (not name) must be provided for PDF reports.
  • The API processes sharing asynchronously. For tracking, you can either mark a specific subtask as complete\n by providing the subtaskId (the request will auto-progress when the subtask is completed), or you can mark the entire request as complete using the markRequestAsComplete flag.
  • Comments in the request body support HTML content and will be sanitized.
  • The report name format is: {YYYYMMD}_{RequestRefId}___Report (e.g., 2025113_HMVBKRYTYE___Report).
post/api/datasubject/v2/requestqueues/results-summary/share/{requestQueueRefId}

Path parameters

requestQueueRefIdstring required

Request Reference ID (10-character ID that is unique to each request)

Request body

OR

Example request

{
  "comment": "<p>Please review the <strong>attached summary</strong>.</p>",
  "markRequestAsComplete": true,
  "subtaskId": "76e50bb5-cd9c-4af2-88ff-ab0f8cba9e9b",
  "reportType": "CSV"
}

Response

OK