Jump to

• Request
• Response

Get configuration metric extension data source for a target

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targets/{targetId}/configMetricGroups/{metricName}/{dataSourceName}

Returns details of the specified configuration extension data source and its metrics for the target.

Request

Path Parameters

• dataSourceName(required): string
  Data source name.
• metricName(required): string
  Metric group name.
• targetId(required): string
  the target id

Query Parameters

• containerSnapshotId: string
  Container snapshot identifier (optional).
• isConfigExtension(required): boolean
  Required. true for configuration extension metrics, false for built-in metrics.
• limit: integer(int32)
  Minimum Value: 1

  Maximum Value: 2000

  to limit the number of rows returned. If the result set is greater follow the previous and next links in the results.

  Example:

  20

• page: string
  system generated page token used in the self, next and previous links.
• sort: string
  Sort results as field:direction (example: id:ASC).

  Example:

  id:ASC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ConfigPropertiesTable

Type: object

Configuration metric results in a tabular format. Includes column metadata and rows returned as JSON objects where keys are column names.

Show Source

• columnDisplayNames: array columnDisplayNames
  Display names for the columns in the same order as columnNames.
• columnNames: array columnNames
  Array of column names.
• count: integer
  Number of rows returned in this response.
• items: array items
  Rows of the configuration table. Each row is a JSON object mapping column name to value.
• links: object links
  Result set navigation links (self/next/previous when available).
• metricName: string
  Metric name.

  Example: MetricName
• targetId: string
  Target identifier.

  Example: TargetId
• targetName: string
  Target name.

  Example: TargetName
• targetTypeName: string
  Target type name.

  Example: TargetTypeName
• timeCollected: string
  Time collected.

  Example: 14-01-2026
• total: integer
  Total number of rows available.

{
    "x-em-sdk-level":"emSDK",
    "description":"Configuration metric results in a tabular format. Includes column metadata and rows returned as JSON objects where keys are column names.\n",
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target name.",
            "example":"TargetName"
        },
        "targetTypeName":{
            "type":"string",
            "description":"Target type name.",
            "example":"TargetTypeName"
        },
        "targetId":{
            "type":"string",
            "description":"Target identifier.",
            "example":"TargetId"
        },
        "metricName":{
            "type":"string",
            "description":"Metric name.",
            "example":"MetricName"
        },
        "timeCollected":{
            "type":"string",
            "description":"Time collected.",
            "example":"14-01-2026"
        },
        "columnNames":{
            "type":"array",
            "description":"Array of column names.",
            "items":{
                "type":"string"
            },
            "example":[
                "columnName1",
                "columnName2"
            ]
        },
        "columnDisplayNames":{
            "type":"array",
            "description":"Display names for the columns in the same order as columnNames.",
            "items":{
                "type":"string"
            },
            "example":[
                "columnDisplayName1",
                "columnDisplayName2"
            ]
        },
        "links":{
            "type":"object",
            "description":"Result set navigation links (self/next/previous when available)."
        },
        "count":{
            "type":"integer",
            "description":"Number of rows returned in this response."
        },
        "total":{
            "type":"integer",
            "description":"Total number of rows available."
        },
        "items":{
            "type":"array",
            "description":"Rows of the configuration table. Each row is a JSON object mapping column name to value.\n",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : columnDisplayNames

Type: array

Display names for the columns in the same order as columnNames.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display names for the columns in the same order as columnNames.",
    "items":{
        "type":"string"
    },
    "example":[
        "columnDisplayName1",
        "columnDisplayName2"
    ]
}

Example:

[
    "columnDisplayName1",
    "columnDisplayName2"
]

Nested Schema : columnNames

Type: array

Array of column names.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of column names.",
    "items":{
        "type":"string"
    },
    "example":[
        "columnName1",
        "columnName2"
    ]
}

Example:

[
    "columnName1",
    "columnName2"
]

Nested Schema : items

Type: array

Rows of the configuration table. Each row is a JSON object mapping column name to value.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Rows of the configuration table. Each row is a JSON object mapping column name to value.\n",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: object

Result set navigation links (self/next/previous when available).

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

503 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

Back to Top