Funnelback
The Funnelback API Component provides actions in line with the Funnelback Push API and the live Funnelback search service.
General information
The Funnelback API Component provides actions in line with the Funnelback Push API and the live Funnelback search service.
|
This documentation assumes you are familiar with using Funnelback APIs and configuring data sources in Funnelback. Documentation for these topics can be found at the following links:
For this connector to work, a push data source and a results page must be configured in Funnelback. The relevant documentation is linked below: |
Credentials
The following credentials are required to authenticate the Squiz Integrations Funnelback component with your Funnelback instance:
- Title
-
The title of your credential.
- Instance URL
-
The base URL of your Funnelback instance. For example, https://dxp-us-admin.funnelback.squiz.cloud.
- Security Token
-
The security token you use in requests for this API integration. Read the Funnelback API token documentation for more information.
Funnelback PUSH API component actions
| The links to the Funnelback documentation for each Action can also be accessed by clicking the Learn More link in the help tooltip for the given Action on the Integrations Component Configuration UI (Step 3 - Functions). |
Add or update redirects
Add new or updated redirect information to a data source.
This call tells PUSH that an HTTP redirect exists from the key pointing at redirectTarget.
The addition must be committed before it becomes visible to the Funnelback search interface.
This call implicitly replaces existing content or redirects in the data source with the same key.
Input fields
- Datasource ID
-
The ID of the data source to which redirect information should be added. This data source must exist and have a collection_type of push2.
- Key
-
The key for which content/redirect should be added. The key must be a valid URI with a scheme and a hierarchical part containing a (possibly) empty authority segment and a non-empty path segment (for example http://example.com or file:///file.txt).
The key must be correctly encoded (for example, it must not contain literal ‘/’ characters).
Commit changes
Commit pending changes so that they become visible to the Funnelback search interface.
Input fields
- Datasource ID
-
The ID of the data source to which redirect information should be added. This data source must exist and have a collection_type of push2.
- Wait for completion
-
Controls whether the commit request should return once the commit begins or wait until it completes. Defaults to false.
Delete content from datasource
Delete content or redirects from a data source. The deletion must be committed before it becomes visible to the Funnelback search interface. This returns success if no content/redirect exists for the given key to begin with.
Input fields
- Datasource ID
-
The ID of the data source to which redirect information should be added. This data source must exist and have a collection_type of push2.
- Key
-
The key for which content/redirect should be deleted. The key must be a valid URI with a scheme and a hierarchical part containing a (possibly) empty authority segment and a non-empty path segment (for example, http://example.com or file:///file.txt).
The key must be correctly encoded (for example, it must not contain literal ‘/’ characters).
Delete entire datasource
Deletes all documents and redirects (both committed and uncommitted) from the datasource It also removes any work done by processing click logs.
Get content in datasource
Get the content in a data source for the given key. The cost of the call scales with the log of the number of documents in the data source, so it should not be used in bulk on large data sources. Content is NULL when no content is found.
Input fields
- Datasource ID
-
The ID of the data source to which redirect information should be added. This data source must exist and have a collection_type of push2.
- Key
-
The key for which content/redirect should be deleted. The key must be a valid URI with a scheme and a hierarchical part containing a (possibly) empty authority segment and a non-empty path segment (for example, http://example.com or file:///file.txt).
The key must be correctly encoded (for example, it must not contain literal ‘/’ characters).
Push content and metadata
Add new or updated content to a data source.
The addition must be committed before it becomes visible to the Funnelback search interface. This call implicitly replaces any existing content or redirect in the data source with the same key given.
Input fields
- Datasource ID
-
The ID of the data source to which redirect information should be added. This data source must exist and have a collection_type of push2.
- Key
-
The key for which content/redirect should be deleted. The key must be a valid URI with a scheme and a hierarchical part containing a (possibly) empty authority segment and a non-empty path segment (for example, http://example.com or file:///file.txt).
The key must be correctly encoded (for example, it must not contain literal ‘/’ characters). - Filters
-
The filter classes to apply to the content before addition. Some common values are:
- JSONToXML
-
This filter converts JSON documents into XML documents.
- CSVToXML
-
This filter converts CSV documents to multiple XML documents, where each record in the CSV results in one XML document.
Read the Funnelback filtering for additional information about document filtering.
- Metadata
-
The JSON map of metadata for the document where the key is a string and the value is an array of strings. This needs to be in a JSON format, for example:
{"author": ["Alice", "Bob"]} or {"author":["Tom", "Jerry"], "id":["123"]})
Push document to datasource
Add new or updated content to a data source.
The addition must be committed before it becomes visible to the Funnelback search interface. This call implicitly replaces any existing content or redirect in the data source with the same key given.
Input fields
- Datasource ID
-
The ID of the data source to which redirect information should be added. This data source must exist and have a collection_type of push2.
- Key
-
The key for which content/redirect should be deleted. The key must be a valid URI with a scheme and a hierarchical part containing a (possibly) empty authority segment and a non-empty path segment (for example, http://example.com or file:///file.txt).
The key must be correctly encoded (for example, it must not contain literal ‘/’ characters). - Content
-
The content to be added to the data source. This should be UTF-8 encoded or binary content to be filtered through the filters parameter.
- Content type
-
The MIME type of the content. Any value set in the Filters field determines which filters apply; otherwise, it is passed to the indexing system with the content.
- Filters
-
The filter classes to apply to the content before addition. Some common values are:
- JSONToXML
-
This filter converts JSON documents into XML documents.
- CSVToXML
-
This filter converts CSV documents to multiple XML documents, where each record in the CSV results in one XML document.
Read the Funnelback filtering for additional information about document filtering.
Push document with custom header
Add new or updated content to a data source, including the X-Funnelback-Lockstring custom header.
The addition must be committed before it becomes visible to the Funnelback search interface.
This call implicitly replaces any existing content or redirect in the data source with the same key given.
Input fields
- Datasource ID
-
The ID of the data source to which redirect information should be added. This data source must exist and have a collection_type of push2.
- Key
-
The key for which content/redirect should be deleted. The key must be a valid URI with a scheme and a hierarchical part containing a (possibly) empty authority segment and a non-empty segment part (for example, http://example.com or file:///file.txt).
The key must be correctly encoded (for example, it must not contain literal ‘/’ characters). - Content
-
The content to be added to the data source. This should be UTF-8 encoded or binary content to be filtered through the filters parameter.
- Content type
-
The MIME type of the content. If a filter is set, this is used to determine which of the specified filters apply; otherwise, it is passed to the indexing system with the content.
- Filters
-
The filter classes to apply to the content before addition. Some common values are:
- JSONToXML
-
This filter converts JSON documents into XML documents.
- CSVToXML
-
This filter converts CSV documents to multiple XML documents, where each record in the CSV results in one XML document.
Read the Funnelback filtering for additional information about document filtering.
- X-Funnelback-Lockstring
-
Comma-separated list of permission key-value pairs, which is used as the value of the
X-Funnelback-Lockstringheader.
Funnelback search API component actions
The following sections discuss actions that can be performed using the Funnelback search API.
Search content
Search content in a data source using the live Funnelback results page. Read the Funnelback search documentation for more information.
Input fields
- Datasource ID
-
The ID of the data source to which redirect information should be added.
- Endpoint
-
This is a drop-down menu that determines whether the HTML, JSON, or XML endpoint should be called, therefore determining the format of the results in the response.
- Query Parameters
-
The query parameters to append to the request URL. Anything entered here is appended as query parameters; therefore, ensure that this field contains valid query parameters, including the parameter name.+ For example, entering
'query=FOO+BAR&form=MY-TEMPLATE'will result in a request of the format;
https://FUNNELBACK-SERVER/s/search.html?collection=COLLECTION-ID&query=FOO+BAR&form=MY-TEMPLATERead the Funnelback query documentation for more information.