Skip to content
v3 API/Rules/
Get all rules in an accou...

Get all rules in an account

Request

POST /v3/rule-library
Security
API_Key
Query
pageinteger, >= 0

Number of results page of an endpoint with paginated results

Default:0
sizeinteger, [ 50 .. 1000 ]
Default:50
sortBystring
Enum:"NAME""TYPE""AUDITS""WEB_JOURNEYS""APP_JOURNEYS""OWNER""MODIFIED_AT"
sortDescboolean

Controls sorting order

Default:false
Bodyapplication/json
idinteger, (int64)

Rule ID

Example:12
ruleNamestring
Example:"Filter by rule name. Matched as contains, case insensitive."
labelsArray of integers
notificationEnabledboolean
createdByUserIdinteger

ID of a user

Example:123
fromTemplateboolean
POST
/v3/rule-library
curl -i -X POST \
  'https://api.observepoint.com/v3/rule-library?page=0&size=50&sortBy=NAME&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 12,
    "ruleName": "Filter by rule name. Matched as contains, case insensitive.",
    "labels": [
      223
    ],
    "notificationEnabled": true,
    "createdByUserId": 123,
    "fromTemplate": true
  }'

Responses

Rules

Bodyapplication/json
paginationMetadataobject
rulesArray of objects
Response
{
  "paginationMetadata": {
    "totalCount": 0,
    "totalPageCount": 0,
    "pageSize": 0,
    "currentPageSize": 0,
    "currentPageNumber": 0
  },
  "rules": [
    { … }
  ]
}