Overview

Aloudata CAN provides a comprehensive set of API services for developers, including access credential management, metric queries, multidimensional metric attribution, dimension management, metric management, metric and dimension category management, and metric view management.

User and Tenant Management

API Title	API Overview
Register a User	Adds a user to the metric platform.
Register a Tenant	Adds a tenant to the metric platform.
Add a User to a Tenant	Binds a user to a tenant.

Data Source Management

API Title	API Overview
Register a Data Source	Adds a data source to the metric platform.

Permission Management

API Title	API Overview
Grant Permissions	Grants specified permissions to a user in the metric platform.

Access Credential Management

Token operations: create and revoke access tokens, and retrieve an access key and secret key pair by username.

API Title	API Overview
Get Access Credentials	Requests an API access credential, or token, from the metric platform.
Delete Access Credentials	Actively revokes an existing access token.
Get Access Keys by User	Retrieves the access keys associated with a specified user account.

Metric Queries

API Title	API Overview
Query Metric Data	Queries calculated metric results by combining metrics and dimensions.

Dimension Management

Dimension operations include creating, editing, deleting, retrieving details, browsing lists, and previewing dimension values.

API Title	API Overview
Create a Dimension	Creates a dimension in the metric platform.
Update a Dimension	Updates the metadata of a specified dimension.
Delete a Dimension	Deletes a dimension.
Get Dimension Details	Retrieves detailed information for a specified dimension.
List Dimensions	Retrieves dimensions that match specified conditions.
Preview Dimension Values	Previews the values of a specified dimension.

Metric Management

Metric management supports creating, deleting, and updating metrics. It also provides metric data retrieval, list queries including tree views, dimension compatibility checks, and single or bulk metric detail queries.

API Title	API Overview
Create a Metric	Creates a metric in the metric management system.
Update a Metric	Updates the metadata of a specified metric.
Delete a Metric	Deletes a metric.
List Metrics	Retrieves all metrics under a tenant.
List Metrics as a Tree	Retrieves metrics in a tree structure.
Query Available Dimensions	Queries the dimensions available for one metric, or the shared available dimensions for multiple metrics.
Query All Available Dimensions	Queries all available dimensions for one metric or a set of metrics.
Get Single Metric Details	Retrieves metric details.
Get Metric Details in Bulk	Retrieves metric details in bulk.

Metric and Dimension Category Management

Metric and dimension category operations include creating, updating, deleting, and listing metric and dimension categories.

API Title	API Overview
Create a Category	Creates a metric category or dimension category in the metric platform.
Update a Category	Updates a metric category or dimension category in the metric platform.
Delete a Category	Deletes a metric category or dimension category from the metric platform.
List Categories	Lists categories of a specified type.

Metric View Management

Metric view management lets users create, delete, and edit metric views, query view details and lists including tree views, and retrieve specific view details by ID.

API Title	API Overview
Create a Metric View	Creates a metric view in the metric management system.
Update a Metric View	Updates a specified metric view.
Delete a Metric View	Deletes a metric view.
List Metric Views	Searches metric views by fuzzy matching on keywords.
Get Metric View Details	Retrieves configuration details for a metric view.
Query Metric View Results	Retrieves the result set for a metric view.
List Metric Views as a Tree	Retrieves metric views in a tree structure.
Get Metric View Details by ID	Retrieves metric view details by ID.

Metric Attribution Analysis

Multidimensional attribution analysis provides drill-down analysis, query validation, and compound attribution analysis for metrics.

API Title	API Overview
Query Metric Tree Attribution Analysis	Queries attribution analysis reports for metrics decomposed as a tree.
Query Multidimensional Metric Attribution Analysis	Queries multidimensional attribution results for metrics and dimensions.
Validate Multidimensional Metric Attribution Analysis	Validates whether a metric can be used for attribution analysis.
Drill Down into Multidimensional Metric Attribution Analysis	Queries drill-down multidimensional attribution results for metrics and dimensions.

Metric Acceleration (Result Acceleration)

API Title	API Overview
Create Acceleration	Creates application acceleration in Aloudata CAN.
Backfill Data	Creates a data backfill task for an application acceleration plan in Aloudata CAN.
Get Acceleration Details	Retrieves application acceleration details in Aloudata CAN.
Get Update Status	Retrieves the latest refresh time and data date for a materialized table in Aloudata CAN.

Acceleration Data Updates

Data updates use APIs to update materialized tables downstream of datasets.

API Title	API Overview
Data Update	Updates materialized table data related to the table.