Posts tagged i14y

i14y Content Indexing API Documentation

Search.gov Home > APIs for Developers > i14y API

Important Note: April, 2018. i14y does not visit your content to do full-text scraping of your content. For new implementations, the Search.gov team recommends you index your content with us not using the i14y API, but rather by publishing a comprehensive xml sitemap, which we can use to index your content. Read more.

i14y Github repo (External link)

What is i14y?

The Search.gov i14y Content Indexing API allows you to send content directly from your content management system (CMS) into Search.gov for real-time indexing. By hooking into your CMS workflow, you can immediately create, update, and delete the associated documents in our search indexes via this API. Even if you don’t have a CMS, you can develop software to publish your content in a way that meets the i14y API specifications below.

Ruby/Python/Node clients are welcome.

Before you Begin

  1. Set-up a search site with our service via Search.gov
  2. Request that your search site be enabled for i14y by emailing our team.
  3. Set up an i14y “drawer” in our system. Full instructions are available in our help manual. You’ll give your drawer a handle, and you’ll need to enter this drawer handle in the username field below after you click the Authorize button.
  4. Get your i14y secret token. You’ll need to enter this token as your password. The token can be found in our system in: Search Admin Center > Manage Content > i14y Drawers, select the option Show.

Note: If you are a developer who doesn’t have access to our site configurations, please email us.

Getting Started with i14y

Search.gov Home > APIs for Developers > i14y API

Important Note: April, 2018 - For new implementations, the Search.gov team recommends you index your content with us not using the i14y API, but rather by publishing a comprehensive xml sitemap, which we can use to index your content. Read more.

i14y Github repo (External link)

Technical Documentation

What is i14y?

i14y is a content indexing API that allows you to send your content directly to our indexes. When your site is enabled for i14y, it gives you complete control over what searchers see. No commercial web results will be served: instead, searchers will see content exactly as you’ve sent it to us.

How Do I Use i14y?

We currently have a Drupal module (External link) that will hook your CMS into i14y. You can also check out our help docs for working with the Drupal module.

If you use a different CMS, or don’t have one at all, we recommend you focus on publishing a comprehensive xml sitemap, which we would leverage to index your content.

Important Note: i14y does not visit your content to do full-text scraping of your content. For new implementations, the Search.gov team recommends you index your content with us not using the i14y API, but rather by publishing a comprehensive xml sitemap, which we can use to index your content. Read more.

Checklist to Go Live with i14y

Step 1. Connect one of your sites to i14y

i14y needs to be enabled in the back end for a site to be able to receive content through it. You can

  • Add a brand new search site,
  • Use the Clone Site tool to copy one of your existing site’s settings to a new site (YourSite > Dashboard > Clone Site), or
  • use an existing site.

Email us and let us know which site you want enabled for i14y. Please note: once we turn on i14y for a site, we no longer serve search results from a commercial web index. Therefore, we recommend that you set up a test site for i14y, so that your customers will continue to get results until you are fully set up and ready to move your i14y index to your production search site.

Step 2. Add a Drawer

An i14y Drawer is an index receiving content via the i14y API. We’ve called them Drawers because, like drawers in a filing cabinet, multiple indexes can be included in a single configuration to scope the entirety of a site’s search.

After we have enabled i14y for your search site, a new page will appear: Admin Center > YourSite > Manage Content > i14y Drawers.

Click Add i14y Drawer in the upper right corner. Create a handle for your drawer - the handle must be all lowercase alphanumeric, all one word, and can include underscores but no other special characters (e.g., agency_drawer_handle2).

The Drawer Description is optional.

If you have more than one website or domain that will be sending content, add a separate Drawer for each of these sites. We also recommend setting up separate drawers for staging or test content, so you can easily remove that content from your search site when you are ready to go live.

Step 3. Fill your Drawer

After you have created your Drawer(s), click Show from the i14y Drawers list to find that Drawer’s secret API key. Use this secret key with your drawer handle in your API call or your CMS module to send your content to the right place.

You are now ready to add content to your drawer. You can do this in two ways:

  • Use i14y directly. View our Github repo (External link) or Technical Documentation for more information.
  • Use a module plugged into your CMS. At this time there is a Drupal module (External link) available. Help docs for the module are here.
  • Important Note: i14y does not visit your content to do full-text scraping of your content. For new implementations, the Search.gov team recommends you index your content with us not using the i14y API, but rather by publishing a comprehensive xml sitemap, which we can use to index your content. Read more.

Step 4. Review your index

