GoodData

GoodData is an analytics and business intelligence platform for building and embedding interactive dashboards, metrics, and self-service analytics. GoodData Cloud exposes a full REST API (Entity, Declarative, and Action APIs) for managing workspaces, data sources, the logical data model, metrics, visualizations, dashboards, AFM executions, users, and permissions, authenticated with a Bearer API token.

7 APIs 0 Features

AnalyticsBusiness IntelligenceEmbedded AnalyticsDashboardsData

APIs

GoodData Workspaces API

Create, read, update, and delete workspaces and workspace settings through the Entity API, supporting hierarchical and multi-tenant workspace structures at /api/v1/entities/work...

GoodData Data Sources API

Register and manage connections to data warehouses and databases via /api/v1/entities/dataSources, with connection testing through the Action API at /api/v1/actions/dataSources/...

GoodData Logical Data Model API

Retrieve and set the workspace logical data model (datasets, attributes, facts, references) as an all-in-one declarative document at /api/v1/layout/workspaces/{workspaceId}/logi...

GoodData Metrics API

Define and manage reusable MAQL metrics within a workspace through the Entity API at /api/v1/entities/workspaces/{workspaceId}/metrics.

GoodData Visualizations & Dashboards API

Manage visualization objects (insights) and analytical dashboards via /api/v1/entities/workspaces/{workspaceId}/visualizationObjects and /analyticalDashboards.

GoodData Execution / AFM API

Run analytical computations using the AFM (Analytical Foundation Model) via POST /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute and retrieve paged results from t...

GoodData Users & Permissions API

Manage users, user groups, and workspace permissions via /api/v1/entities/users, /api/v1/entities/userGroups, and workspace permission endpoints under the organization.

Collections

GoodData Cloud API

OPEN

Pricing Plans

Gooddata Plans Pricing

3 plans

PLANS

Rate Limits

Gooddata Rate Limits

4 limits

RATE LIMITS

FinOps

Gooddata Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: GoodData Cloud API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Workspaces
    type: folder
  items:
  - info:
      name: List all workspaces in the organization.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/entities/workspaces
    docs: List all workspaces in the organization.
  - info:
      name: Create a new workspace.
      type: http
    http:
      method: POST
      url: https://{{domain}}.gooddata.com/api/v1/entities/workspaces
      body:
        type: json
        data: '{}'
    docs: Create a new workspace.
  - info:
      name: Get a single workspace by id.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/entities/workspaces/:workspaceId
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
    docs: Get a single workspace by id.
- info:
    name: Data Sources
    type: folder
  items:
  - info:
      name: List all data sources.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/entities/dataSources
    docs: List all data sources.
  - info:
      name: Register a new data source.
      type: http
    http:
      method: POST
      url: https://{{domain}}.gooddata.com/api/v1/entities/dataSources
      body:
        type: json
        data: '{}'
    docs: Register a new data source.
  - info:
      name: Test a data source connection.
      type: http
    http:
      method: POST
      url: https://{{domain}}.gooddata.com/api/v1/actions/dataSources/:dataSourceId/test
      params:
      - name: dataSourceId
        value: ''
        type: path
        description: The id of the data source.
    docs: Test a data source connection.
- info:
    name: Logical Data Model
    type: folder
  items:
  - info:
      name: Get the declarative logical data model of a workspace.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/layout/workspaces/:workspaceId/logicalModel
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
    docs: Get the declarative logical data model of a workspace.
  - info:
      name: Set the declarative logical data model of a workspace.
      type: http
    http:
      method: PUT
      url: https://{{domain}}.gooddata.com/api/v1/layout/workspaces/:workspaceId/logicalModel
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
      body:
        type: json
        data: '{}'
    docs: Set the declarative logical data model of a workspace.
- info:
    name: Metrics
    type: folder
  items:
  - info:
      name: List all metrics in a workspace.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/entities/workspaces/:workspaceId/metrics
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
    docs: List all metrics in a workspace.
  - info:
      name: Create a MAQL metric in a workspace.
      type: http
    http:
      method: POST
      url: https://{{domain}}.gooddata.com/api/v1/entities/workspaces/:workspaceId/metrics
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
      body:
        type: json
        data: '{}'
    docs: Create a MAQL metric in a workspace.
- info:
    name: Visualizations & Dashboards
    type: folder
  items:
  - info:
      name: List all visualization objects (insights) in a workspace.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/entities/workspaces/:workspaceId/visualizationObjects
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
    docs: List all visualization objects (insights) in a workspace.
  - info:
      name: List all analytical dashboards in a workspace.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/entities/workspaces/:workspaceId/analyticalDashboards
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
    docs: List all analytical dashboards in a workspace.
- info:
    name: Execution / AFM
    type: folder
  items:
  - info:
      name: Execute an AFM computation.
      type: http
    http:
      method: POST
      url: https://{{domain}}.gooddata.com/api/v1/actions/workspaces/:workspaceId/execution/afm/execute
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
      body:
        type: json
        data: '{}'
    docs: Execute an AFM (Analytical Foundation Model) computation; returns a resultId.
  - info:
      name: Retrieve the computed data for an AFM execution result.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/actions/workspaces/:workspaceId/execution/afm/execute/result/:resultId
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
      - name: resultId
        value: ''
        type: path
        description: The id of the execution result.
    docs: Retrieve the computed data for an AFM execution result.
- info:
    name: Users & Permissions
    type: folder
  items:
  - info:
      name: List all users in the organization.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/entities/users
    docs: List all users in the organization.
  - info:
      name: List all user groups in the organization.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/entities/userGroups
    docs: List all user groups in the organization.
  - info:
      name: Get the declarative permissions assigned for a workspace.
      type: http
    http:
      method: GET
      url: https://{{domain}}.gooddata.com/api/v1/layout/workspaces/:workspaceId/permissions
      params:
      - name: workspaceId
        value: ''
        type: path
        description: The id of the workspace.
    docs: Get the declarative permissions assigned for a workspace.
bundled: true