Add or Edit a Coveo Twitter Source

Index Content Coveo Relevance Cloud Developer System Administrator Product Documentation

Members of the Administrators and Content Managers built-in groups can add specific Twitter content to a Coveo organization. This content may consist of tweets:

  • Posted by a certain user

  • Containing certain keywords (hashtags)

  • Included in a certain list

  • Included in a certain collection

Example

You want to index content regarding or related to your company. Therefore, you index tweets posted by your company account and by your CEO, as well as relevant keywords such as product, partner, and event names. You could also index existing lists or collections made by your company account or any other user.

In a Coveo-powered search interface, the source content is accessible to either everyone or some specific users and groups only (see Content Security).

Tip
Leading practice

The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About Crawling Speed for information on what can impact crawling speed, as well as possible solutions.

Source Key Characteristics

Features Supported Additional information

Twitter version

Latest cloud version

Following available Twitter releases

Searchable content types

check

Users, tweets,[1][2] lists, and collections.

Content update operations

refresh

check

Takes place every hour by default. See limitations.

rescan

check

rebuild

check

Content security options

Same users and groups as in your content system

x

Specific users and groups

check

Everyone

check

Limitations

  • During a source refresh, deleted items can’t be detected and therefore require a source rescan or rebuild to be updated or removed.

  • Source refresh can’t be performed if the last refresh, rescan, or rebuild didn’t end normally, i.e., the source was stopped, paused, or an exception occurred.

  • Only the first 140 characters of tweets are indexed.

  • Media content, such as pictures and videos, isn’t supported at this time.

Add or Edit a Twitter Source

When adding or editing a Twitter source, follow the instructions below.

"Configuration" Tab

In the Add/Edit a Twitter Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.

General Information

Source Name

Enter a name for your source.

Tip
Leading practice

A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens (-), and underscores (_). Avoid spaces and other special characters.
Item Type and Value to Index

Use the Item type drop-down menu to select the type of item to index. Click the plus sign (+) to add items. Available options are:

  • User

    Under Value to index, you can enter several usernames separated by a comma and a space character. You don’t need to use the preceding @ character.

    Example

    BBCNews, BBCBreaking, BBCWorld

  • List

    Under Value to index, enter the username of the list creator and the list name as it appears in the list URL. The username and the list name must be formatted as follows: username/list-name.

    Example

    For list https://twitter.com/bbc/lists/bbc-news, enter bbc/bbc-news.

  • Query

    Under Value to index, enter a string preceded by a hashtag (#) or a cashtag ($) character.

    Examples

    • #breakingnews

    • $GOOG

  • Collection

    Under Value to index, enter the collection ID. You can find this numerical string in the collection page URL.

    Example

    For collection https://twitter.com/NYTNow/timelines/576828964162965504, enter collection ID 576828964162965504.

Optical Character Recognition (OCR)

If you want Coveo to extract text from image files or PDF files containing images, check the appropriate box. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.

Note

Contact Coveo Sales to add this feature to your organization license.

"Content to Include" Section

Select Old items to keep in the index the items that aren’t reindexed following a source configuration change. Unselect the option when you want to delete these items.

If indexing a user, select Mentions, Replies, Retweets, and Users' followings (tweets of users followed by the users specified under Value to index) to index the corresponding content.

"Content Security" Tab

Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content Security.

"Access" Tab

In the Access tab, set whether each group and API key can view or edit the source configuration (see Resource Access):

  1. If available, in the left pane, click Groups or API Keys to select the appropriate list.

  2. In the Access Level column for groups or API keys with access to source content, select View or Edit.

Completion

  1. Finish adding or editing your source:

    • When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon, click Add Source/Save.

      Note

      On the Sources (platform-ca | platform-eu | platform-au) page, you must click Launch build or Start required rebuild in the source Status column to add the source content or to make your changes effective, respectively.

    • When you’re done editing the source and want to make changes effective, click Add and Build Source/Save and Rebuild Source.

      Back on the Sources (platform-ca | platform-eu | platform-au) page, you can review the progress of your source addition or modification.

      Once the source is built or rebuilt, you can review its content in the Content Browser.

  2. Optionally, consider editing or adding mappings once your source is done building or rebuilding.

What’s Next?

Schedule source updates.

1. weets posted by protected users (protected tweets) can’t be indexed.
2. Tweet keywords preceded by hashtags (#) or cashtags ($), and usernames (preceded by a @ character) are indexed as tweet metadata.