Skip to content

Metadata types

Every kind of hidden data a metadata clean finds in Word, Excel, PowerPoint and PDF files, and what the standard and strict presets do to each.

View as Markdown

A metadata clean (clean_metadata on GET /v1/files/{file_id}, or on the MCP server's get_file) reports every kind of hidden data it found by the type names below, in metadata_report.items, with the action it took. The names are stable: match on them.

ActionMeaning
RemovedDeleted from the file
ResetReplaced with a neutral value: the application's name without its version, a template path dropped
AcceptedTracked changes accepted into the text
AnonymizedNames replaced with "Author", the same for every person
ConvertedA field replaced with the text it showed
UnlinkedA link removed, its text kept
AppliedA marked redaction carried out, so the text under it is gone
FlattenedDrawn into the page, so it looks the same and can no longer be edited or read as data
CleanedAn embedded document cleaned the same way as the document around it
KeptLeft in place, and counted in the report
ReportedLeft in place and counted, because removing it would change what the page shows or how the document works: check it before sending

The three choices on a request override the preset for their types: clean_metadata_revisions for tracked_changes, clean_metadata_comments for comments, annotations and page_markup, and clean_metadata_authors for authors and revision_dates.

Properties

What the file says about itself.

TypeWhat it isFormatsstandardstrict
authorWho created the documentWord, Excel, PowerPoint, PDFRemovedRemoved
last_modified_byWho saved it lastWord, Excel, PowerPointRemovedRemoved
creatorThe application that made the PDF's contentPDFRemovedRemoved
producerThe software that wrote the PDFPDFRemovedRemoved
revision_numberHow many times it was savedWord, Excel, PowerPointRemovedRemoved
created_dateWhen it was createdWord, Excel, PowerPoint, PDFRemovedRemoved
modified_dateWhen it was last savedWord, Excel, PowerPoint, PDFRemovedRemoved
printed_dateWhen it was last printedWord, Excel, PowerPointRemovedRemoved
titleThe title property, which is not the heading on the pageWord, Excel, PowerPoint, PDFRemovedRemoved
subjectThe subject propertyWord, Excel, PowerPoint, PDFRemovedRemoved
keywordsThe keywords propertyWord, Excel, PowerPoint, PDFRemovedRemoved
descriptionThe comments property in File › PropertiesWord, Excel, PowerPointRemovedRemoved
categoryThe category propertyWord, Excel, PowerPointRemovedRemoved
content_statusThe status property, such as DraftWord, Excel, PowerPointRemovedRemoved
identifierThe identifier propertyWord, Excel, PowerPointRemovedRemoved
languageThe language propertyWord, Excel, PowerPointRemovedRemoved
versionThe version propertyWord, Excel, PowerPointRemovedRemoved
trappedA PDF's print trapping flagPDFRemovedRemoved
companyThe organization the application is licensed toWord, Excel, PowerPointRemovedRemoved
managerThe manager propertyWord, Excel, PowerPointRemovedRemoved
total_editing_timeHow long the document was open for editingWord, Excel, PowerPointRemovedRemoved
template_nameThe template it was created fromWord, Excel, PowerPointRemovedRemoved
hyperlink_baseThe base path relative links resolve againstWord, Excel, PowerPointRemovedRemoved
applicationThe application and version that saved it, reset to the product name aloneWord, Excel, PowerPointResetReset
document_statisticsPage, word, character, line and paragraph countsWord, Excel, PowerPointRemovedRemoved
part_titlesThe names of the parts (sheets, slides, headings) listed in the propertiesWord, Excel, PowerPointRemovedRemoved
extended_propertiesAny other property the saving application recordedWord, Excel, PowerPointRemovedRemoved
custom_propertiesCustom properties, such as a document management system's matter and client numbersWord, Excel, PowerPoint, PDFRemovedRemoved
sensitivity_labelsMicrosoft Purview sensitivity labels and the label ids behind themWord, Excel, PowerPointKeptRemoved
version_story_idsVersion Story's own ids, from a document saved by the Version Story appWordRemovedRemoved
xmpA PDF's XMP metadata stream, which repeats and extends its propertiesPDFRemovedRemoved
object_metadataXMP metadata attached to pages and images inside a PDFPDFRemovedRemoved
piece_infoPrivate data an application (Illustrator, Acrobat) stored in the PDFPDFRemovedRemoved

Review

The traces of drafting and review.

TypeWhat it isFormatsstandardstrict
tracked_changesInsertions, deletions, moves and formatting changes not yet acceptedWordKeptAccepted
commentsComments and their repliesWord, Excel, PowerPointKeptRemoved
annotationsPDF notes, highlights, underlines, strikeouts and other review marksPDFKeptRemoved
page_markupPDF stamps, ink, text boxes and shapes drawn on the page, such as a signaturePDFKeptFlattened
authorsThe names on tracked changes and commentsWord, Excel, PowerPointKeptAnonymized
revision_datesWhen each tracked change and comment was madeWordKeptRemoved
peopleThe accounts behind comment authors: email addresses and directory idsWord, Excel, PowerPointRemovedRemoved
revision_idsThe ids Word gives each editing session, which can tie documents to one machineWord, PowerPointRemovedRemoved
document_guidA unique id that follows the document through every copyWordRemovedRemoved
revision_logA shared workbook's change historyExcelRemovedRemoved
incremental_updatesEarlier revisions a PDF keeps when it is saved over itselfPDFRemovedRemoved
speaker_notesA presentation's speaker notesPowerPointKeptRemoved

Hidden content

Content in the file that the page does not show.

TypeWhat it isFormatsstandardstrict
hidden_textText formatted as hiddenWordRemovedRemoved
hidden_objectsShapes, pictures and text boxes marked hiddenWord, PowerPointRemovedRemoved
obfuscated_textWhite text, which does not show on a white pageWordReportedRemoved
small_textText 1.5 points or smallerWordReportedRemoved
hidden_sheetsHidden and very hidden worksheetsExcelReportedRemoved
hidden_rows_columnsHidden rows and columnsExcelReportedReported
hidden_slidesSlides marked hiddenPowerPointReportedRemoved
off_slide_contentShapes placed outside the slide, which never showPowerPointRemovedRemoved
hidden_layersPDF layers that are switched offPDFReportedReported
unapplied_redactionsRedactions marked in a PDF but never applied, so the text is still therePDFAppliedApplied
improper_redactionText under a dark box that only covers it on screenPDFReportedReported
pivot_cachesThe copy of source data a pivot table keepsExcelRemovedRemoved
scenariosWhat-if scenariosExcelRemovedRemoved
custom_viewsSaved custom viewsExcelRemovedRemoved
unused_layoutsSlide layouts no slide usesPowerPointRemovedRemoved
glossaryBuilding blocks and AutoText entries stored in the documentWordRemovedRemoved

What connects the document to the firm's systems, or runs on its own.

TypeWhat it isFormatsstandardstrict
document_variablesVariables a template or add-in stored, often from a document management systemWordRemovedRemoved
sensitive_fieldsFields that show a file name, path, user name or property, converted to their textWordConvertedConverted
attached_templateThe path of the template the document is attached to, other than NormalWordResetReset
attached_schemaXML schemas attached to the documentWordRemovedRemoved
mail_mergeA mail merge's data source and its pathWordRemovedRemoved
smart_tagsSmart tagsWordRemovedRemoved
custom_xmlCustom XML parts, often from a document management system or add-inWord, Excel, PowerPointRemovedRemoved
custom_xml_boundCustom XML that content controls on the page are bound toWord, Excel, PowerPointKeptRemoved
internal_linksLinks to files on a network or local driveWord, Excel, PowerPoint, PDFReportedUnlinked
external_linksLinks to other workbooksExcelReportedUnlinked
data_connectionsConnections to databases and other data sourcesExcelRemovedRemoved
defined_namesHidden names, broken (#REF!) names, and names that point into other workbooksExcelRemovedRemoved
formulasFormulas, whose results the cleaner leaves as they areExcelReportedReported
file_pathThe folder the workbook was saved inExcelRemovedRemoved
file_sharing_userThe user who protected the workbook for sharingExcelRemovedRemoved
tagsTags add-ins stored on slides and shapesPowerPointRemovedRemoved
macrosVBA macrosWord, Excel, PowerPointReportedRemoved
custom_uiCustom ribbon and toolbar definitionsWord, Excel, PowerPointRemovedRemoved
web_extensionsOffice add-ins stored with the documentWord, Excel, PowerPointRemovedRemoved
javascriptJavaScript in a PDFPDFRemovedRemoved
open_actionAn action a PDF runs when it opensPDFRemovedRemoved
form_fieldsPDF form fieldsPDFKeptFlattened

File contents

Everything else inside the file.

TypeWhat it isFormatsstandardstrict
thumbnailA preview image of the first pageWord, Excel, PowerPointRemovedRemoved
page_thumbnailsPreview images of a PDF's pagesPDFRemovedRemoved
printer_settingsPrinter settings, which can name a printer on the networkWord, Excel, PowerPointRemovedRemoved
xml_commentsComments inside the file's XML, which no reader showsWord, Excel, PowerPointRemovedRemoved
tool_markupMarkup that editing and document management tools add to the XMLWordRemovedRemoved
unused_mediaPictures and media nothing in the document showsWord, Excel, PowerPointRemovedRemoved
embedded_objectsDocuments embedded inside the document, each cleaned the same wayWord, Excel, PowerPointCleanedCleaned
attachmentsFiles attached to a PDFPDFRemovedRemoved
image_metadataEXIF and other metadata inside pictures: camera, location, datesWord, Excel, PowerPoint, PDFRemovedRemoved

Left in place

What a reader sees or relies on, which a clean never changes.

TypeWhat it isFormatsstandardstrict
document_numbersDocument numbers and file paths shown in a header or footer, which are visible textWordReportedReported
protectionEditing restrictions and passwordsWord, Excel, PowerPointKeptKept
signaturesDigital signaturesPDFKeptKept
bookmarksPDF bookmarksPDFKeptKept

Warnings

metadata_report.warnings names what a clean left for a person to decide, each with its type and a message to pass on to whoever sends the document. Among them:

  • A signed PDF. Any change to a signed PDF means its signature no longer verifies.
  • Text under a dark box. The box hides the text on screen, but the text is still in the file. Redact it properly before sending.
  • Document numbers. A header or footer shows a document number or file path. It is visible text, so it was left in place.
  • White text over a picture or page colour. It may be legible, so it was left in place.
  • Links to file paths or internal sites, left in place under standard.
  • Hidden rows and columns, left in place because removing them would move cells that formulas point at.
  • Macros removed, so the file is now a macro-free document.