Outline · Example Payload

Documentsinsights

Documents

Documentsinsights is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

Raw ↑ 
{
  "operationId": "documentsInsights",
  "path": "/documents.insights",
  "method": "POST",
  "summary": "Retrieve insights for a document",
  "tags": [
    "Documents"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "format": "uuid",
        "description": "Unique identifier for the document."
      },
      "startDate": {
        "type": "string",
        "format": "date-time",
        "description": "Start of the insights window (inclusive). Defaults to 30 days ago."
      },
      "endDate": {
        "type": "string",
        "format": "date-time",
        "description": "End of the insights window (inclusive). Defaults to today."
      }
    },
    "required": [
      "id"
    ]
  }
}