Rules lookup

v1.0.0

Returns rules from a User's active rule set. Users can fetch all of their rules or a subset, specified by the provided rule ids.

Input

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Unique identifier of this rule."
      }
    },
    "max_results": {
      "type": "integer",
      "format": "int32"
    },
    "pagination_token": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A user-provided stream filtering rule.",
        "required": [
          "value"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of this rule."
          },
          "tag": {
            "type": "string",
            "description": "A tag meant for the labeling of user provided rules."
          },
          "value": {
            "type": "string",
            "description": "The filterlang value of the rule."
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "sent"
      ],
      "properties": {
        "next_token": {
          "type": "string",
          "description": "The next token."
        },
        "result_count": {
          "type": "integer",
          "format": "int32",
          "description": "Number of Rules in result set."
        },
        "sent": {
          "type": "string"
        },
        "summary": {
          "type": "object"
        }
      }
    }
  }
}