You can view the number of documents indexed for each drawer on the main i14y Drawers list, and when the most recent document was received. Click Show to view documents within a particular drawer. We display the most recent 1,000 items that were sent to the drawer. You can also search for keywords in the documents’ text, titles, and descriptions (Note: you cannot currently search for URLs).

Note: We use the Domains section to scope search results - if the domain(s) of your i14y content are not listed in the Domains section, that content will not appear on your search results page.

We send success and / or failure codes in response to your API call, so if the number of documents in our index doesn’t match what you sent, check those response codes.

If you experience difficulty sending documents to i14y, it is possible your firewall is not letting you communicate with the i14y server. Check out our cURL test commands or view the full i14y documentation.

We can attach each i14y drawer to multiple search configurations: if you have a drawer that you’d like to use for multiple search sites, email us.

Caution: A pop-up message will appear when you hit Remove on a drawer: please review this pop-up message carefully. If you remove a drawer that is only associated with one search configuration, the drawer and its contents will be deleted from our system. If the drawer is attached to multiple search configurations, it will only be removed from the search configuration you are currently on. The pop-up message will indicate what type of drawer you have.

If you accidentally delete a drawer, you will need to set-up a new drawer and resend the content - we are unable to retrieve deleted drawers. If you accidentally remove a shared drawer but it is still associated with other search configurations, we can re-attach it to your site. Contact us for assistance.

Once you have your index populated, you will set up the rest of your search as you would for a traditional Search.gov site:

If you have any RSS content that will not be sent to your i14y drawer, you can add those feeds as well.

Update your website’s search box form code to point to affiliate=youri14yenabledsitehandle.

Terms of Use

By accessing the i14y API, you agree to USA.gov’s Terms of Service for Developer Resources.


Did you know? i14y is hacker shorthand for “interoperability”, because there are 14 characters between the first and last letters. i14y can also be shorthand for Independence Day.

cURL Commands for i14y Testing

Important Note: April, 2018. i14y does not visit your content to do full-text scraping of your content. For new implementations, the Search.gov team recommends you index your content with us not using the i14y API, but rather by publishing a comprehensive xml sitemap, which we can use to index your content. Read more.

If you experience difficulty sending documents to our index via i14y, it is possible your firewall is not letting you communicate with the i14y server. Adding a test document to your i14y drawer can help you diagnose a firewall issue. Windows users may need to install cURL (External link) in order to run this test from the command line.

Adding the Test Document

From the command line, enter:

curl "https://i14y.usa.gov/api/v1/documents" -XPOST -H "Content-Type:application/json" -u your_drawer_handle:your_secret_token -d '{"document_id":"1", "title":"Test Document", "path": "http://www.gov.gov/cms/doc1.html", "created": "2015-05-12T22:35:09Z", "description":"The summary of the document goes here.", "content":"This is placeholder text, and in a real document would be paragraphs long.", "promote": false, "language" : "en", "tags" : "tag1, another tag"}'

Note: you need to replace your_drawer_handle with your i14y drawer handle, found in the i14y drawers section in the Search Admin Center (Search.gov Home > Admin Center > YourSite > Manage Content > i14y Drawers). You will also need to replace your_secret_token with the drawer’s secret token, which can be found by hitting “Show” in the 14y drawer list. The drawer handle and token should be separated by a colon (:) with no spaces on either side of the colon.

The above command returns JSON structured like this:

{
"status":200,
"developer_message":"OK",
"user_message":"Your document was successfully created."
}

If you do not see a 200 status, contact our team.

After successfully sending a document, you should see an increase (by 1) in the number of documents in your i14y drawer.

Removing the Test Document

Once you have successfully added the test document to your drawer, you will need to delete it, or it will appear in your site’s search results.

From the command line, enter:

curl "https://i14y.usa.gov/api/v1/documents/1" -XDELETE -u your_drawer_handle:your_secret_token

The above command returns JSON structured like this:

{
"status":200,
"developer_message":"OK",
"user_message":"Your document was successfully deleted."
}

Resources: Read tips on Getting Started With i14y, or view the full i14y technical documentation.

usasearch Drupal Module Help Documentation

Important Note: April, 2018. For new implementations, the Search.gov team recommends you index your content with us not using our Drupal module to send content to our i14y indexing API, but rather by publishing a comprehensive XML sitemap, which we can use to index your content. We recommend the XML Sitemap module (External link). Read more.

