Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Business Metric APIs/ Querying Metric Dimensions
Updated on 2022-09-15 GMT+08:00
View PDF

Querying Metric Dimensions

Function

This API is used to query metric dimensions.

URI

GET /v2/{project_id}/design/biz-metrics/dimensions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

data

Object

Returned data

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. An array of dimension names is returned.

{
  "data" : {
    "value" : [ "Vendor" ]
  }
}

Status Codes

Status Code

Description

200

The operation succeeds. An array of dimension names is returned.

400

BadRequest

401

Unauthorized

403

Forbidden
Parent topic: Business Metric APIs