GET
/
public
/
v3
/
documents
/
reports
/
{id}
/
summary
Retrieve a report summary
curl --request GET \
  --url https://api.quartr.com/public/v3/documents/reports/{id}/summary \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "id": 1343,
    "summary": "Q2 FY24 saw revenue decline and net loss, but IPO-driven debt reduction strengthened the balance sheet.<document-source>documentData_20677_20051795_17</document-source><document-source>documentData_20677_20051818_5</document-source>",
    "sources": [
      {
        "sourceId": "documentData_4742_15110876_1",
        "documentId": 3456,
        "page": 2,
        "timestamp": 110,
        "typeId": 10
      }
    ],
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
number
required

Query Parameters

​
length
enum<string>
default:short

Length preset for the summary.

Available options:
line,
short,
long
Example:

"long"

​
plain
boolean
default:false

Plain text summary without document sources embedded.

Example:

true

Response

The response is of type object.