Skip to content
v2 API/
/
Get web audit

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

Audits

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

Operations

Delete web audit labels

Request

DELETE /v2/web-audits/{auditId}/labels
Security
API_Key
Path
auditIdinteger(int32)required
Bodyapplication/json
integer(int32)
curl -i -X DELETE \
  'https://api.observepoint.com/v2/web-audits/{auditId}/labels' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json'

Responses

successful operation

Bodyapplication/json
object
Response
application/json
{}

Get web audit

Request

GET /v2/web-audits/{webAuditId}
Security
API_Key
Path
webAuditIdinteger(int32)required
Query
withRunsboolean
runsLimitstring
curl -i -X GET \
  'https://api.observepoint.com/v2/web-audits/{webAuditId}?withRuns=true&runsLimit=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
createdstring(date-time)required
domainIdinteger(int32)required
filtersobject
folderIdinteger(int32)required
frequencystring
idinteger(int32)required
labelsArray of objectsrequired
labels[].​idinteger(int32)required
labels[].​namestringrequired
lastRunstring(date-time)
lastUpdatedstring(date-time)required
limitinteger(int32)required
namestringrequired
nextRunstring(date-time)
optionsobject
ownerIdinteger(int32)required
queuedbooleanrequired
recipientsArray of stringsrequired
rulesArray of objects
runsArray of objectsrequired
runs[].​adobeAuditorbooleanrequired
runs[].​completedstring(date-time)
runs[].​idinteger(int32)required
runs[].​limitinteger(int32)required
runs[].​scoreinteger(int32)

Deprecated. Use /v3/web-audits/{auditId}/runs/{runId}/scores instead

runs[].​silentModebooleanrequired
runs[].​startedstring(date-time)
runs[].​supportedFeaturesArray of strings
Example: "[TagLoadtimeReport, ConsoleLogsReport]"
runs[].​taggedUrlinteger(int32)required
runs[].​totalUrlinteger(int32)required
runs[].​userIdinteger(int32)required
runs[].​webAuditIdinteger(int32)required
scheduleboolean
screenshotstring
startingUrlsArray of stringsrequired
taggingPlansArray of numbers
webAuditRunningnumber
Response
application/json
{
  "created": "2019-08-24T14:15:22Z",
  "domainId": 0,
  "filters": {
    "exclude": [ … ],
    "include": [ … ]
  },
  "folderId": 0,
  "frequency": "string",
  "id": 0,
  "labels": [
    { … }
  ],
  "lastRun": "2019-08-24T14:15:22Z",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "limit": 0,
  "name": "string",
  "nextRun": "2019-08-24T14:15:22Z",
  "options": {
    "adobeAuditor": true,
    "blockThirdPartyCookies": true,
    "browserHeight": 0,
    "browserWidth": 0,
    "customHttpHeaders": [ … ],
    "customProxy": "string",
    "discoverSitemap": true,
    "fireTags": true,
    "gpcEnabled": true,
    "loadFlash": true,
    "location": "string",
    "remoteFileMapConfig": [ … ],
    "requestRate": 0,
    "sameUrlRunId": 0,
    "stripQueryString": true,
    "userAgent": "string",
    "vpnEnabled": true,
    "webHookUrl": "string"
  },
  "ownerId": 0,
  "queued": true,
  "recipients": [
    "string"
  ],
  "rules": [
    { … }
  ],
  "runs": [
    { … }
  ],
  "schedule": true,
  "screenshot": "string",
  "startingUrls": [
    "string"
  ],
  "taggingPlans": [
    0
  ],
  "webAuditRunning": 0
}

Update web audit

Request

PUT /v2/web-audits/{webAuditId}
Security
API_Key
Path
webAuditIdinteger(int32)required
Bodyapplication/json

Update web audit info

