Output Type Options

After identifying the token that you want to use to access the V‑Spark installation or company data that you want to query (discussed in Reference for the /search API), the most basic option that you will want to specify is the output option. The value that you provide for this option determines the other options that you can provide when calling the /search API:

output=TYPE

Specifies the type of results that you want to receive from a search query:

count

Returns the number of search results that matched your query. After specifying the output=count option on the command line or in a JSON file, you can also specify any of the options discussed in Search Term Options.

details

Returns a collection of the Voci JSON for the search results for each result that matched your query. After specifying the output=details option on the command line or in a JSON file, you can also specify any of the options discussed in Search Term Options or Output Sorting Options.

summary

Returns a summary of the matching search results in JSON or Comma-Separated Value (CSV) format. This is the default value, and is used when no other output value is specified. After specifying the output=summary option on the command line, in a JSON file, or by using it as a default value that you are not overriding, you can also specify any of the options discussed in Search Term Options, Output Sorting Options, Output Field Options, or Output Format Options.

zip

Returns all files that matched your query in a zip file. The zip file that is returned includes these audio files hierarchically. After specifying the output=zip option on the command line or in a JSON file, you can also specify any of the options discussed in Search Term Options or Output Sorting Options. You can also pass the zipfiles= parameter to identify the files that you want to be included in the output zip file. This must be one or more of json, mp3, or text. Specifying multiple values is done as a comma-separated list.

When explicitly specified in a JSON file as part of a /search POST call, the output value is specified as the following in your JSON file of search specifications:

"output" : "value"