Skip to main content
Version: 2026.1

Studio API Endpoints Documentation

This document provides a comprehensive overview of all Studio API endpoints in the Statistics Explorer bundle. These endpoints are designed for use with Pimcore's Studio Backend and provide data source management functionality for custom reports.

Overview​

All endpoints in this documentation are part of the Statistics Explorer bundle and are prefixed with the bundle's API path. They require authentication via Pimcore's Studio Backend authentication system.

Base Path: /pimcore-studio/api/statistics-explorer

Tags: StatisticsExplorer

Data Sources Endpoints​

1. Get Available Data Sources​

Endpoint: GET /custom-reports/data-sources

Route Name: pimcore_studio_api_statistics_explorer_custom_reports_data_sources

Purpose: Retrieves a list of all available data sources that can be used in custom reports.

Parameters: None

Response:

  • Type: Paginated collection
  • Schema: Collection of DataSource objects
  • Contains: List of available data sources with their identifiers and metadata

Data Source Fields Endpoints​

2. Get Data Source Fields​

Endpoint: GET /custom-reports/data-sources/{dataSource}/fields

Route Name: pimcore_studio_api_statistics_explorer_custom_reports_data_sources_fields

Purpose: Retrieves all available fields/columns from a specific data source.

Path Parameters:

  • dataSource (string, required) - The identifier of the data source to retrieve fields for
    • Example: db_assets

Query Parameters: None

Response:

  • Type: Collection
  • Schema: Fields object containing field definitions
  • Contains: List of available fields with their names, types, ...

3. Get Data Source Field Settings​

Endpoint: POST /custom-reports/data-sources/{dataSource}/fields/settings

Route Name: pimcore_studio_api_statistics_explorer_custom_reports_data_sources_fields_settings

Purpose: Retrieves field definitions with their available settings and configuration options. This endpoint provides detailed metadata about fields including available operations (filtering, sorting, aggregations) and field-specific settings that can be applied when building report columns.

Path Parameters:

  • dataSource (string, required) - The identifier of the data source
    • Example: db_assets

Request Body:

  • Type: JSON
  • Schema: DataSourceFieldsSettings
  • Attribute: Uses FieldSettingsRequestBody attribute for OpenAPI documentation

Response:

  • Type: Paginated collection
  • Schema: Collection of FieldDefinition objects
  • Contains: Detailed field definitions with:
    • Field metadata (name, type, label)
    • Available settings (operators, aggregations)

Notes​

  • All controllers are marked as @internal and are part of the bundle's internal API
  • The customreports context is consistently passed to service methods to scope operations appropriately
  • Field settings endpoint uses POST method due to complex request body requirements for field configuration
  • All endpoints are optimized for use within Pimcore's Studio Backend UI