domainIdinteger(int32)required
filtersobject
frequencystring
idinteger(int32)required
limitinteger(int32)required
namestringrequired
nextRunstring(date-time)
optionsobject
ownerIdinteger(int32)
recipientsArray of stringsrequired
scheduleobject
startingUrlsArray of stringsrequired
curl -i -X PUT \
  'https://api.observepoint.com/v2/web-audits/{webAuditId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "domainId": 0,
    "filters": {
      "exclude": [
        "string"
      ],
      "include": [
        {
          "includeLimit": 0,
          "value": "string"
        }
      ]
    },
    "frequency": "string",
    "id": 0,
    "limit": 0,
    "name": "string",
    "nextRun": "2019-08-24T14:15:22Z",
    "options": {
      "adobeAuditor": true,
      "blockThirdPartyCookies": true,
      "browserHeight": 0,
      "browserWidth": 0,
      "customHttpHeaders": [
        {
          "groupId": 0,
          "isApplyToAll": true
        }
      ],
      "customProxy": "string",
      "discoverSitemap": true,
      "fireTags": true,
      "gpcEnabled": true,
      "loadFlash": true,
      "location": "string",
      "remoteFileMapConfig": [
        {
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": 0,
          "fileId": 0,
          "fileUrl": "string",
          "id": 0,
          "matchType": "[equals",
          "matchValue": "string",
          "name": "string",
          "updatedAt": "2019-08-24T14:15:22Z",
          "updatedBy": 0
        }
      ],
      "requestRate": 0,
      "sameUrlRunId": 0,
      "stripQueryString": true,
      "userAgent": "string",
      "vpnEnabled": true,
      "webHookUrl": "string"
    },
    "ownerId": 0,
    "recipients": [
      "string"
    ],
    "schedule": {
      "dtStart": {
        "centuryOfEra": 0,
        "chronology": {
          "zone": {
            "fixed": true,
            "id": "string"
          }
        },
        "dayOfMonth": 0,
        "dayOfWeek": 0,
        "dayOfYear": 0,
        "era": 0,
        "fieldTypes": [
          {
            "durationType": {
              "name": "string"
            },
            "name": "string",
            "rangeDurationType": {
              "name": "string"
            }
          }
        ],
        "fields": [
          {
            "durationField": {
              "name": "string",
              "precise": true,
              "supported": true,
              "type": {
                "name": "string"
              },
              "unitMillis": 0
            },
            "leapDurationField": {
              "name": "string",
              "precise": true,
              "supported": true,
              "type": {
                "name": "string"
              },
              "unitMillis": 0
            },
            "lenient": true,
            "maximumValue": 0,
            "minimumValue": 0,
            "name": "string",
            "rangeDurationField": {
              "name": "string",
              "precise": true,
              "supported": true,
              "type": {
                "name": "string"
              },
              "unitMillis": 0
            },
            "supported": true,
            "type": {
              "durationType": {
                "name": "string"
              },
              "name": "string",
              "rangeDurationType": {
                "name": "string"
              }
            }
          }
        ],
        "hourOfDay": 0,
        "millisOfDay": 0,
        "millisOfSecond": 0,
        "minuteOfHour": 0,
        "monthOfYear": 0,
        "secondOfMinute": 0,
        "values": [
          0
        ],
        "weekOfWeekyear": 0,
        "weekyear": 0,
        "year": 0,
        "yearOfCentury": 0,
        "yearOfEra": 0
      },
      "id": 0,
      "isPaused": true,
      "recurrenceRule": "string",
      "tzId": "string"
    },
    "startingUrls": [
      "string"
    ]
  }'

Responses

successful operation

Bodyapplication/json
createdstring(date-time)required
domainIdinteger(int32)required
filtersobject
folderIdinteger(int32)required
frequencystring
idinteger(int32)required
labelsArray of objectsrequired
labels[].​idinteger(int32)required
labels[].​namestringrequired
lastRunstring(date-time)
lastUpdatedstring(date-time)required
limitinteger(int32)required
namestringrequired
nextRunstring(date-time)
optionsobject
ownerIdinteger(int32)required
queuedbooleanrequired
recipientsArray of stringsrequired
rulesArray of objects
runsArray of objectsrequired
runs[].​adobeAuditorbooleanrequired
runs[].​completedstring(date-time)
runs[].​idinteger(int32)required
runs[].​limitinteger(int32)required
runs[].​scoreinteger(int32)

Deprecated. Use /v3/web-audits/{auditId}/runs/{runId}/scores instead

runs[].​silentModebooleanrequired
runs[].​startedstring(date-time)
runs[].​supportedFeaturesArray of strings
Example: "[TagLoadtimeReport, ConsoleLogsReport]"
runs[].​taggedUrlinteger(int32)required
runs[].​totalUrlinteger(int32)required
runs[].​userIdinteger(int32)required
runs[].​webAuditIdinteger(int32)required
scheduleboolean
screenshotstring
startingUrlsArray of stringsrequired
taggingPlansArray of numbers
webAuditRunningnumber
Response
application/json
{
  "created": "2019-08-24T14:15:22Z",
  "domainId": 0,
  "filters": {
    "exclude": [ … ],
    "include": [ … ]
  },
  "folderId": 0,
  "frequency": "string",
  "id": 0,
  "labels": [
    { … }
  ],
  "lastRun": "2019-08-24T14:15:22Z",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "limit": 0,
  "name": "string",
  "nextRun": "2019-08-24T14:15:22Z",
  "options": {
    "adobeAuditor": true,
    "blockThirdPartyCookies": true,
    "browserHeight": 0,
    "browserWidth": 0,
    "customHttpHeaders": [ … ],
    "customProxy": "string",
    "discoverSitemap": true,
    "fireTags": true,
    "gpcEnabled": true,
    "loadFlash": true,
    "location": "string",
    "remoteFileMapConfig": [ … ],
    "requestRate": 0,
    "sameUrlRunId": 0,
    "stripQueryString": true,
    "userAgent": "string",
    "vpnEnabled": true,
    "webHookUrl": "string"
  },
  "ownerId": 0,
  "queued": true,
  "recipients": [
    "string"
  ],
  "rules": [
    { … }
  ],
  "runs": [
    { … }
  ],
  "schedule": true,
  "screenshot": "string",
  "startingUrls": [
    "string"
  ],
  "taggingPlans": [
    0
  ],
  "webAuditRunning": 0
}

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