Page Comparison

...

Field Data type Description

id

While this field is called the same in data loading and consumption, it has different semantics. See the sections Data Loading Fields and Data Consumption Fields for details.

link URL Link to the item at its original location.

title String Item title.

body HTML String Item body. This field is in HTML format and special characters need to be escaped.

language Language Codes Content language of the item. If this is not specified, it is auto-detected based on the content.

created_at

Date and Time

Item creation date. Ideally this is the creation date of the item in its source system.

If this is not specified for data loading, the import process goes through the following steps:

If the files property is specified, Squirro tries to extract a creation date from the file metadata.
As a fallback the server's current date and time is used.

webshot_url

URL

Main item picture. This image is displayed in the result list to represent the story.

For data loading, the webshot_picture_hint field should be used, because the picture will then automatically be archived.

If this is not set, it is automatically extracted from the web site specified with the link property, generally by using the first story picture.

webshot_height Integer Height of the webshot in pixels.

webshot_width Integer Width of the webshot in pixels.

keywords

Dictionary, values represented as lists

Keywords attached to the item (see Facets for full documentation). They are the structured information of an item.

Item keywords are offered as filter options in the search screen.
Keyword and their values are offered in the search field as type ahead options.
Search Tagging, known entity extraction and /wiki/spaces/KB/pages/2949480 are used to add additional keywords to items.

Keyword values can have different data types. Please reference the Data Types section of the Facets documentation for details and format specification. The default data type is string. To use other formats, configure it before loading any data into the system. See Facets API for information.

Example item with keywords:

Code Block

language	js

{
  "title": "Our offices",
  "body": "We have offices in Munich, …",
  "keywords": {
    "country": ["Germany"],
    "city": ["Munich", "Berlin"]
  }
}

entities List of dictionaries Entities attached to the item. See documentation on the Catalyst Data Model for the data structure of individual entities.

location

Two-element list

The geographical location for the item. This is stored as a two-element list of floats, representing the latitude and longitude. To query by location the List Items resource has a location query parameter.

Example:

Code Block

language	js

{
  "title": "Our offices",
  "body": "We have offices in Munich, …",
  "location": [48.1059422, 11.5668324]
}

comments

List of dictionaries.

A list of comments that are attached to the item. The user can toggle the display of these comments in the web interface on top of the item body. Three fields can be added to comments:

Field Description

id External identifier of the comment. This field is mandatory.

type Type of the comment. The type twitter is treated specially, for all other types no special handling has been implemented.

body

Comment body. This field is in HTML format and special characters need to be escaped.

If the type has been set to twitter, this needs to be a valid embedded tweet (without the script tags).

...

Versions Compared

Old Version 12

New Version 13

Key