V-Spark Online Help

Reference for the /search API

The /search API enables you to search all transcripts for an organization or those that are located in a folder within an organization. You can search using two different REST methods:

GET

Search parameters are specified as options that are passed as parameters which are part of a query

POST

Search parameters are specified name/value pairs in a JSON file that is passed to the API

Synopsis

GET /search/CO_SHORT/ORG_SHORT?token=TOKEN&OPTIONS...
GET /search/CO_SHORT/ORG_SHORT/FOLDERNAME?token=TOKEN&OPTIONS...
POST /search/CO_SHORT/ORG_SHORT?token=TOKEN&OPTIONS...
POST /search/CO_SHORT/ORG_SHORT/FOLDERNAME?token=TOKEN&OPTIONS...

Description

As shown in the synopsis, the V‑Spark /search API supports both GET and POST calls, both of which search a specified V‑Spark installation, but which pass parameters to the API in different ways. See Using the /search API with cURL for examples of passing parameters in both ways using the cURL command. See Using the /search API with Python for examples of using both the GET and POST models in Python.

Variables used in a call to the /search API are the following:

CO_SHORT

The short name of the company whose transcripts you want to search

ORG_SHORT

The short name of the organization that you are interested in. Finding that information is shown in /transcribe API Reference.

FOLDERNAME

The name of the V‑Spark Folder whose transcripts you want to search

TOKEN

The V‑Spark authorization token that you are using to establish permission to retrieve information. You can either use the root token for the target V‑Spark installation (located in the file /opt/voci/state/vspark/apitoken) or the authorization token for the company under which the specified ORG_SHORT or FOLDERNAME is located. Locating a company's authorization token is shown in V‑Spark API Permission Requirements.

Subsequent sections provide detailed information about the many GET options (which map to POST name/value pairs) that you can specify in calls to the /search API. Options are discussed in the form that they would be specified as part of a GET call. The value that you specify for the output option determines what other sets of options you can specify.

Content Types

  • GET method options are expected as query parameters with the "text/html" MIME type

  • POST method options are expected as JSON objects with the "application/json" MIME type

  • count output type returns plain text data with the "text/html" MIME type

  • summary output type with json option returns JSON-formatted data with the "text/html" MIME type

  • summary output type with csv option returns comma separated values with the "text/html" MIME type

  • details output type returns JSON-formatted data with the "text/html" MIME type

  • zip output type returns a zip file with the "application/zip" MIME type

  • Errors will be returned with the "text/html" MIME type