QIMA Logo
Documents

Report Introduction

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

The Report module lets you search inspection reports, retrieve PDF report file metadata (for download via the File module), and fetch the full interactive report data for a specific inspection product.

This page documents the shared setup used by every Report guide. Each API-specific guide links back here for authentication, headers, and environment details.

Base URL

All Report APIs are served from the QIMA Public API host for your environment:

https://ppapi.qima.com

For production integrations, replace the host with the QIMA API host provided for your environment.

Required Headers

Call the Auth API first (POST /auth/v2/token) before any Report request. See the Getting Started Guide or Get Token API for authentication setup.

HeaderLocationSourceDescription
Ai-Api-Access-TokenRequest header (all Report APIs)Provided by QIMARequest source identifier. Each client may have a different value per environment.
Ai-User-IdRequest header (all Report APIs)Auth API response userIdQIMA client user login ID of the authenticated user.
AuthorizationRequest header (all Report APIs)Auth API access tokenFormat: Bearer <access-token>. Use the token from the same Auth API session as the other headers.
RefererRequest header (all Report APIs)Fixed valuehttps://preprodmy.qima.com/

Common Authentication Errors

StatusMeaningRecommended Action
401 UnauthorizedToken or user authentication failed.Confirm the Authorization, Ai-User-Id, and Ai-Api-Access-Token headers are from the same Auth API session and environment.
403 ForbiddenThe user does not have access to the requested resource.Verify account permissions for the target Report operation.

Common Response Shape

Every Report API wraps its data in the same envelope:

{
  "message": null,
  "content": "... the actual data, shape varies per API ..."
}

Available APIs

APIMethodEndpointGuideAPI Reference
Search inspection reportsGET/user/{userId}/reportsSearch GuideAPI Reference
Get inspection PDF report file infoGET/user/{userId}/report/{productId}/pdf-infoPDF Info GuideAPI Reference
Get inspection interactive report detailsGET/user/{userId}/interactive-report/{productId}Interactive Report GuideAPI Reference

Integration Workflow

1. POST /auth/v2/token
2. GET /user/{userId}/reports
Search by date range, keyword, status
Read orderId + productId from pageItems
What do you need?
3a. GET /user/{userId}/report/{productId}/pdf-info
Get downloadable PDF file info
4. GET /user/{userId}/file/{fileId}
Download the PDF
3b. GET /user/{userId}/interactive-report/{productId}
orderId required as query param
StepGuide
Search reportsSearch Guide
Get PDF report file info, then downloadPDF Info Guide, File Download Guide
Get the full interactive report dataInteractive Report Guide

Choosing the Right API

Your goalRecommended APIs
List or filter inspection reportsSearch Inspection Reports
Download the PDF reportGet PDF Report File Info + Download a File by ID
Render an interactive/on-screen report viewGet Interactive Report Details