Skip to content
v2 API/
/
Create new web audit

Create new web audit

Request

POST /v2/web-audits
Security
API_Key
Bodyapplication/jsonrequired

New web audit info

domainIdinteger, (int32)required
filtersobject
frequencystring
limitinteger, (int32)required
namestringrequired
nextRunstring, (date-time)
optionsobject
recipientsArray of stringsrequired
scheduleobject
startingUrlsArray of stringsrequired
POST
/web-audits
curl -i -X POST \
  https://api.observepoint.com/v2/web-audits \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "domainId": 0,
    "filters": {
      "exclude": [
        "string"
      ],
      "include": [
        {
          "includeLimit": 0,
          "value": "string"
        }
      ]
    },
    "frequency": "string",
    "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"
    },
    "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
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
scheduleboolean
screenshotstring
startingUrlsArray of stringsrequired
taggingPlansArray of numbers
webAuditRunningnumber
Response
{
  "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
}