Introduction

The Viare Insights API is intended to provide key performance data from Viare to BI tools to supplement the master data available from other systems and API's.

The data available from Insights is designed to provide data points not available from other sources, and to provide compelling information for trend analysis on key elements.

The Insights API provides access to several key data sources via a highly accessible RESTful API which can be consumed by 3rd parties.

Response Types

The Insights API provides 4 types of standard response types, named Metrics, Groupings, Summaries and Multivariate. The Order Volumes data source provides a specific response type.

Metrics

Metrics provide basic date and count (integer/whole number) information for a specific metric.

Grouping

Groupings provide additional information on Metrics, and include a Name (string) element.

Summaries

Summaries provide an additional Value (decimal/currency) field, typically used where a value or continuous measure is needed.

Multivariate

Multivariate sources provide a more comprehensive set of data where there are more complex variables and measures available than can be represented by the more atomic types above. These sources are less efficient to produce and consume, and so are used for specific datasets.

Order Volumes

A unique and specific type, this data type provides more detailed information about order volumes than can be provided through the basic response types.

Response Formats

The Insights API supports responses in either XML or JSON. The specific format can be requested by using the HTTP Accept header.

Typically, BI tools will have a preferred data type for web requests, this can usually be left to the default values. If a selection is required, it is recommended to use JSON (text/json) as it is more compact and efficient to transport across networks (compared to XML).