To use the Search.gov service on a Drupal-based website, you should install the XML Sitemap (External link) module, and may want to consider a tool like Yoast SEO (External link) to pull in non-Drupal content as well. You may also be interested in our overview of XML sitemaps.

The usasearch Drupal module (External link) can facilitate indexing content with our service, but we prefer the XML sitemap method.

  • It is possible to manually modify the Drupal search box to connect to our service, but the module allows you to make the connection via a setting configuration, rather than code work.

Step by step instructions for setting up the module

Troubleshooting tips

Drupal Module Troubleshooting Tips

Important Note: April, 2018. For new implementations, the Search.gov team recommends you index your content with us not using our Drupal module to send content to our i14y indexing API, but rather by publishing a comprehensive XML sitemap, which we can use to index your content. We recommend the XML Sitemap module (External link). Read more.

If you have installed the usasearch Drupal module (External link) to integrate your Drupal CMS with the Search.gov service but are having trouble, the following suggestions should help you identify where the problem is. If after working through these items you still have questions, reach out to our team and, though we’re not Drupal experts, we can try to help.

Skip to Search error troubleshooting tips

Indexing errors

Do you have the right module for your Drupal version?

We have modules for both Drupal 7 and Drupal 8. If your site is in Drupal 7, use usasearch-7.x-5.7. If your site is in Drupal 8, click View all Releases (External link) and select API version 8.x.

Have you set up an i14y drawer?

In order to send content from Drupal to our system, you’ll need an index to send the content into. We call these indexes “Drawers”, because like drawers in a filing cabinet, all the items put into them will be the content you can search against. Read more about Drawers here. In order to set up a drawer, your search site will need to be enabled for i14y, so contact us to request that.

Has any content actually been sent to us?

The module sends content when someone hits save on a node, or when you run re-index site. In Drupal 7, re-index site is found on the main Drupal search settings page (YOUR-DRUPAL-SITE.gov/admin/config/search/settings); in Drupal 8, you can re-index the site from the bottom of the module settings page.

  • If these actions have indeed happened, check the Drupal recent log messages (YOUR-DRUPAL-SITE.gov/admin/reports/dblog) to see if there’s anything related to usasearch, and please send us screenshots of the errors.
  • If these actions haven’t yet happened, please hit save on a node, and see if that item appears in your Drawer. You can view the contents of your Drawer by selecting Search Admin Center > Your site > Content > i14y Drawers > Show. If the item isn’t there, then check the Drupal log for an error.

Is your firewall letting you communicate with us?

If content isn’t reaching us, it could be that your firewall is not allowing you to reach i14y. Please run the following from the command line, from inside the same firewall as your web server, if possible. Note: you’ll need to customize the string below with your i14y drawer’s handle and secret token (where it says YOURDRAWERHANDLE:YOURDRAWERSECRETTOKEN):

curl "https://i14y.usa.gov/api/v1/documents" -XPOST -H "Content-Type:application/json" -u YOURDRAWERHANDLE:YOURDRAWERSECRETTOKEN -d '{"document_id":"1", "title":"test item", "created":"2017-02-16T10:19:02", "path":"https://www.usa.gov", "description":"This is a test", "content":"This is a test to see if the agency web server is able to communicate with the i14y API. If this document does not show up in the drawer in the admin center, then the i14y location may need to be whitelisted in order to facilitate indexing."}'
  • If you get a 403 Forbidden response

    Please contact your security team to request the i14y hostname be whitelisted: https://i14y.usa.gov/

    We can’t give you an IP to whitelist, as our system is hosted in AWS, and so i14y’s IP address changes regularly.

  • If you get a 200 OK response

    Your system is able to communicate with our system, so the issue must lie in how the module is working with your Drupal instance. Send us all the information and screenshots of errors that you can, and we’ll help you troubleshoot.

    Be sure you delete the test document or it will be included in your search results. You can delete it from the command line. Run this command:

    curl "https://i14y.usa.gov/api/v1/documents/1" -XDELETE -u YOURDRAWERHANDLE:YOURDRAWERSECRETTOKEN
    
  • If you get any other error response

    Please take a screenshot and send it to us to report the issue so we can investigate the error.

Do you have another question?

If you have another question about indexing with our service through the usasearch Drupal module, don’t hesitate to ask!

Search errors

