Custom Objects

The following structures are used in the images, videos and customer_entities fields of the Talkwalker Documents.

image object

field_name	datatype	accepted dataformat	required	writable	Example
url	string	normalized url	yes	yes	"url": "http://www.example.com/image.jpg"
legend	string	<1000 chars	no	yes	"legend": "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
width	integer		no	yes
height	integer		no	yes

Example

{
    "images": [
        {
            "url": "http://www.example.com/image1.jpg",
            "legend": "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
        }
    ]
}

video object

field_name	datatype	accepted dataformat	required	writable	Example
url	string	normalized url	yes	yes	"url": "http://www.example.com/video.mpg"
legend	string	<1000 chars	no	yes	"legend": "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
width	integer		no	yes
height	integer		no	yes

Example

{
    "videos": [
        {
            "url": "http://www.example.com/video1.mpg",
            "legend": "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
        }
    ]
}

customer_entity object

field_name	datatype	accepted dataformat	required	writable	Example
type	string	person, place, organization, keyword, iptc, source_distribution_type	yes	yes	"type": "person"
id	list of string (ordered)	<100 chars	yes	yes	"id" : ["Obama", "Barack"]

The Talkwalker user interface will only show the first 2 levels of Ids. The list of Ids defines a hierarchy where each Id defines a superset of the following Ids. See list of id options for source_distribution_type in chapter "formats".

Examples

Entity hierarchy: Austin TX in USA

{
    "customer_entities": [
        {
            "type": "Place",
            "id": ["USA", "Austin TX"]
        }
    ]
}

Multiple independent entities

{
    "customer_entities": [
        {
            "type": "organization",
            "id": ["UNO"]
        },
        {
            "type": "organization",
            "id": ["WHO"]
        }
    ]
}