Revenue

Download the report

Download the report saves this audit as Markdown. The request uses format md. The file names the open promises, who owes them, and the message that created each one.

get/v1/revenue-leak-scans/{scanId}/report

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /v1/revenue-leak-scans/{scanId}/report
Auth: HTTP bearer

Path parameters

scanIdstring uuid required

Example:4d8dfa9b-a7b2-46ea-982c-622a914c00e5

Scan id.

Query parameters

formatstring

Export format.

Example:md

md for the file Download the report saves.

Response

The report.

byAccountobject required

Open promise count by account.

generatedAtstring date-time required

When the report was produced.

inboundCountinteger required

Promises made to us.

lookbackDaysinteger required

Scan window in days.

outboundCountinteger required

Promises we made.

scanStatusstring required

Scan status.

threadsSeeninteger required

Conversations read.

truncatedboolean required

Whether more than 200 matching promises exist.

Example response

{
  "byAccount": {
    "Acme": 1
  },
  "generatedAt": "2026-09-09T12:00:00Z",
  "items": [
    {
      "account": "Acme",
      "commitmentId": "8b8dfa9b-a7b2-46ea-982c-622a914c00e5",
      "direction": "promised_by_me",
      "dueAt": "2026-09-14T17:00:00Z",
      "duePhrase": "by the 14th",
      "occurredAt": "2026-09-06T12:00:00Z",
      "owner": "alex@example.com",
      "sourceQuote": "We will have the migration live by the 14th.",
      "sourceUri": "https://mail.google.com/thread-1",
      "state": "at_risk",
      "text": "Migration live by the 14th"
    }
  ],
  "lookbackDays": 180,
  "outboundCount": 1,
  "scanStatus": "completed",
  "threadsSeen": 412
}

Changes

No recorded changes to this operation across all 50 revisions of this API.