beautypg.com

Viewing index diagnostics for a document – Google Search Appliance Administrative API Developers Guide: .NET User Manual

Page 28

background image

Google Search Appliance: Administrative API Developer’s Guide: .NET

28

Viewing Index Diagnostics for a Document

Retrieve detailed information about a document by sending an authenticated GET request to a
document status entry of the diagnostics feed. The parameter is as follows.

A detailed document status entry is returned.

Detailed document status entry properties:

Parameter

Description

collectionName

Name of the collection for which you want to view crawl diagnostics.

Property

Description

Entry Name

The URL of the document.

backwardLinks

The number of backward links to this document.

collectionList

A list of collections that contain this document.

contentSize

The size of the document content.

contentType

The type of the document.

crawlFrequency

The frequency at which the document is being scheduled to crawl, with
possible values of seldom, normal, and frequent.

crawlHistory

A multi-line history of the document crawl including the timestamp
when the document was crawled, the document status code and
description in the following format:

timestamp

status_code

status_description

timestamp

status_code

status_description

For status code values, see “Document Status Values” on page 24.

currentlyInflight

If the document is currently in process.

date

The date of this document.

forwardLinks

The number of forward links for this document.

isCached

Indicates if the cached page for this document is ready.

lastModifiedDate

The last modified date of this document.

latestOnDisk

The timestamp of the version being served.