Is your Drupal site search box showing Drupal search results?

  • If you have a Drupal 7 site

    Our Drupal 7 module is designed to take over the native Drupal search box on your site, and direct queries to the site you specify in the affiliate site handle field. If you’re seeing other results - either the Drupal search results or a different search site in our system, find out if the search box form code had been manually modified to point to this other location. Our module will only work with out-of-the-box Drupal search boxes. If the search box form code was modified, you’ll need to manually point it to our service using the required parameters - you can see general information on form code here, or you can view examples customized to your particular site within the Admin Center, under Activate. You may also be able to restore the form code to the Drupal default, to take advantage of the module’s site handle field and be able to modify the site handle without a dev.

  • If you have a Drupal 8 site

    In Drupal 8, we don’t override the native Drupal search box. Instead, you need to place a USA Search Form block, and disable the default Drupal search. To do this, go to YOUR-DRUPAL-SITE.gov/admin/structure/block in your Drupal site, and do ctrl-F to locate the word Search in the list. Disable the block that says just Search. Use Place block to insert a USA Search Form block in the block region of your choice. The search box in this block will point at the search site you entered in the module settings.

Is the Drupal site search box directing to the wrong Search.gov site?

Your search box should use the site handle you entered on the module settings page. If you run a search and are brought to our search results page, but see the wrong search site, check to see if the Drupal search box form code was manually modified to point to another search site handle (the affiliate parameter in the form code). If it was modified, you’ll need to change the site handle directly in that modified code. You may also be able to restore the form code to the Drupal default, to take advantage of the module’s site handle field and be able to modify the site handle without a developer.

Do you have another question?

If you have another question about searching through our service with the usasearch Drupal module, don’t hesitate to ask!

Step by Step Instructions for Setting Up the Drupal 8 usasearch module

Important Note: April, 2018. For new implementations, the Search.gov team recommends you index your content with us not using our Drupal module to send content to our i14y indexing API, but rather by publishing a comprehensive XML sitemap, which we can use to index your content. We recommend the XML Sitemap module (External link). Read more.

This documentation will walk you through setting up the usasearch Drupal 8 module (External link) field by field, to integrate your Drupal CMS with the Search.gov service. If you have trouble, take a look at our troubleshooting tips.

These instructions follow the order of settings listed in our Drupal module at YOUR-DRUPAL-8-SITE.gov/admin/config/search/usasearch.

Instructions for setting up the Drupal 7 module are here.

Search Settings

This section allows you to configure how the USA Search Block will use our service. In Drupal 8, you must place the USA Search Block, as we do not override the native Drupal Search. We recommend you disable the native Drupal Search block.

Site handle

Required. Enter the site handle you gave your search site. This is found in our Search Admin Center > Your site > Dashboard > Settings.

Enable autocomplete

Recommended setting: Checked.

Check this box if you want to enable the Javascript for our Type-ahead API. Suggestions for popular queries will appear below your search box as searchers begin typing. A query must have been run more than 10 times in a day for it to become a search suggestion.

Search domain

We offer domain masking, which allows you to display search.YOURAGENCY.gov in the URL of your search results page, instead of the default search.usa.gov.

NOTE: Only change this setting if you have domain masking configured for your search site! If you haven’t set it up, leave the default https://search.usa.gov until you’ve completed the masking steps.

Connecting Drupal to Our System for Direct Indexing

Highly recommended! The “i14y API settings” section allows you to send content directly to our indexes via our i14y API. This means that you’ll have full control over the content of your search results, and your search index will be updated in real time. Note: If you do not want to index your content with us yourselves, do not complete this section. If you only want to use our system for search, skip this section and the following Indexing section.

Enable i14y API

Recommended! If this box is checked, the module will send content to Search.gov for indexing. The Drawer Handle and API Secret Token fields will be required.

Drawer Handle

Enter your i14y “drawer handle”. This is the name you gave your drawer and is found in: Search Admin Center > Your site > Manage Content > i14y Drawers.

i14y API Secret Token

Enter your i14y drawer’s “secret token”. This can be found in our system in: Search Admin Center > Your site > Manage Content > i14y Drawers, select the option, Show.

Content Types

Recommended setting (default): Checked - all types.

Select which content types will be sent to our indexes. Content types unchecked here will not be indexed. You can also control indexing status of individual nodes in their Search.gov settings.

If you exclude a content type from indexing, and later decide to include it, nodes of this type will be indexed on the next cron run. You may also want to review any nodes that were created in the interim, to ensure in their individual Search.gov settings that they are enabled for indexing.

Description View Mode

Recommended setting: Teaser.

Select the search result description text that works best for your site. Choose among the text you’ve set as your teaser, RSS item content, Drupal search index snippet, or full text. The view mode will need to be enabled and configured for each content type. If the view mode is not available for a content type, “Teaser” will be used. The full text of your node will still be searchable.

