Insights

Important

The GraphQL Insights API is currently in Early Availability status for customers on the AWS-US cluster. For more information, see GraphQL API policy.

With AppDirect Insights, marketplace owners (merchants) can use APIs to consolidate information into a dataset on the AppDirect Platform. Marketplace owners define the attributes of their datasets and publish data to them. They then define metrics that query a dataset so they can use the results to measure or track their information.

They can then retrieve data for these metrics, and present this information in visualizations—graphs, charts, or in any other format they choose—on their platforms, with front-end designs that they develop for themselves.

Key concepts

The Insights feature is based on a few key concepts. These include:

• Dataset—A container that stores selected information, much like a table in a database.

• Attribute—An item within a dataset, much like a column in a table. Each attribute in a dataset has a type (DIMENSION or MEASURE) and datatype (STRING, INTEGER, DATE, and so on).

• Metric—A predefined query that retrieves data for selected attributes of a dataset.

• Filter—A definition of the criteria to be used when selecting data for a metric.

To use Insights, you must first define a dataset and the attributes represented in it. You can then push data about your products and subscription to the dataset, and define metrics and filters to retrieve data for specific attributes.

You can use your metrics to retrieve data from the dataset in JSON format. Your front-end systems can then interpret and operate on the data, and render the results in graphs, charts, or other visualizations so you can view and analyze them.

Set up Insights

To set up Insights, see Getting Started with Insights.