Reports

Retrieve scanner report summaries and detailed page-level report output.

List reports

get

Return scanner report summaries generated from completed scanner runs. Reports can be filtered by brand or searched by name.

Authorizations

bearerApiKey

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Query parameters

brandIdstring · uuidOptional

Filter reports for a specific brand.

searchstringOptional

Case-insensitive search against report names.

limitinteger · min: 1Optional

Maximum number of records to return per page.

Default: 25

offsetintegerOptional

Number of records to skip before starting the page.

Default: 0

sortBystring · enumOptional

Field used to sort the result set.

Possible values:

sortOrderstring · enumOptional

Sort direction for the selected sort field.

Possible values:

Responses

200

Report summaries returned

application/json

Paginated collection of scanner reports.

400

Invalid query parameters

application/json

401

Missing or invalid API key

application/json

429

Rate limit exceeded

application/json

get/api/v1/reports

HTTPcURLJavaScriptPython

GET /api/v1/reports HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "reports": [
    {
      "id": "33333333-3333-3333-3333-333333333333",
      "name": "April Scan",
      "createdAt": "2026-05-15T00:00:00.000Z",
      "brand": {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "Acme"
      },
      "documentCount": 42
    }
  ],
  "page": {
    "limit": 25,
    "offset": 0,
    "count": 1,
    "total": 1
  }
}

Get a report with scanned pages

get

Retrieve a report and the scanned pages or captured documents that make up the report payload.

Authorizations

bearerApiKey

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Path parameters

reportIdstring · uuidRequired

Responses

200

Report detail returned

application/json

Top-level report metadata returned with detailed report responses.

idstring · uuidRequired

namestringRequired

createdAtstring · date-timeRequired

documentCountintegerRequired

400

Missing or invalid report id

application/json

401

Missing or invalid API key

application/json

404

Report not found

application/json

429

Rate limit exceeded

application/json

get/api/v1/reports/{reportId}

HTTPcURLJavaScriptPython

GET /api/v1/reports/{reportId} HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "33333333-3333-3333-3333-333333333333",
  "name": "April Scan",
  "createdAt": "2026-05-15T00:00:00.000Z",
  "brand": {
    "id": "11111111-1111-1111-1111-111111111111",
    "name": "Acme"
  },
  "documentCount": 1,
  "pages": [
    {
      "documentId": "44444444-4444-4444-4444-444444444444",
      "title": "Landing Page",
      "link": "https://example.com/page",
      "fileType": "WEBPAGE",
      "createdAt": "2026-05-15T00:00:00.000Z",
      "lastScannedAt": "2026-05-15T00:00:00.000Z"
    }
  ]
}