Page Comparison

...

Query items

GET/POST https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items/query

...

List Items (deprecated)

GET https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items

...

Parameters:

tenant – User tenant.
project_id – Project identifier.

Query Parameters:

start – the index of the first item to be returned, useful for pagination (default: 0). Since the returned items are filtered after pagination, the start returned in the next_params field should be passed in to avoid receiving duplicate items.
count – the number of items returned. Set to 0 to return all items (default 15). Since the returned items are filtered after pagination, the number of returned items may be lower than this number.
created_before – Date and Time value which limits the returned items to items that have been created before this date.
created_after – Date and Time value which limits the returned items to items that have been created after this date.
object_ids – Comma-separated list of object IDs from which to return items.
query – Search for items that match this query. For each item a score is calculated which reflects how well it matches this query.
fingerprint_type_id – If set, the fingerprint with this id and of type fingerprint_type and with name fingerprint_name is applied to this request. Set all three fingerprint parameters for this to work.
fingerprint_type – The type of the requested fingerprint to apply. Set this parameter together with fingerprint_type_id and fingerprint_name.
fingerprint_name – The name of the requested fingerprint to apply. Set this parameter together with fingerprint_type_id and fingerprint_name.
filter_query – Filters the resulting items additionally with a query. Each item returned must match this query. The syntax follows the Query Syntax.
enable_query_highlighting – Boolean value. Allows to highlight terms of a user query found in the items of the result set. The found search terms will be wrapped with a pre_tag and a post_tag.
highlight_smartfilters – Allows to highlight terms of an applied Smart Filter found in the items of the result set. The found search terms will be wrapped with a pre_tag and a post_tag.
noise_level – If set only return the most relevant items for the provided noise level which is a float between 0.0 (only the most relevant items) and 1.0 (all items). A hint of how many items are to be retrieved for noise level 1.0 can be passed in with expected_num_results.
expected_num_results – Number of results to be expected for the provided query. Can be used as a hint in conjunction with noise_level. This should be the expected_num_results returned in the next_params field of the response.
languages – Restrict the returned items to one or many languages. Can be a comma separated list of language codes or the special string user to this users configured languages. If not set, items in all languages are returned.
location – Restrict the returned items to a specific geographic region. This parameter can take three different forms: ‘lat,lon’ for searching on one spot, ‘lat,lon,radius’ to search within a circle (radius unit is kilometer) or ‘lat1,lon1,lat2,lon2’ to search in an envelope (top right, bottom left)
fields – Comma-separated list of fields to return. If this is specified, the return value is limited to only these fields. See the Item Format reference for a list of available fields.
keyword_facets – Boolean value. If set to true, keyword facets are calculated. For each keyword the top values in the result set are calculated and returned with the query result.
facet_fields – Comma-separated list of fields for which to calculate the facets. Defaults: all fields.
nof_facets – Numeric value indicating how many of the top facet values should be returned. Default: 10.
date_histogram – Boolean value. If set to true, the date distribution of the query result is calculated and returned.
date_histogram_fields – Comma-separated list of fields for which values you would like to receive date histogram information.
filter_related_items – Boolean value. Set to true to remove near-duplicates from the result list.

Headers: See Common Headers.

Status Codes:

200 – Results returned.

See also Common Status Codes.

Returns:

Results including some pagination information.

Response fields:

items – List of items.
count– The number of items returned with this result set.
total – How many items match the current query.
eof – True if the there are no further results available to paginate to.
next_params – Query parameters that should be passed in with the next request when paginating.

Code Block

	js
	js

