Metric Pipeline Rule

Get Metric Pipeline Rule

Endpoint to retrieve a single Metric Pipeline Rule by ID

post/metric-pipeline-rule/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Metric Pipeline Rule to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "ruleType": true,
    "filterCondition": true,
    "renameFromKey": true,
    "renameToKey": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "serviceId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Example short text",
    "description": "This is an example of longer text content that might be stored in this field.",
    "ruleType": "Filter",
    "filterCondition": "All",
    "filters": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "renameFromKey": "Example short text",
    "renameToKey": "Example short text",
    "addAttributeKey": "Example short text",
    "addAttributeValue": "This is an example of longer text content that might be stored in this field.",
    "redactReplacement": "Example short text",
    "samplePercentage": 42,
    "isEnabled": true,
    "sortOrder": 42,
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.