Add or Edit a Coveo Twitter Source

Twitter is an online social networking service that enables users to post, read, and share short (140 characters or less) messages called “tweets”.

Twitter users can create lists of users or subscribe to lists made by other users. A list page displays the tweets posted by list members in reverse chronological order. Users can also create collections of tweets, which aggregate tweets that relate to a topic or an event, and can be shared with others.

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

  • Posted by a certain user

  • Containing certain keywords (hashtags)

  • Included in a certain list

  • Included in a certain collection

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 the source creator only (see Content Security). By default, a Twitter source undergoes a refresh every hour to retrieve Twitter content changes (publication, modification, or deletion).

Source Features Summary

Features Supported Additional information
Twitter version Latest cloud version Following available Twitter releases
Searchable content types Users, tweets1, 2, lists, and collections
Content update Refresh See limitations
Content security options Determined by source permissions
Source creator

Note 1: Tweets posted by protected users (protected tweets) can’t be indexed.

Note 2: Tweet keywords preceded by hashtags (#) or cashtags ($), and usernames (preceded by a @ character) are indexed as tweet metadata.


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

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

Add or Edit a Twitter Source

  1. If not already in the Add/Edit a Twitter Source panel, access the panel:

    • To add a source, in the main menu, under Content, select Sources > Add Source button > Twitter.


    • To edit a source, in the main menu, under Content, select Sources, and then double-click the Twitter source to edit.

  2. In the Add/Edit a Twitter Source panel, in the Configuration tab, enter appropriate values for the available parameters:

    • Source name

      A descriptive name for your source under 255 characters (not already in use for another source in this organization).

      You can’t change the source name once it’s created.

    • Item type and Value to index

      Use the Item type drop-down menu to select the type of item to index. Available item type 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.

        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.

        For list, enter bbc/bbc-news.

      • Query

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

        • #breakingnews

        • $GOOG

      • Collection

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

        For collection, enter collection ID 576828964162965504.

      Click the plus sign to add your item. Repeat to add another item to index.

    • Character optical recognition (OCR)

      Check this box if you want Coveo Cloud to extract text from image files or PDF files containing images (see Enable Optical Character Recognition). OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View (see Search Result Quick View).

      Since the OCR feature is available at an extra charge, you must first contact Coveo Sales to add this feature to your organization license. You can then enable it for your source.

    • Index

      When adding a source, if you have more than one logical (non-Elasticsearch) index in your organization, select the index in which the retrieved content will be stored (see Leverage Many Coveo Indexes). If your organization only has one index, this drop-down menu isn’t visible and you have no decision to make.

  3. Under Content to include:

    • 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 User’ followings (tweets of users followed by the user specified under Value to index) to index the corresponding content.

  4. In the 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.

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

    1. In the Access Level column, select View or Edit for each available group.

    2. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

    If you remove the Edit access level from all the groups of which you’re a member, you won’t be able to edit the source again after saving. Only administrators and members of other groups that have Edit access on this resource will be able to do so. To keep your ability to edit this resource, you must grant the Edit access level to at least one of your groups.

  6. Optionally, consider editing or adding mappings (see Adding and Managing Source Mappings).

    You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).

  7. Complete your source addition or edition:

    • Click Add Source/Save 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.

      On the Sources page, you must click Start initial build or Start required rebuild in the source Status column to add the source content or make your changes effective, respectively.


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

      Back on the Sources page, you can review the progress of your Twitter source addition or modification (see Adding and Managing Sources).

    Once the source is built or rebuilt, you can review its content in the Content Browser (see Inspect Items With the Content Browser).

  8. Optionally, review the source refresh schedule.

    By default, your Twitter source is refreshed every hour to quickly make the content changes searchable (additions, modifications, or deletions). When your Twitter content doesn’t change frequently, consider increasing the refresh time interval (such as every week) to optimize resource consumption (see Edit a Source Schedule).

What’s Next?

Review the default update schedule and optionally change it so that it better fits your needs (see Edit a Source Schedule). By default, your content is refreshed every hour.

Recommended Articles