Splunk® Enterprise

Search Reference

Download manual as PDF

Splunk version 4.x reached its End of Life on October 1, 2013. Please see the migration information.
This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Download topic as PDF

typeahead

Description

Returns typeahead on a specified prefix and returns a max of count results. Can be targeted to an index and restricted by time.

Syntax

typeahead prefix=<string> count=<int> [max_time=<int>] [<index-specifier>] [<starttimeu>] [<endtimeu>] [collapse]

Required arguments

prefix
Syntax: prefix=<string>
Description: The full search string to return typeahead information.
count
Syntax: count=<int>
Description: The maximum number of results to return.

Optional arguments

index-specifier
Syntax: index=<string>
Description: Search the specified index instead of the default index.
max_time
Syntax: max_time=<int>
Description: The maximum time in seconds that typeahead can run. If max_time=0, there is no limit.
startimeu
Syntax: starttimeu=<int>
Description: Set the start time to N seconds since the epoch (Unix time).
Default: 0
endtimeu
Syntax: endtimeu=<int>
Description: Set the end time to N seconds since the epoch (Unix time).
Default: now
collapse
Syntax: collapse=<bool>
Description: Specify whether to collapse terms that are a prefix of another term and the event count is the same.
Default: true

Examples

Example 1: Return typeahead information for sources in the "_internal" index.

| typeahead prefix=source count=10 index=_internal

Answers

Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has using the typeahead command.

PREVIOUS
trendline
  NEXT
typelearner

This documentation applies to the following versions of Splunk® Enterprise: 4.3, 4.3.1, 4.3.2, 4.3.3, 4.3.4, 4.3.5, 4.3.6, 4.3.7


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters