Skip to main content

API Overview

Developer

The DataCentral REST API allows external applications and internal tooling to interact programmatically with your DataCentral Instance and Tenants.

You can use the API to:

  • Embed reports securely into your own custom applications (ISV Embedding).
  • Provision and manage users, roles, and Organizational Units (OUs).
  • Import Power BI items and configure Row-Level Security.
  • Automate workflows using webhooks and Tasks.

1. Base URL​

All API requests are routed through your specific Instance API domain. The standard syntax is:

https://api.{instancename}.datacentral.ai/v1

(Note: Replace {instancename} with the actual name of your DataCentral instance. If you are unsure of your instance name, contact your Host Administrator.)

2. Conventions​

The DataCentral API follows standard RESTful conventions:

  • Format: All request payloads and response bodies are formatted as JSON (application/json).
  • Timestamps: All dates and times are returned in ISO 8601 format (e.g., 2026-02-01T12:30:00Z).
  • Pagination: Endpoints that return collections of objects support pagination using page and pageSize query parameters.
  • Errors: Unsuccessful requests return a standardized error object containing an error code and a human-readable message.

3. Object Model Summary​

The API interacts with the following core objects:

ObjectDescription
TenantA specific tenant environment containing its own settings, users, and content.
UserAn identity (Entra ID, User Pass, or Mobile ID) that can log in to the tenant.
RoleA System, Report, or RLS role that defines access permissions.
OUAn Organizational Unit used to group users hierarchically.
ItemA Power BI Report, Dashboard, or App imported into the tenant.
TaskAn automated action (e.g., a webhook or DAX query) bound to a report visual.

Next Steps​

Before you can make API calls, you must understand how to authenticate. Proceed to the Authentication guide to learn how to generate API Keys and Tenant Passphrases.