Skip to content
/Rules

V2 API

Download OpenAPI description
SCALA-API.openapi.json
SCALA-API.openapi.yaml
Languages
Servers
https://api.observepoint.com/v2/

Tags

Endpoints for managing tags and tag-related operations including tag metadata and configuration

Operations

Rules

Endpoints for managing rules including creation, configuration, assignment, and rule-based validation logic

Operations

Create new rule

Request

POST /v2/rules
Security
API_Key
Bodyapplication/jsonrequired

Rule create information

checkTimesinteger(int32)required
isDefaultRulenumber
labelsArray of objects
matchAllFiltersbooleanrequired
namestringrequired
pageFiltersArray of objects
recipientsArray of strings
tagsArray of objects
curl -i -X POST \
  https://api.observepoint.com/v2/rules \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "checkTimes": 0,
    "isDefaultRule": 0,
    "labels": [
      {
        "id": 0
      }
    ],
    "matchAllFilters": true,
    "name": "string",
    "pageFilters": [
      {
        "matchType": "Equals",
        "ruleId": 0,
        "type": 1,
        "value": "string"
      }
    ],
    "recipients": [
      "string"
    ],
    "tags": [
      {
        "account": "string",
        "clause": "If",
        "matchType": "Equals",
        "ruleId": 0,
        "statusCode": {
          "matchType": "Equals",
          "value": 0,
          "valueType": "Specific"
        },
        "tagId": 0,
        "validationDescription": "string",
        "variables": [
          {
            "matchType": "Equals",
            "ruleTagId": 0,
            "selectorType": "String",
            "validationDescription": "string",
            "value": "string",
            "valueTagId": 0,
            "variable": "string"
          }
        ]
      }
    ]
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
checkTimesinteger(int32)required
createdAtstring(date-time)required
createdByinteger(int32)required
fromTemplatebooleanrequired
idinteger(int32)required
isDefaultRulebooleanrequired
labelsArray of objects
matchAllFiltersbooleanrequired
namestringrequired
pageFiltersArray of objects
recipientsArray of strings
tagsArray of objects
updatedAtstring(date-time)required
Response
application/json
{
  "accountId": 0,
  "checkTimes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "fromTemplate": true,
  "id": 0,
  "isDefaultRule": true,
  "labels": [
    { … }
  ],
  "matchAllFilters": true,
  "name": "string",
  "pageFilters": [
    { … }
  ],
  "recipients": [
    "string"
  ],
  "tags": [
    { … }
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get list of rule preview objects

Request

GET /v2/rules/previews
Security
API_Key
curl -i -X GET \
  https://api.observepoint.com/v2/rules/previews \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
idinteger(int32)required
isDefaultRulebooleanrequired
labelsArray of objectsrequired
labels[].​idinteger(int32)required
labels[].​namestringrequired
namestringrequired
]
Response
application/json
[
  {
    "id": 0,
    "isDefaultRule": true,
    "labels": [ … ],
    "name": "string"
  }
]

Get original rule page filter id by given rule page filter snapshot id

Request

GET /v2/rules/snapshots/page-filters/{pageFilterSnapshotId}/original
Security
API_Key
Path
pageFilterSnapshotIdinteger(int32)required
Bodyapplication/json
accountIdinteger(int32)required
accountStatusstringrequired
Enum"ACTIVE""ACTIVE_BILLING_PROBLEM""INACTIVE_BILLING_FAILED""INACTIVE_USER_CANCELLED""INACTIVE""DEMO"
accountTypestringrequired
Enum"ADOBE_AUDITOR""FREE""CONTRACT""CPM_PARTNER""SAMPLE""INTERNAL""CONTRACT_SELF_SERVICE"
authTokenobject
capabilitiesobjectrequired
capabilities.​customProxySupportbooleanrequired
capabilities.​strongPasswordPolicybooleanrequired
capabilities.​vpnSupportbooleanrequired
credsExpiredbooleanrequired
emailstringrequired
featuresArray of objectsrequired
idinteger(int32)required
isAccountActivebooleanrequired
isAccountAdminbooleanrequired
isLongTermTokenbooleanrequired
isOpAdminbooleanrequired
isOpSysAdminbooleanrequired
isReadOnlybooleanrequired
isUserbooleanrequired
isUserTokenbooleanrequired
isVisitorbooleanrequired
loginAsRequestedByUserIdnumber
permissionsobjectrequired
permissions.​intValueinteger(int32)required
permissions.​stringValuestringrequired
snowflakeUsageobjectrequired
snowflakeUsage.​useForAdobeAuditorbooleanrequired
snowflakeUsage.​useForAppJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForAppJourneysbooleanrequired
snowflakeUsage.​useForAuditsbooleanrequired
snowflakeUsage.​useForLiveConnectbooleanrequired
snowflakeUsage.​useForLiveConnectRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneysbooleanrequired
snowflakeUsage.​usedbooleanrequired
timezoneobjectrequired
timezone.​fixedbooleanrequired
timezone.​idstringrequired
tokenTypeobjectrequired
curl -i -X GET \
  'https://api.observepoint.com/v2/rules/snapshots/page-filters/{pageFilterSnapshotId}/original' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": 0,
    "accountStatus": "ACTIVE",
    "accountType": "ADOBE_AUDITOR",
    "authToken": {
      "created": "string",
      "decryptedToken": "string",
      "token": "string",
      "tokenType": {},
      "userId": "string"
    },
    "capabilities": {
      "customProxySupport": true,
      "strongPasswordPolicy": true,
      "vpnSupport": true
    },
    "credsExpired": true,
    "email": "string",
    "features": [
      {}
    ],
    "id": 0,
    "isAccountActive": true,
    "isAccountAdmin": true,
    "isLongTermToken": true,
    "isOpAdmin": true,
    "isOpSysAdmin": true,
    "isReadOnly": true,
    "isUser": true,
    "isUserToken": true,
    "isVisitor": true,
    "loginAsRequestedByUserId": 0,
    "permissions": {
      "intValue": 0,
      "stringValue": "string"
    },
    "snowflakeUsage": {
      "useForAdobeAuditor": true,
      "useForAppJourneyRuleResults": true,
      "useForAppJourneys": true,
      "useForAudits": true,
      "useForLiveConnect": true,
      "useForLiveConnectRuleResults": true,
      "useForWebJourneyRuleResults": true,
      "useForWebJourneys": true,
      "used": true
    },
    "timezone": {
      "fixed": true,
      "id": "string"
    },
    "tokenType": {}
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
checkTimesinteger(int32)required
createdAtstring(date-time)required
createdByinteger(int32)required
fromTemplatebooleanrequired
idinteger(int32)required
isDefaultRulebooleanrequired
labelsArray of objects
matchAllFiltersbooleanrequired
namestringrequired
pageFiltersArray of objects
recipientsArray of strings
tagsArray of objects
updatedAtstring(date-time)required
Response
application/json
{
  "accountId": 0,
  "checkTimes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "fromTemplate": true,
  "id": 0,
  "isDefaultRule": true,
  "labels": [
    { … }
  ],
  "matchAllFilters": true,
  "name": "string",
  "pageFilters": [
    { … }
  ],
  "recipients": [
    "string"
  ],
  "tags": [
    { … }
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get original rule tag variable id by given rule tag variable snapshot id

Request

GET /v2/rules/snapshots/tags/variables/{tagVariableSnapshotId}/original
Security
API_Key
Path
tagVariableSnapshotIdinteger(int64)required
Bodyapplication/json
accountIdinteger(int32)required
accountStatusstringrequired
Enum"ACTIVE""ACTIVE_BILLING_PROBLEM""INACTIVE_BILLING_FAILED""INACTIVE_USER_CANCELLED""INACTIVE""DEMO"
accountTypestringrequired
Enum"ADOBE_AUDITOR""FREE""CONTRACT""CPM_PARTNER""SAMPLE""INTERNAL""CONTRACT_SELF_SERVICE"
authTokenobject
capabilitiesobjectrequired
capabilities.​customProxySupportbooleanrequired
capabilities.​strongPasswordPolicybooleanrequired
capabilities.​vpnSupportbooleanrequired
credsExpiredbooleanrequired
emailstringrequired
featuresArray of objectsrequired
idinteger(int32)required
isAccountActivebooleanrequired
isAccountAdminbooleanrequired
isLongTermTokenbooleanrequired
isOpAdminbooleanrequired
isOpSysAdminbooleanrequired
isReadOnlybooleanrequired
isUserbooleanrequired
isUserTokenbooleanrequired
isVisitorbooleanrequired
loginAsRequestedByUserIdnumber
permissionsobjectrequired
permissions.​intValueinteger(int32)required
permissions.​stringValuestringrequired
snowflakeUsageobjectrequired
snowflakeUsage.​useForAdobeAuditorbooleanrequired
snowflakeUsage.​useForAppJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForAppJourneysbooleanrequired
snowflakeUsage.​useForAuditsbooleanrequired
snowflakeUsage.​useForLiveConnectbooleanrequired
snowflakeUsage.​useForLiveConnectRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneysbooleanrequired
snowflakeUsage.​usedbooleanrequired
timezoneobjectrequired
timezone.​fixedbooleanrequired
timezone.​idstringrequired
tokenTypeobjectrequired
curl -i -X GET \
  'https://api.observepoint.com/v2/rules/snapshots/tags/variables/{tagVariableSnapshotId}/original' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": 0,
    "accountStatus": "ACTIVE",
    "accountType": "ADOBE_AUDITOR",
    "authToken": {
      "created": "string",
      "decryptedToken": "string",
      "token": "string",
      "tokenType": {},
      "userId": "string"
    },
    "capabilities": {
      "customProxySupport": true,
      "strongPasswordPolicy": true,
      "vpnSupport": true
    },
    "credsExpired": true,
    "email": "string",
    "features": [
      {}
    ],
    "id": 0,
    "isAccountActive": true,
    "isAccountAdmin": true,
    "isLongTermToken": true,
    "isOpAdmin": true,
    "isOpSysAdmin": true,
    "isReadOnly": true,
    "isUser": true,
    "isUserToken": true,
    "isVisitor": true,
    "loginAsRequestedByUserId": 0,
    "permissions": {
      "intValue": 0,
      "stringValue": "string"
    },
    "snowflakeUsage": {
      "useForAdobeAuditor": true,
      "useForAppJourneyRuleResults": true,
      "useForAppJourneys": true,
      "useForAudits": true,
      "useForLiveConnect": true,
      "useForLiveConnectRuleResults": true,
      "useForWebJourneyRuleResults": true,
      "useForWebJourneys": true,
      "used": true
    },
    "timezone": {
      "fixed": true,
      "id": "string"
    },
    "tokenType": {}
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
checkTimesinteger(int32)required
createdAtstring(date-time)required
createdByinteger(int32)required
fromTemplatebooleanrequired
idinteger(int32)required
isDefaultRulebooleanrequired
labelsArray of objects
matchAllFiltersbooleanrequired
namestringrequired
pageFiltersArray of objects
recipientsArray of strings
tagsArray of objects
updatedAtstring(date-time)required
Response
application/json
{
  "accountId": 0,
  "checkTimes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "fromTemplate": true,
  "id": 0,
  "isDefaultRule": true,
  "labels": [
    { … }
  ],
  "matchAllFilters": true,
  "name": "string",
  "pageFilters": [
    { … }
  ],
  "recipients": [
    "string"
  ],
  "tags": [
    { … }
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get original rule tag id by given rule tag snapshot id

Request

GET /v2/rules/snapshots/tags/{tagSnapshotId}/original
Security
API_Key
Path
tagSnapshotIdinteger(int32)required
Bodyapplication/json
accountIdinteger(int32)required
accountStatusstringrequired
Enum"ACTIVE""ACTIVE_BILLING_PROBLEM""INACTIVE_BILLING_FAILED""INACTIVE_USER_CANCELLED""INACTIVE""DEMO"
accountTypestringrequired
Enum"ADOBE_AUDITOR""FREE""CONTRACT""CPM_PARTNER""SAMPLE""INTERNAL""CONTRACT_SELF_SERVICE"
authTokenobject
capabilitiesobjectrequired
capabilities.​customProxySupportbooleanrequired
capabilities.​strongPasswordPolicybooleanrequired
capabilities.​vpnSupportbooleanrequired
credsExpiredbooleanrequired
emailstringrequired
featuresArray of objectsrequired
idinteger(int32)required
isAccountActivebooleanrequired
isAccountAdminbooleanrequired
isLongTermTokenbooleanrequired
isOpAdminbooleanrequired
isOpSysAdminbooleanrequired
isReadOnlybooleanrequired
isUserbooleanrequired
isUserTokenbooleanrequired
isVisitorbooleanrequired
loginAsRequestedByUserIdnumber
permissionsobjectrequired
permissions.​intValueinteger(int32)required
permissions.​stringValuestringrequired
snowflakeUsageobjectrequired
snowflakeUsage.​useForAdobeAuditorbooleanrequired
snowflakeUsage.​useForAppJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForAppJourneysbooleanrequired
snowflakeUsage.​useForAuditsbooleanrequired
snowflakeUsage.​useForLiveConnectbooleanrequired
snowflakeUsage.​useForLiveConnectRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneysbooleanrequired
snowflakeUsage.​usedbooleanrequired
timezoneobjectrequired
timezone.​fixedbooleanrequired
timezone.​idstringrequired
tokenTypeobjectrequired
curl -i -X GET \
  'https://api.observepoint.com/v2/rules/snapshots/tags/{tagSnapshotId}/original' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": 0,
    "accountStatus": "ACTIVE",
    "accountType": "ADOBE_AUDITOR",
    "authToken": {
      "created": "string",
      "decryptedToken": "string",
      "token": "string",
      "tokenType": {},
      "userId": "string"
    },
    "capabilities": {
      "customProxySupport": true,
      "strongPasswordPolicy": true,
      "vpnSupport": true
    },
    "credsExpired": true,
    "email": "string",
    "features": [
      {}
    ],
    "id": 0,
    "isAccountActive": true,
    "isAccountAdmin": true,
    "isLongTermToken": true,
    "isOpAdmin": true,
    "isOpSysAdmin": true,
    "isReadOnly": true,
    "isUser": true,
    "isUserToken": true,
    "isVisitor": true,
    "loginAsRequestedByUserId": 0,
    "permissions": {
      "intValue": 0,
      "stringValue": "string"
    },
    "snowflakeUsage": {
      "useForAdobeAuditor": true,
      "useForAppJourneyRuleResults": true,
      "useForAppJourneys": true,
      "useForAudits": true,
      "useForLiveConnect": true,
      "useForLiveConnectRuleResults": true,
      "useForWebJourneyRuleResults": true,
      "useForWebJourneys": true,
      "used": true
    },
    "timezone": {
      "fixed": true,
      "id": "string"
    },
    "tokenType": {}
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
checkTimesinteger(int32)required
createdAtstring(date-time)required
createdByinteger(int32)required
fromTemplatebooleanrequired
idinteger(int32)required
isDefaultRulebooleanrequired
labelsArray of objects
matchAllFiltersbooleanrequired
namestringrequired
pageFiltersArray of objects
recipientsArray of strings
tagsArray of objects
updatedAtstring(date-time)required
Response
application/json
{
  "accountId": 0,
  "checkTimes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "fromTemplate": true,
  "id": 0,
  "isDefaultRule": true,
  "labels": [
    { … }
  ],
  "matchAllFilters": true,
  "name": "string",
  "pageFilters": [
    { … }
  ],
  "recipients": [
    "string"
  ],
  "tags": [
    { … }
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get original rule id by given rule snapshot id

Request

GET /v2/rules/snapshots/{ruleSnapshotId}/original
Security
API_Key
Path
ruleSnapshotIdinteger(int32)required
Bodyapplication/json
accountIdinteger(int32)required
accountStatusstringrequired
Enum"ACTIVE""ACTIVE_BILLING_PROBLEM""INACTIVE_BILLING_FAILED""INACTIVE_USER_CANCELLED""INACTIVE""DEMO"
accountTypestringrequired
Enum"ADOBE_AUDITOR""FREE""CONTRACT""CPM_PARTNER""SAMPLE""INTERNAL""CONTRACT_SELF_SERVICE"
authTokenobject
capabilitiesobjectrequired
capabilities.​customProxySupportbooleanrequired
capabilities.​strongPasswordPolicybooleanrequired
capabilities.​vpnSupportbooleanrequired
credsExpiredbooleanrequired
emailstringrequired
featuresArray of objectsrequired
idinteger(int32)required
isAccountActivebooleanrequired
isAccountAdminbooleanrequired
isLongTermTokenbooleanrequired
isOpAdminbooleanrequired
isOpSysAdminbooleanrequired
isReadOnlybooleanrequired
isUserbooleanrequired
isUserTokenbooleanrequired
isVisitorbooleanrequired
loginAsRequestedByUserIdnumber
permissionsobjectrequired
permissions.​intValueinteger(int32)required
permissions.​stringValuestringrequired
snowflakeUsageobjectrequired
snowflakeUsage.​useForAdobeAuditorbooleanrequired
snowflakeUsage.​useForAppJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForAppJourneysbooleanrequired
snowflakeUsage.​useForAuditsbooleanrequired
snowflakeUsage.​useForLiveConnectbooleanrequired
snowflakeUsage.​useForLiveConnectRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneysbooleanrequired
snowflakeUsage.​usedbooleanrequired
timezoneobjectrequired
timezone.​fixedbooleanrequired
timezone.​idstringrequired
tokenTypeobjectrequired
curl -i -X GET \
  'https://api.observepoint.com/v2/rules/snapshots/{ruleSnapshotId}/original' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": 0,
    "accountStatus": "ACTIVE",
    "accountType": "ADOBE_AUDITOR",
    "authToken": {
      "created": "string",
      "decryptedToken": "string",
      "token": "string",
      "tokenType": {},
      "userId": "string"
    },
    "capabilities": {
      "customProxySupport": true,
      "strongPasswordPolicy": true,
      "vpnSupport": true
    },
    "credsExpired": true,
    "email": "string",
    "features": [
      {}
    ],
    "id": 0,
    "isAccountActive": true,
    "isAccountAdmin": true,
    "isLongTermToken": true,
    "isOpAdmin": true,
    "isOpSysAdmin": true,
    "isReadOnly": true,
    "isUser": true,
    "isUserToken": true,
    "isVisitor": true,
    "loginAsRequestedByUserId": 0,
    "permissions": {
      "intValue": 0,
      "stringValue": "string"
    },
    "snowflakeUsage": {
      "useForAdobeAuditor": true,
      "useForAppJourneyRuleResults": true,
      "useForAppJourneys": true,
      "useForAudits": true,
      "useForLiveConnect": true,
      "useForLiveConnectRuleResults": true,
      "useForWebJourneyRuleResults": true,
      "useForWebJourneys": true,
      "used": true
    },
    "timezone": {
      "fixed": true,
      "id": "string"
    },
    "tokenType": {}
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
checkTimesinteger(int32)required
createdAtstring(date-time)required
createdByinteger(int32)required
fromTemplatebooleanrequired
idinteger(int32)required
isDefaultRulebooleanrequired
labelsArray of objects
matchAllFiltersbooleanrequired
namestringrequired
pageFiltersArray of objects
recipientsArray of strings
tagsArray of objects
updatedAtstring(date-time)required
Response
application/json
{
  "accountId": 0,
  "checkTimes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "fromTemplate": true,
  "id": 0,
  "isDefaultRule": true,
  "labels": [
    { … }
  ],
  "matchAllFilters": true,
  "name": "string",
  "pageFilters": [
    { … }
  ],
  "recipients": [
    "string"
  ],
  "tags": [
    { … }
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get rule by given id

Request

GET /v2/rules/{ruleId}
Security
API_Key
Path
ruleIdinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/rules/{ruleId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
checkTimesinteger(int32)required
createdAtstring(date-time)required
createdByinteger(int32)required
fromTemplatebooleanrequired
idinteger(int32)required
isDefaultRulebooleanrequired
labelsArray of objects
matchAllFiltersbooleanrequired
namestringrequired
pageFiltersArray of objects
recipientsArray of strings
tagsArray of objects
updatedAtstring(date-time)required
Response
application/json
{
  "accountId": 0,
  "checkTimes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "fromTemplate": true,
  "id": 0,
  "isDefaultRule": true,
  "labels": [
    { … }
  ],
  "matchAllFilters": true,
  "name": "string",
  "pageFilters": [
    { … }
  ],
  "recipients": [
    "string"
  ],
  "tags": [
    { … }
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Update rule with given id

Request

PUT /v2/rules/{ruleId}
Security
API_Key
Path
ruleIdinteger(int32)required
Bodyapplication/jsonrequired

Rule update information

checkTimesinteger(int32)required
idinteger(int32)
isDefaultRulenumber
labelsArray of objects
matchAllFiltersbooleanrequired
namestringrequired
pageFiltersArray of objects
recipientsArray of strings
tagsArray of objects
curl -i -X PUT \
  'https://api.observepoint.com/v2/rules/{ruleId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "checkTimes": 0,
    "id": 0,
    "isDefaultRule": 0,
    "labels": [
      {
        "id": 0
      }
    ],
    "matchAllFilters": true,
    "name": "string",
    "pageFilters": [
      {
        "id": 0,
        "matchType": "Equals",
        "ruleId": 0,
        "type": 1,
        "value": "string"
      }
    ],
    "recipients": [
      "string"
    ],
    "tags": [
      {
        "account": "string",
        "clause": "If",
        "id": 0,
        "matchType": "Equals",
        "ruleId": 0,
        "statusCode": {
          "matchType": "Equals",
          "value": 0,
          "valueType": "Specific"
        },
        "tagId": 0,
        "validationDescription": "string",
        "variables": [
          {
            "id": 0,
            "matchType": "Equals",
            "ruleTagId": 0,
            "selectorType": "String",
            "validationDescription": "string",
            "value": "string",
            "valueTagId": 0,
            "variable": "string"
          }
        ]
      }
    ]
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
checkTimesinteger(int32)required
createdAtstring(date-time)required
createdByinteger(int32)required
fromTemplatebooleanrequired
idinteger(int32)required
isDefaultRulebooleanrequired
labelsArray of objects
matchAllFiltersbooleanrequired
namestringrequired
pageFiltersArray of objects
recipientsArray of strings
tagsArray of objects
updatedAtstring(date-time)required
Response
application/json
{
  "accountId": 0,
  "checkTimes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "fromTemplate": true,
  "id": 0,
  "isDefaultRule": true,
  "labels": [
    { … }
  ],
  "matchAllFilters": true,
  "name": "string",
  "pageFilters": [
    { … }
  ],
  "recipients": [
    "string"
  ],
  "tags": [
    { … }
  ],
  "updatedAt": "2019-08-24T14:15:22Z"
}

Delete rule with given id

Request

DELETE /v2/rules/{ruleId}
Security
API_Key
Path
ruleIdinteger(int32)required
curl -i -X DELETE \
  'https://api.observepoint.com/v2/rules/{ruleId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Rule was successfully deleted

Get all web journeys with given rule id

Request

GET /v2/rules/{ruleId}/web-journeys
Security
API_Key
Path
ruleIdinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/rules/{ruleId}/web-journeys' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
actionsArray of objectsrequired
actions[].​actionstring
Enum"navto""click""input""select""check""uncheck""execute""watch""maskedInput""enterIframe"
actions[].​actionIdnumber
actions[].​jsstring
actions[].​labelstring
actions[].​maskedValuestring
actions[].​preventNavbooleanrequired
actions[].​rulesArray of numbers
actions[].​secondsinteger(int32)
actions[].​selectorsArray of objectsrequired
actions[].​selectors[].​selectorTypeinteger(int32)required
Discriminator
actions[].​selectors[].​valueobjectrequired
actions[].​selectors[].​value.​attributesArray of objectsrequired
actions[].​selectors[].​value.​attributes[].​namestringrequired
actions[].​selectors[].​value.​attributes[].​valuestring
actions[].​selectors[].​value.​innerHTMLstring
actions[].​selectors[].​value.​tagNamestring
actions[].​sequenceinteger(int32)required
actions[].​urlstring
actions[].​valuestring
actions[].​waitDurationinteger(int32)[ 0 .. 1800 ]
createdAtstring(date-time)
domainIdinteger(int64)required
emailsArray of stringsrequired
folderIdinteger(int64)required
idinteger(int64)required
lastCheckstring(date-time)
namestringrequired
nextCheckstring(date-time)
optionsobjectrequired
options.​alertsbooleanrequired
options.​browserWidthinteger(int32)required
options.​customProxystring
options.​flashLiveVideoEnabledboolean
options.​frequencystring
options.​loadFlashbooleanrequired
options.​locationstringrequired
options.​monitoredByScriptServicesnumber
options.​nextRunstring(date-time)
options.​remoteFileMapConfigArray of objects
options.​userAgentstringrequired
options.​userAgentDescriptionstring
options.​vpnEnabledboolean
options.​webHookUrlstring
queuedbooleanrequired
screenshotstring
statusstring
Enum"Ok""Failed""NotChecked""RulesFailed""ActionFailed""PageFailed"
userIdinteger(int64)required
webJourneyRunningboolean
]
Response
application/json
[
  {
    "actions": [ … ],
    "createdAt": "2019-08-24T14:15:22Z",
    "domainId": 0,
    "emails": [ … ],
    "folderId": 0,
    "id": 0,
    "lastCheck": "2019-08-24T14:15:22Z",
    "name": "string",
    "nextCheck": "2019-08-24T14:15:22Z",
    "options": { … },
    "queued": true,
    "screenshot": "string",
    "status": "Ok",
    "userId": 0,
    "webJourneyRunning": true
  }
]

Audits

Endpoints for managing audits including creation, configuration, execution, and retrieving audit results and runs

Operations

Sub-Folders

Endpoints for managing sub-folders including creation, configuration, and sub-folder-based audit and journey management

Operations

Manual Journeys

Endpoints for managing manual journeys including real device testing, HAR file ingestion, and journey execution control. These endpoints power Live Connect and HAR Analyzer features in the ObservePoint UI, enabling users to perform manual testing on real devices and analyze HAR files for tag validation and troubleshooting.

For more information, see the HAR File Processing API Recipe.

Operations

Account

Endpoints for managing account settings, configurations, and account-level information

Operations

Users

Endpoints for managing users including creation, authentication, permissions, and user account management

Operations

Labels

Endpoints for managing labels including creation, assignment, and retrieval for organizing audits, journeys, and other resources

Operations

Folders

Endpoints for managing folders including creation, organization, access control, and folder-based resource management

Operations