SAPI Query Objects

The JSON objects used in the query have these values: access_token, query, command, stream_type, schema_version, and api_version.

access_token
The OAuth token obtained from an out-of-bound service. For details and examples of Webtrends libraries for authenticating to Webtrends Streams, see github.com/Webtrends/Streams-OAuth-Libraries.

Note: The access_token is only needed to open a connection.
query
The query to apply to the stream of data. See Example: Monitoring campaign performance. Supplying the query is optional when opening the connection, changing the stream type, or changing the filter.
command
The action to take. Valid values are stream or filter.

  • Use stream to open a connection. The stream_type value specifies the type of stream to use. For an existing connection, you can use stream to change the stream type, for example, from content to traffic_source.
  • Use filter to filter a stream that is already open.
stream_type
The type of stream to use. See Stream Types for a complete listing.
schema_version
The version of the JSON schema to return in the messages.

Note: You must provide at least the major version; the minor version is optional.
api_version
The SAPI version to use.

Note: You must provide at least the major version; the minor version is optional.