Report Interactive Report Guide

Latest Update Time: 2026-07-02 00:00:00

Use this API to retrieve the full interactive report data for a specific inspection product — overall result, assessment breakdown, photos, key indicators, and product/inspection details. This is the data used to render QIMA's on-screen interactive report viewer, as opposed to the static PDF (see Get PDF Report File Info).

See the Report Introduction for base URL, authentication, and required headers.

Endpoint

GET https://ppapi.qima.com/user/{userId}/interactive-report/{productId}

Prerequisites

In addition to the required headers and authentication setup:

Permission to view inspection reports for the target client
An orderId and productId obtained from Search Inspection Reports

Path Parameters

Parameter	Required	Description
`userId`	Yes	QIMA client user login ID.
`productId`	Yes	Inspection product ID, from Search Inspection Reports.

Query Parameters

Parameter	Required	Description
`orderId`	Yes	Inspection order ID, from Search Inspection Reports.
`companyRole`	No	Set to `broker` to retrieve the report visible to the broker role.

Request Example

curl --location --request GET 'https://ppapi.qima.com/user/<qima-user-id>/interactive-report/<product-id>?orderId=<order-id>' \
  --header 'Ai-Api-Access-Token: {your api access token}' \
  --header 'Ai-User-Id: {your user ID}' \
  --header 'Authorization: Bearer {your token}' \
  --header 'Referer: https://preprodmy.qima.com/'

Successful Response

This response is large and deeply nested. The example below is trimmed to show the top-level structure and a representative slice of each section — see the interactive API reference for the complete field list.

{
    "message": "OK",
    "content": {
        "reportId": "3E4B7F366B524AD6840571E9AE28DA14",
        "reportNumber": "R-Cloud-PP-24009476",
        "orderId": "42C61D1AF5954E7F9D9434DCD10F97DB",
        "downloadUrlOfPhotos": "https://ppapi.qima.com/file/download/secure-file-id/<...>",
        "downloadUrlOfReport": "https://ppapi.qima.com/file/download/secure-file-id/<...>",
        "overallResult": {
            "isMissed": true,
            "overallResult": "Fail"
        },
        "assessmentResults": [
            { "color": "#00A876", "label": "Workmanship", "result": "Pass", "secondaryLabel": null, "status": null },
            { "color": "#E5353D", "label": "Checklist & tests", "result": "Fail", "secondaryLabel": null, "status": null }
        ],
        "clientRating": null,
        "clientRatingFeedback": null,
        "reportDecision": {
            "decidedBy": null,
            "decision": "Pending",
            "decisionComments": null,
            "decisionTime": "",
            "productReference": [
                {
                    "decision": "Pending",
                    "productId": "3E4B7F366B524AD6840571E9AE28DA14",
                    "referenceId": "4BE19824FADE4279BE6EF30E8B565C07",
                    "referencePoNumber": "Purchase order no.-A",
                    "referenceQuantity": 333,
                    "referenceSkuNumber": "SKU-prod-1-ref-1"
                }
            ]
        },
        "overview": {
            "overviewDetail": {
                "generalInfo": [
                    { "label": "REPORTS.VIEW_REPORT.PRODUCT", "type": null, "value": "ref-lev-m-2" },
                    { "label": "REPORTS.VIEW_REPORT.PERFORMED_IN", "type": "location", "value": "Shenzhen" }
                ],
                "mainPicture": null
            }
        },
        "photos": [
            {
                "categories": [
                    { "title": "Inspection Details", "photos": [] },
                    { "title": "Colors", "photos": [] }
                ],
                "label": ""
            }
        ],
        "keyIndicator": {
            "isVisible": true,
            "aqlLevel": null,
            "inspectionResultSummary": {
                "checkedCritical": "",
                "foundCritical": "",
                "maxCritical": "",
                "testResults": "",
                "workmanShipResult": ""
            },
            "testAndSpecialRequirement": {
                "passedTests": 0,
                "failedTests": 0,
                "totalTests": 0,
                "checklists": null
            }
        },
        "inspectionDetails": {
            "generalInfo": [
                { "label": "REPORTS.INTERACTIVE_REPORT.SUPPLIER", "type": null, "value": "jack" },
                { "label": "REPORTS.VIEW_REPORT.PERFORMED_IN", "type": "location", "value": "Shenzhen" }
            ],
            "serviceDescription": "Pre-shipment Inspection",
            "serviceType": "PSI"
        },
        "productDetails": {
            "generalInfo": [
                { "label": "REPORTS.INTERACTIVE_REPORT.QUANTITY", "type": null, "value": "888Pcs" }
            ],
            "mainPicture": null,
            "poNumber": "Purchase order no.-A/Purchase order no.-B",
            "productName": "ref-lev-m-2",
            "prodQuantityUnit": "Pcs"
        },
        "reportMetadata": {
            "generalInfo": [
                { "label": "REPORTS.INTERACTIVE_REPORT.SUPPLIER", "value": "jack" }
            ]
        },
        "specialIP": {
            "itemQuantitiesDisplay": false,
            "itemOperaInciDisplay": false,
            "peoIncident": null,
            "items": null,
            "containers": null,
            "peoComplianceCheckpoints": null
        },
        "attachments": null,
        "showSummary": false,
        "aiSummaryStatus": null,
        "userId": null,
        "disableSummaryReportButton": false,
        "performedInQimaone": "0",
        "interactiveReportVersion": "v1"
    }
}

Note: message is "OK" here rather than null — both indicate success.

Response Field Notes

Field	Notes
`downloadUrlOfPhotos` / `downloadUrlOfReport`	Pre-signed, time-limited download URLs — download promptly, don't cache long-term.
`overallResult.overallResult`	Top-level pass/fail result, for example `"Fail"`.
`overallResult.isMissed`	Whether the inspection was missed entirely.
`assessmentResults[]`	One entry per assessment category (Workmanship, Checklist & tests, Specifications, Measurements, etc.), each with its own pass/fail `result` and a `color` for UI rendering.
`reportDecision.decision`	Client's decision on the report, for example `"Pending"`, and per-reference decisions in `productReference[]`.
`overview` / `inspectionDetails` / `productDetails` / `reportMetadata`	Each contains a `generalInfo[]` array of `{label, type, value}` triples. `label` values are i18n translation keys (e.g. `"REPORTS.VIEW_REPORT.PRODUCT"`), not final display text — look them up in your own translation layer, or use `value` directly.
`photos[].categories[]`	One entry per photo category shown in the report UI (Colors, Dimensions, Defects, etc.); `photos` is empty in this capture (no photos uploaded) but is otherwise a list of photo objects.
`keyIndicator`	Summary counts (checked/found/max per defect severity, test pass/fail counts) used for the report's key-indicator widget. Many sub-fields are empty strings rather than `null` when not applicable.
`specialIP`	Special/PEO-specific incident and container data. `null`/empty for non-PEO inspections.
`performedInQimaone`	`"0"` or `"1"` (string, not boolean) indicating whether the inspection was performed in QIMAone.
`interactiveReportVersion`	Schema version of the interactive report data, for example `"v1"`.

Common Errors

See common authentication errors for 401 and 403 responses.

Next Steps

Use Get PDF Report File Info if you need the static PDF instead of/in addition to this interactive data.

Documents