Data API Interfaces

In situations where users do not login directly into Arcadia’s visual layer, we provide a trusted authentication mechanism that you can use for safe access to the system. See Trusted Authentication Mode for Embedded Apps.

http://<server>:<port>/arc/trustedauth/trusted/<ticket>/dataapi

After the trusted authentication mechanism generates a ticket for using Arcadia’s data layer, users may invoke the Data API through the GET http request on the following endpoint:

The specification of the data request is passed in as parameters to this endpoint:

dataset
This is a mandatory parameter that specifies the id of the target dataset of the data request.
dimensions
Either dimensions or aggregates parameter is mandatory. The dimensions parameter specifies a comma-separated list of requested dimensions.
aggregates
Either aggregates or dimensions parameter is mandatory. The aggregates parameter specifies a comma-separated list of requested aggregates.
filters
This is an optional parameter that specifies a comma-separated list of filter expressions that apply to the dataset.

On success, the system return an HTTP response of type text/json. The returned object is a dictionary with the following keys:

colnames
This is an array of strings, where each string specifies the name of a single column returned by the data request.
coltypes
This is an array of strings, where each string specifies the type of a single column returned by the data request.
rows
This is an array of arrays, where each inner array represents a single row of information returned by the data request.