Skip to content
v3 API/
/
Get request initiators in...

Get request initiators info for a given page

Request

POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators

Get request initiators info for specified audit run page

Security
API_Key
Path
auditIdinteger, (int64)required

Unique identification number for web audit

Example:107239
runIdinteger, (int64)required

Unique identification number for web audit or journey run

Example:33010
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example:f9d32cc7cc2046d6decb145a80289287f5226323
Bodyapplication/json
tagsOnlyboolean

If set then return only tags, else ignored

primaryTagsOnlyboolean

If set then return only primary tags, else ignored

tagIdinteger

Tag ID

tagAccountstring

Tag account

tagVendorIdinteger

Tag vendor ID

tagCategoryIdinteger

Tag category ID

withCookiesOnlyboolean

If set then return only requests that specified cookies, else ignored

cookieNameobject
cookieDomainobject
partyTypestring

Indicates if cookie domain is different from domain of a page it was set on. owned_3rd_party is deprecated

Enum:"1st_party""owned_3rd_party""3rd_party"
requestUrlobject
requestStatusCodestringdeprecated

good - 2xx, redirects - 3xx, broken - all others

Enum:"good""redirects""broken"
POST
/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/initiators \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tagsOnly": true,
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagAccount": "string",
    "tagVendorId": 0,
    "tagCategoryId": 0,
    "withCookiesOnly": true,
    "cookieName": {
      "filterType": "contains",
      "filterValue": "string"
    },
    "cookieDomain": {
      "filterType": "contains",
      "filterValue": "string"
    },
    "partyType": "1st_party",
    "requestUrl": {
      "filterType": "contains",
      "filterValue": "string"
    },
    "requestStatusCode": "good"
  }'

Responses

OK

Bodyapplication/json
initiatorsSummaryobjectrequired
initiatorsTreeRootobjectrequired

Represents a node in the initiators tree. Each node/vertex is a network request. The root node is the page request. The root node does not have relationToParent Leaf nodes are requests that have no children. To get information about specific nodes use POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/request-log endpoint with harEntryIndices specified

Response
{
  "initiatorsSummary": {
    "totalNetworkRequestCount": 1,
    "filteredNetworkRequestCount": 0,
    "totalBrokenNetworkRequestCount": 0,
    "filteredBrokenNetworkRequestCount": 0,
    "totalTagCount": 0,
    "filteredTagCount": 0,
    "totalCookieCount": 0,
    "filteredCookieCount": 0
  },
  "initiatorsTreeRoot": {
    "harEntryIndex": 0,
    "relationToParent": "normal",
    "children": [ … ],
    "originalSubtreeSize": 0,
    "filteredSubtreeSize": 0,
    "matchesFilter": true
  }
}