Page tree
Skip to end of metadata
Go to start of metadata


The Squirro iFrame is used to embed Squirro into any web system.

Table of Contents

Endpoint

The iFrame is served from the following URL: $CLUSTER/app/bulk/iframe

The $CLUSTER part in the URL is replaced with your cluster endpoint, resulting for example in the URL http://localhost:8300/app/bulk/iframe for your local Squirro in a Box installation. See Connecting to Squirro for more information.

Parameters

The following sections define all supported query string parameters.

All values must be encoded according to Character Data.

The iFrame can select objects.

General

ParameterDocumentation
project_id (mandatory)The identifier of the selected Squirro project.
tokeniFrame token for authentication which can be generated on behalf of a specific user by visiting https://squirro-endpoint/app/#settings/api (See Connecting to Squirro for more information).

Formatting

ParameterDocumentation
tabs

Tabs to show in the iframe.

The following values are supported. Multiple values are separated by comma:

ValueTabDescription
readReadShow items from the selected project.
infoEssentialsSearch for and display companies. This is recommended if your items are companies.
sourcesSourcesDisplay and manage sources.
settingsSettingsManage social connections and user profile details.

The tab bar is hidden if the value is specified but left empty.

dateFormat

Allows to customize the date formatting. The following values are supported:

  • timeago (default): Uses relative date format. Examples “1 day ago”, “3 weeks ago”, etc.
  • calendar: Uses relative date format for all dates within the past week, absolute ones for everything else. Examples: “Today 3:43 AM”, “Yesterday 2:29 PM”, “Last Monday 11:44 PM”.
  • customformat: A custom format can be specified. See the table below for all supported tokens. Values are escaped with square brackets. For example [on]dddd results in “on Monday”, “on Tuesday”, etc.
TokenOutput
MonthM1 2 ... 11 12
Mo1st 2nd ... 11th 12th
MM01 02 ... 11 12
MMMJan Feb ... Nov Dec
MMMMJanuary February ... November December
Day of MonthD1 2 ... 30 30
Do1st 2nd ... 30th 31st
DD01 02 ... 30 31
Day of YearDDD1 2 ... 364 365
DDDo1st 2nd ... 364th 365th
DDDD001 002 ... 364 365
Day of Weekd0 1 ... 5 6
do0th 1st ... 5th 6th
dddSun Mon ... Fri Sat
ddddSunday Monday ... Friday Saturday
Week of Yearw1 2 ... 52 53
wo1st 2nd ... 52nd 53rd
ww01 02 ... 52 53
ISO Week of YearW1 2 ... 52 53
Wo1st 2nd ... 52nd 53rd
WW01 02 ... 52 53
YearYY70 71 ... 29 30
YYYY1970 1971 ... 2029 2030
AM/PMAAM PM
aam pm
HourH0 1 ... 22 23
HH00 01 ... 22 23
h1 2 ... 11 12
hh01 02 ... 11 12
Minutem0 1 ... 58 59
mm00 01 ... 58 59
Seconds0 1 ... 58 59
ss00 01 ... 58 59
Fractional SecondS0 1 ... 8 9
SS0 1 ... 98 99
SSS0 1 ... 998 999
ss00 01 ... 58 59
TimezoneZ-07:00 -06:00 ... +06:00 +07:00
ZZ-0700 -0600 ... +0600 +0700
Unix TimestampX1360013296
smartfilterTag

Limits the smart filter list that is shown to the user to those matching this tag. Specified multiple times for multiple tags which are OR-combined.

Example: smartfilterTag=banks&smartfilterTag=insurances.

Object Selection

The objects are specified by the following parameters. Different selection modes are supported and are mutually exclusive:

Selection by External Identifier

ParameterDocumentation
external_id

The external identifier of the object for which the project is selected. This is the external object identifier used during bulk object creation. If a single external_id is provided the object will enter the api_reference_iframe_object_creation mode.

Specified multiple times to show items from multiple objects. Example:

&external_id=Squirro&external_id=Oracle.

Selection by Squirro Identifier

ParameterDocumentation
object_id

The Squirro object identifier. This can be retrived by the project API.

Specified multiple times to show items from multiple objects. Example:

&object_id=H0ZdsRhokqod8vDw&object_id=ioLWXX2t9OJlsXTg.

Selection by Object Name

ParameterDocumentation
object_name

Selects all objects within the corresponding name.

Specified multiple times to show items from multiple objects. Example:

&object_name=Insurance&object_name=Banking.

Item Filtering

Squirro filters the displayed item list according to the following parameters.

ParameterDocumentation
created_beforedatetime value which limits the returned items to items that have been created before this date.
created_afterdatetime value which limits the returned items to items that have been created after this date.
query

Limit the returned items to those matching this query.

The query string is displayed in the iFrame and can be modified by the user.

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)
  • lat1,lon1,lat2,lon2 to search in an envelope (top right, bottom left)

Character Data

The representation of character data is such that characters are converted to bytes according to UTF-8, and then percent-encoded (e.g. Zürich Versicherung becomes Z%C3%BCrich+Versicherung). For more information, see:

  • No labels