v1
latestOpenAPI 3.0.32026-07-14265579.8 KBReport
Retreive order report resource
When an Order is complete, all the data returned by each of the search components is collected into a comprehensive Report. That report is available as a PDF or as a base64 encoded string representing a complete HTML page, and the path to that URI is exposed in the Reports array on the Order resource. </br></br> Once you have the Report resource you may decode the string, and store as a regular HTML file, a PDF, or parse it directly for specific result contents.
get/report/{reportId}
Path parameters
reportIdstring required
Report ID
Query parameters
typestring
Set this value to PDF to return a PDF version of the report
Response
Success Response
Example response
{
"id": "5d5495c49523ab1b3079ce33",
"resource": "REPORT",
"supportReferenceId": "Y17831466",
"reportFormat": "HTML"
}