Note: If you don’t like the content that’s being sent to us as the Teaser, you can make changes for that content type’s at YOUR-DRUPAL-8-SITE.gov/admin/structure/types/manage/[CONTENT TYPE] > Display settings or YOUR-DRUPAL-8-SITE.gov/admin/structure/types/manage/[CONTENT TYPE]/display/teaser

Enable i14y logging

Recommended setting (default): Checked.

Check this box to log i14y API operations to the watchdog log. On YOUR-DRUPAL-8-SITE.gov/admin/reports/dblog, filter by Type usasearch.

Alternate indexing domain

Do you edit your site on one domain or subdomain, but publish on another? If so, use this field to set the domain you want us to present for your content on the search results page. For instance, if you enter www.YOURAGENCY.gov here, nodes that are stored in Drupal under edit.YOURAGENCY.gov would be indexed with us as www.YOURAGENCY.gov.

Indexing

Re-index site

If you click re-index site, we will begin a full-site reindexing on your next cron run. You can wait for cron to run, or you can run it manually.

Number of items to index per cron run

Use this throttle to adjust the number of documents sent to us in each cron run. The number that is best for your site will depend on various factors, including your firewall.

Save configuration

After you save these settings, the module will send a command to us when you hit Save on a node in Drupal, either to add the node to the index, update it, or delete it from the index.

Having trouble?

Take a look at our troubleshooting tips, and don’t hesitate to reach out. We’re not Drupal experts ourselves, but we’ll try to help.

Step by Step Instructions for Setting Up the Drupal 7 usasearch module

Important Note: April, 2018. For new implementations, the Search.gov team recommends you index your content with us not using our Drupal module to send content to our i14y indexing API, but rather by publishing a comprehensive XML sitemap, which we can use to index your content. We recommend the XML Sitemap module (External link). Read more.

This documentation will walk you through setting up the usasearch Drupal 7 module (External link) field by field, to integrate your Drupal CMS with the Search.gov service. If you have trouble, take a look at our troubleshooting tips.

These instructions follow the order of settings listed in our Drupal module at YOUR-DRUPAL-7-SITE.gov/admin/config/search/usasearch.

Instructions for setting up the Drupal 8 module are here.

Affiliate site handle

Required. Enter the site handle you gave your search site. This is found in our Search Admin Center > Your site > Dashboard > Settings.

Drawer Handle

Required. Enter your i14y “drawer handle”. This is the name you gave your drawer and is found in: Search Admin Center > Your site > Manage Content > i14y Drawers.

i14y API Secret Token

Required. Enter your i14y drawer’s “secret token”. This can be found in our system in: Search Admin Center > Your site > Manage Content > i14y Drawers, select the option, Show.

Enable autocomplete

Recommended setting (default): Checked.

Check this box if you want to enable the Javascript for our Type-ahead API. Suggestions for popular queries will appear below your search box as searchers begin typing. A query must have been run more than 10 times in a day for it to become a search suggestion.

Search domain

We offer domain masking, which allows you to display search.YOURAGENCY.gov in the URL of your search results page, instead of the default search.usa.gov.

NOTE: Only change this setting if you have domain masking configured for your search site! If you haven’t set it up, leave the default https://search.usa.gov until you’ve completed the masking steps.

Alternate indexing domain

Do you edit your site on one domain or subdomain, but publish on another? If so, use this field to set the domain you want us to present for your content on the search results page. For instance, if you enter www.YOURAGENCY.gov here, nodes that are stored in Drupal under edit.YOURAGENCY.gov would be indexed with us as www.YOURAGENCY.gov.

Use rules to index content

Check this box to index content manually with rules. IMPORTANT: If checked, the Search.gov index will not be updated unless specified in a rule action.

Be sure to write rules for your content types in sets of three:

  • adding to the index
  • updating the index
  • deleting from the index

Results Description View Mode

Recommended setting (default): Teaser.

Select the search result description text that works best for your site. Choose among the text you’ve set as your teaser, RSS item content, Drupal search index snippet, or full text. The view mode will need to be enabled and configured for each content type. If the view mode is not available for a content type, “Teaser” will be used. We will still index and search the full text of your content if Indexed content view mode is Full content.

Note: If you don’t like the content that’s being sent to us as the Teaser, you can make changes for that content type’s at YOUR-DRUPAL-7-SITE.gov/admin/structure/types/manage/[CONTENT TYPE] > Display settings or at YOUR-DRUPAL-7-SITE.gov/admin/structure/types/manage/[CONTENT TYPE]/display/teaser.

