Skip to main content

GSDocument

Name

Type

Required

Description

date

number(double)

false

The Unix timestamp when the document was created in milliseconds.

description

string

false

The description of the document.

empty

boolean

false

Indicates whether the document contains any content.

facetList

array

false

An array of objects, each representing a single facet enabled in the Filter Settings (filter) of the configuration with facet refiners for this document.

» facets

array

false

An array of objects, each representing a single refiner of this facet.

» » count

integer(int32)

false

Will be always 1.

» » label

string

false

The name of the facet refiner.

» » value

string

false

The field value.

» » children

array

false

Will be always null.

» field

string

false

The field type.

» label

string

false

The name of the facet. Is determined by the title value in the configuration.

documentDetails

array

false

An array of objects, each representing a single facet enabled in the Details View Settings (details) of the configuration with refiners for this document.

» facets

array

false

An array with facet refiners and facet metadata.

» » count

integer(int32)

false

Will be always 1.

» » label

string

false

The name of the facet refiner.

» » value

string

false

The filed value.

» » children

array

false

Will be always null.

» field

string

false

The field type.

» label

string

false

The name of the facet. Is determined by the title value in the configuration.

id

string

false

The ID of the document.

image

string

false

The image for this document in GraphSearch.

link

string

false

The URL of the document.

searchSpaceId

string

false

The ID of the GraphSearch search space with the document.

title

string

false

The title of the document.

type

string

false

The type of the document.