{
    "count": 1,
    "now": "2014-12-17T14:27:47",
    "next_params": {
        "start": 1,
        "expected_num_results": 92
    },
    "eof": false,
    "items": [
        {
            "body": "<html><body>
<p class=\"tweet\">ABB and <squirro:highlight>Hitachi</squirro:highlight> forms a JV to provide HVDC system…",
            "language": "en",
            "title": "Supreme & Co.",
            "read": false,
            "created_at": "2014-12-17T13:10:45",
            "modified_at": "2014-12-17T13:11:16",
            "related_items": [],
            "id": "Fd2yF5BvQX2LlCdYPZ-Zow",
            "sources": [
                {
                    "link": "https://twitter.com/search?q=abb -is:retweet&f=realtime",
                    "title": "Twitter search for: \"abb\"",
                    "object_ids": [
                        "w--MRsdxR26LlymevPTpMA"
                    ],
                    "id": "nN3pr5BwQJevxbSzMB9Www",
                    "provider": "twitter"
                }
            ],
            "score": null,
            "link": "https://www.facebook.com/pages/Supreme-Co/356890661079035?ref=hl",
            "objects": [
                {
                    "source_ids": [
                        "nN3pr5BwQJevxbSzMB9Www"
                    ],
                    "project_id": "D9omq-WVQ0O2hxYp9fKUlA",
                    "type": "default",
                    "id": "w--MRsdxR26LlymevPTpMA",
                    "title": "default"
                }
            ],
            "keywords": {
                "from": [
                    "supremeco"
                ],
                "Sentiment": [
                    "Neutral"
                ],
                "Geo_State": [
                    "Japan"
                ],
                "verb": [
                    "post"
                ],
                "Organization": [
                    "ABB Group",
                    "Hitachi"
                ]
            },
            "starred": false,
            "external_id": "545204453427531777",
            "abstract": [
                "ABB and <squirro:highlight>Hitachi</squirro:highlight> forms a JV to provide HVDC system solutions in Japan.\ntinyurl.com/nzhqzrfABB",
                " and <squirro:highlight>Hitachi</squirro:highlight> forms a JV to provide HVDC system solutions in Japan.\nBusiness Standard reported that ABB",
                " and <squirro:highlight>Hitachi</squirro:highlight> entered into a JV for providing high voltage direct current system solutions in Japan",
                "-sales services related to the DC system of HVDC projects. <squirro:highlight>Hitachi</squirro:highlight> and ABB will take equity..."
            ]
        }
    ],
    "facets": {},
    "field_histograms": {},
    "total": 92,
    "fingerprint_matches": {}
}

Get Item

GET https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items/(id: item_id)

...

Parameters:

tenant – User tenant.
project_id – Project identifier.
item_id – Item identifier.

Query Parameters:

highlight_query – Query for which the item is to be highlighted.
explain_smartfilters – Comma-separated list of Smart Filters for which to include explanations in query result.
fields – Comma-separated list of fields to return. If this is specified, the return value is limited to only these fields. See the Item Format reference for a list of available fields.

Headers:

See Common Headers.

Status Codes:

200 – Item returned.

See also Common Status Codes.

Returns:

The item in the item response field.

Code Block

	js
	js

{
    "item": {
        "body": "<html><body><p class=\"tweet\">ABB and <squirro:highlight>Hitachi</squirro:highlight> forms a JV to provide HVDC system…",
        "language": "en",
        "title": "Supreme & Co.",
        "read": false,
        "created_at": "2014-12-17T13:10:45",
        "modified_at": "2014-12-17T13:11:16",
        "related_items": [],
        "id": "Fd2yF5BvQX2LlCdYPZ-Zow",
        "sources": [
            {
                "link": "https://twitter.com/search?q=abb -is:retweet&f=realtime",
                "title": "Twitter search for: \"abb\"",
                "object_ids": ["w--MRsdxR26LlymevPTpMA"],
                "id": "nN3pr5BwQJevxbSzMB9Www",
                "provider": "twitter"
            }
        ],
        "score": null,
        "link": "https://www.facebook.com/pages/Supreme-Co/356890661079035?ref=hl",
        "objects": [
            {
                "source_ids": ["nN3pr5BwQJevxbSzMB9Www"],
                "project_id": "D9omq-WVQ0O2hxYp9fKUlA",
                "type": "default",
                "id": "w--MRsdxR26LlymevPTpMA",
                "title": "default"
            }
        ],
        "keywords": {
            "from": ["supremeco"],
            "Sentiment": ["Neutral"],
            "Geo_State": ["Japan"],
            "verb": ["post"],
            "Organization": ["ABB Group", "Hitachi"]
        },
        "starred": false,
        "external_id": "545204453427531777",
        "abstract": [
            "ABB and <squirro:highlight>Hitachi</squirro:highlight> forms a JV to provide HVDC system solutions in Japan.\ntinyurl.com/nzhqzrfABB",
            " and <squirro:highlight>Hitachi</squirro:highlight> forms a JV to provide HVDC system solutions in Japan.\nBusiness Standard reported that ABB",
            " and <squirro:highlight>Hitachi</squirro:highlight> entered into a JV for providing high voltage direct current system solutions in Japan",
            "-sales services related to the DC system of HVDC projects. <squirro:highlight>Hitachi</squirro:highlight> and ABB will take equity..."
        ]
    }
}

Update Item

PUT https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items/(id: item_id)

...

Delete Item

DELETE https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items/(id: item_id)

...

Versions Compared

Old Version 6

New Version 7

Key

Query items

List Items (deprecated)

Get Item

Update Item

Delete Item