Retrieve Information from a Search

To automatically start the synchronize action and retrieve tweets from a Twitter search, create a new fetch task by following these steps. The connector runs each fetch task automatically, based on the schedule that is configured in the configuration file.

To create a new Fetch Task

  1. Stop the connector.
  2. Open the configuration file in a text editor.
  3. In the [FetchTasks] section of the configuration file, specify the number of fetch tasks using the Number parameter. If you are configuring the first fetch task, type Number=1. If one or more fetch tasks have already been configured, increase the value of the Number parameter by one (1). Below the Number parameter, specify the names of the fetch tasks, starting from zero (0). For example:

    [FetchTasks]
    Number=1
    0=MyTask
  4. Below the [FetchTasks] section, create a new TaskName section. The name of the section must match the name of the new fetch task. For example:

    [FetchTasks]
    Number=1
    0=MyTask
    
    [MyTask]
  1. Ensure that the relevant OAuth parameters are included in the task. For information about how to configure authentication, see Configure OAuth Authentication.
  2. In the new section, set the following parameters:

    • Twitter V2 API.

      ApiVersion Set ApiVersion=V2.
      Search The query to use for searching Twitter.
      MaxResults (Optional) The maximum number of tweets to ingest.
    • Twitter V1 Premium Search API. You might prefer to use this API if you want to search for and ingest tweets older than seven days.

      ApiVersion Set ApiVersion=V1.
      PremiumProduct

      Set this parameter to specify the endpoint to use:

      • 30day - search tweets from the last 31 days.
      • fullarchive - search all tweets.
      PremiumLabel Set this parameter to the label associated with your Twitter development environment. This value is used to build the URL to the Premium Search endpoint.
      PremiumRuleTag A label to add to all tweets that match the query you specify with the Search parameter. You can use this parameter to add a common label to all tweets ingested by this fetch task.
      Search The query to use for searching Twitter.
      SearchFromDate

      The connector only retrieves tweets that were published after the specified date.

      Specify the date in UTC time using one of the following formats:

      • A date in the format YYYY-SHORTMONTH-DD H+:N+:S+, for example 2021-Mar-23 15:24:00.
      • A date in epoch seconds, for example 1616508998.
      SearchToDate

      The connector only retrieves tweets that were published before the specified date.

      Specify the date in UTC time using one of the following formats:

      • A date in the format YYYY-SHORTMONTH-DD H+:N+:S+, for example 2021-Mar-24 15:24:00.
      • A date in epoch seconds, for example 1616595398.
      MaxResults (Optional) The maximum number of tweets to ingest.
  3. Save and close the configuration file. You can now start the connector.