Indexed content view mode

Recommended setting (default): Full content.

If you don’t want the full text of your nodes to be searchable, select a preferred view mode to define the content that gets indexed. If the view mode is not available for a content type Full content will be used.

Include by content type unless explicitly excluded

Recommended setting (default): Checked.

Check this box to include entire content types in the search index. Include or exclude particular content types in their entirety in the Search.gov settings for the content type’s structure page, e.g. YOUR-DRUPAL-7-SITE.gov/admin/structure/types/manage/article. You can exclude individual nodes using the Search.gov Settings within the node edit view.

If this box is unchecked, node indexing will need to be managed individually. We recommend you leave the box checked on the module settings.

If you exclude a content type from indexing, and later decide to include it, nodes of this type will be indexed on the next cron run. You may also want to review any nodes that were created in the interim, to ensure in their individual Search.gov settings that they are enabled for indexing.

Save configuration

After you save these settings, the module will send a command to us when you hit Save on a node in Drupal, either to add a node to the index, update it, or delete from the index.

If you select re-index site on the main Drupal search settings page (see below), we will begin a full-site reindexing on your next cron run.

Optional: Indexing content retroactively

Go to the main Drupal search settings page (YOUR-DRUPAL-7-SITE.gov/admin/config/search/settings) and click Re-index site. This will start sending us content for indexing on your next cron run. You can wait for cron to run, or you can run it manually. You can also adjust the number of documents sent to us in each cron run using the throttle setting on the Drupal search settings page.

Having trouble?

Take a look at our troubleshooting tips, and don’t hesitate to reach out. We’re not Drupal experts ourselves, but we’ll try to help.

Working with i14y Drawers

Search.gov Home > Admin Center > YourSite > Manage Content > i14y Drawers

An i14y Drawer is an index receiving content via the i14y API. We’ve called them Drawers because, like drawers in a filing cabinet, multiple indexes can be included in a single configuration to scope the entirety of a site’s search.

Information on working with our Drupal module is here.

Step 1. Make sure your site is connected to i14y

If your site Admin Center has the following page: Admin Center > YourSite > Manage Content > i14y Drawers, your site is connected to i14y. If you don’t see this page in the Admin Center, email us. You can also read about Getting Started with i14y.

Step 2. Add one or more Drawers

On Admin Center > YourSite > Manage Content > i14y Drawers, Click Add i14y Drawer in the upper right corner. If you have more than one website that will be sending content, add a separate Drawer for each of these sites.

Handle

Let us know what the handle for your drawer should be - the handle must be all lowercase alphanumeric, all one word, and can include underscores but no other special characters (e.g., agency_drawer_handle2).

The Drawer Description is optional

Step 3. Send Content to Fill your Drawer

After you have created your Drawer(s), click Show from the i14y Drawers list to find that Drawer’s secret API key. Use this secret key with your drawer handle in your API call or your CMS module to send your content to the right place.

Step 4. Review your Index

You can view the number of documents indexed for each drawer on the main i14y Drawers list, and when the most recent document was received. Click Show to view documents within a particular drawer. We display the most recent 1,000 items that were sent to the drawer. You can also search for keywords in the documents’ text, titles, and descriptions (Note: you cannot currently search for URLs).

Note: We use the Domains section to scope search results - if the domain(s) of your i14y content are not listed in the Domains section, that content will not appear on your search results page.

We send success and / or failure codes in response to your API call, so if the number of documents in our index doesn’t match what you sent, check those response codes.

Note: If you experience difficulty sending documents to i14y, it is possible your firewall is not letting you communicate with the i14y server. Check out our cURL test commands or view the full i14y documentation.


Caution: A pop-up message will appear when you hit Remove on a drawer: please review this pop-up message carefully. If you remove a drawer that is only associated with one search configuration, the drawer and its contents will be deleted from our system. If the drawer is attached to multiple search configurations, it will only be removed from the search configuration you are currently on. The pop-up message will indicate what type of drawer you have.

If you accidentally delete a drawer, you will need to set-up a new drawer and resend the content - we are unable to retrieve deleted drawers. If you accidentally remove a shared drawer but it is still associated with other search configurations, we can re-attach it to your site. Contact us for assistance.


Did you know? We can attach each i14y drawer to multiple search configurations: if you have a drawer that you’d like to use for multiple search sites, email us.