Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
    Analytics Model
    Metrics
    Dashboards
      Get all DashboardsgetPost DashboardspostGet a DashboardgetPut DashboardsputDelete a DashboarddeletePatch a Dashboardpatch
    Context Filters
    Filter Views
    Visualization Object
    Dependency Graph
    Attribute Hierarchies
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Dashboards (3.51)

Endpoint:/

Get all Dashboards

GET
/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards

Get all Dashboards › path Parameters

  • workspaceIdstring · required

Get all Dashboards › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL
  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    visualizationObjects
    analyticalDashboards
    labels
    metrics
    datasets
    filterContexts
    dashboardPlugins
  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    origin
    accessInfo
    page
    all
    ALL

Get all Dashboards › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Dashboards › Responses

Request successfully processed

  • dataobject[] · unique · required
  • includedarray · unique

    Included resources

  • linksobject
  • metaobject
GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards

Post Dashboards

POST
/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards

Post Dashboards › path Parameters

  • workspaceIdstring · required

Post Dashboards › query Parameters

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    visualizationObjects
    analyticalDashboards
    labels
    metrics
    datasets
    filterContexts
    dashboardPlugins
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    origin
    accessInfo
    all
    ALL

Post Dashboards › Request Body

  • dataobject · required

    JSON:API representation of analyticalDashboard entity.

Post Dashboards › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of analyticalDashboard entity.

  • includedarray · unique

    Included resources

  • linksobject
POST /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards

Get a Dashboard

GET
/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}

Get a Dashboard › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Dashboard › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    visualizationObjects
    analyticalDashboards
    labels
    metrics
    datasets
    filterContexts
    dashboardPlugins
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    permissions
    origin
    accessInfo
    all
    ALL

Get a Dashboard › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Dashboard › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of analyticalDashboard entity.

  • includedarray · unique

    Included resources

  • linksobject
GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}

Put Dashboards

PUT
/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}

Put Dashboards › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put Dashboards › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    visualizationObjects
    analyticalDashboards
    labels
    metrics
    datasets
    filterContexts
    dashboardPlugins

Put Dashboards › Request Body

  • dataobject · required

    JSON:API representation of analyticalDashboard entity.

Put Dashboards › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of analyticalDashboard entity.

  • includedarray · unique

    Included resources

  • linksobject
PUT /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}

Delete a Dashboard

DELETE
/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}

Delete a Dashboard › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete a Dashboard › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Delete a Dashboard › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}

Patch a Dashboard

PATCH
/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}

Patch a Dashboard › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Dashboard › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    visualizationObjects
    analyticalDashboards
    labels
    metrics
    datasets
    filterContexts
    dashboardPlugins

Patch a Dashboard › Request Body

  • dataobject · required

    JSON:API representation of patching analyticalDashboard entity.

Patch a Dashboard › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of analyticalDashboard entity.

  • includedarray · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
MetricsContext Filters