Standard metadata

This is for:

To benefit from the Push source’s automapping feature, two requirements must be met to index item metadata:

The metadata value must be present when the item is pushed.
A field with the same name and a compatible data type must exist in your Coveo organization.

For some standard metadata, the Push API or the Coveo indexing pipeline automatically sets metadata values on items you add or update. Additionally, your Coveo organization may include a default field that indexes this metadata automatically.

Example

When the Coveo indexing pipeline processes an item, it detects the item’s language and sets the language metadata value accordingly. This value is automatically indexed in the default language field of your Coveo organization.

For other standard metadata, Coveo doesn’t automatically set metadata values, but a default field exists for the purpose of indexing this metadata.

Example

The author field is a default field. It’s populated when you push an item that includes an author metadata value in the request body.

Finally, for some standard metadata, Coveo neither sets metadata values automatically nor contains a default field to index this metadata.

The following table lists standard Coveo metadata and indicates whether:

Coveo automatically sets the metadata value
A default field exists to index the metadata

Metadata name Description and details Coveo sets metadata values? Default field exists?

Metadata name	Description and details	Coveo sets metadata values?	Default field exists?
`date`	The date and time of the last Push API request that updated the item (for example, `"2017-11-08T12:18:41.666Z"`). You can override this value by retrieving the last modification date from the original document and passing it as the `date` metadata in your request body.
`filetype`	The item’s file extension (for example, `"html"`).
`indexeddate`	The date and time when the item was last processed by the document processing manager (DPM) (for example, `"2023-11-08T12:18:41.666Z"`).
`size`	The item’s size in bytes (for example, `50683`).
`source`	The name of the source that contains the item (for example, `"MyPushSource"`).
`author`	The item’s author (for example, `"Alice Smith"`).
`documenttype`	The type of item (for example, `"WebPage"`).
`filename`	The name of the file (for example, `"index.html"`).
`permanentid`	A unique, and permanent identifier for the item (for example, `"my10293810329permanent1239810239818id"`).
`sourcetype`	The type of source that contains the item (for example, `"Push"`).
`title`	The item’s title (for example, `"My Document"`).
`duration`	If the item is a video, its duration in seconds (for example, `125.6`).
`height`	If the item is an image, its height in pixels (for example, `768`).
`pages`	The total number of pages in the item (for example, `42`).
`width`	If the item is an image, its width in pixels (for example, `1024`).

date

The date and time of the last Push API request that updated the item (for example, "2017-11-08T12:18:41.666Z").

You can override this value by retrieving the last modification date from the original document and passing it as the date metadata in your request body.

filetype

The item’s file extension (for example, "html").

indexeddate

The date and time when the item was last processed by the document processing manager (DPM) (for example, "2023-11-08T12:18:41.666Z").

size

The item’s size in bytes (for example, 50683).

source

The name of the source that contains the item (for example, "MyPushSource").

author

The item’s author (for example, "Alice Smith").

documenttype

The type of item (for example, "WebPage").

filename

The name of the file (for example, "index.html").

permanentid

A unique, and permanent identifier for the item (for example, "my10293810329permanent1239810239818id").

sourcetype

The type of source that contains the item (for example, "Push").

title

The item’s title (for example, "My Document").

duration

If the item is a video, its duration in seconds (for example, 125.6).

height

If the item is an image, its height in pixels (for example, 768).

pages

The total number of pages in the item (for example, 42).

width

If the item is an image, its width in pixels (for example, 1024).