get
https://api.sigmacomputing.com/v2/reports/
This endpoint retrieves a report by its unique identifier (reportId). It provides detailed information about the report, including its name, URL, path, and other metadata.
Usage notes
- The reportId parameter must be a valid UUID that uniquely identifies the report. Invalid or nonexistent IDs return an error. Retrieve the reportId by calling the /v2/reports endpoint.
Usage scenarios
- Report search: Allows users to view all of their reports and locate a specific one, as well as filter by criteria such as if it is archived.
- Data retrieval: Developers can use this endpoint to programmatically retrieve details about a specific report to display its content or metadata in a custom user interface.
- Integration: Use this endpoint for integrations where other systems need to fetch report details based on an ID provided through another interface or workflow.
Best practices
- Validate the reportId on the client side before making a request to avoid unnecessary server load caused by invalid requests.