info
Return document summary info including word, character, paragraph, heading, table, image, comment, tracked-change, SDT-field, list, and page counts, plus outline and capabilities.
doc.info(…)Expected result
Returns a DocumentInfo object with counts (words, characters, paragraphs, headings, tables, images, comments, trackedChanges, sdtFields, lists, and optionally pages when pagination is active), document outline, capability flags, and revision.
Inputs
This operation takes no input fields.
Result
Output fields
countsobjectrequiredFields
wordsintegerrequiredcharactersintegerrequiredparagraphsintegerrequiredheadingsintegerrequiredtablesintegerrequiredimagesintegerrequiredcommentsintegerrequiredtrackedChangesintegerrequiredsdtFieldsintegerrequiredlistsintegerrequiredpagesintegeroutlineobject[]requiredcapabilitiesobjectrequiredFields
canFindbooleanrequiredcanGetNodebooleanrequiredcanCommentbooleanrequiredcanReplacebooleanrequiredrevisionstringrequiredstylesobjectStyles currently in use in the document.
Fields
paragraphStylesobject[]requiredParagraph styles in use, sorted by frequency (most common first).
defaultsobjectDocument's default body text formatting. Use these values when creating new content to match existing style.
Fields
fontFamilystringMost common body text font family.
fontSizenumberMost common body text font size in half-points.
styleIdstringMost common body paragraph style ID.
Raw schemas
Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.
View raw JSON schemas