Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
    Analytics Model
    Metrics
      Get all MetricsgetPost MetricspostGet a MetricgetPut a MetricputDelete a MetricdeletePatch a Metricpatch
    Dashboards
    Context Filters
    Filter Views
    Visualization Object
    Dependency Graph
    Attribute Hierarchies
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Metrics (3.51)

Endpoint:/

Get all Metrics

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

Get all Metrics › path Parameters

  • workspaceIdstring · required

Get all Metrics › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy
  • 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:
    origin
    page
    all
    ALL

Get all Metrics › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Metrics › Responses

Request successfully processed

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

    Included resources

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

Post Metrics

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

Post Metrics › path Parameters

  • workspaceIdstring · required

Post Metrics › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Metrics › Request Body

  • dataobject · required

    JSON:API representation of metric entity.

Post Metrics › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of metric entity.

  • includedarray · unique

    Included resources

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

Get a Metric

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

Get a Metric › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Metric › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get a Metric › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Metric › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of metric entity.

  • includedarray · unique

    Included resources

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

Put a Metric

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

Put a Metric › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Metric › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy

Put a Metric › Request Body

  • dataobject · required

    JSON:API representation of metric entity.

Put a Metric › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of metric entity.

  • includedarray · unique

    Included resources

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

Delete a Metric

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

Delete a Metric › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete a Metric › 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 Metric › Responses

Successfully deleted

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

Patch a Metric

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

Patch a Metric › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Metric › 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
    facts
    attributes
    labels
    metrics
    datasets
    createdBy
    modifiedBy

Patch a Metric › Request Body

  • dataobject · required

    JSON:API representation of patching metric entity.

Patch a Metric › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of metric entity.

  • includedarray · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
Analytics ModelDashboards