Skip to content
v3 API/
/
Return network requests f...

V3 API

This section documents the V3 API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, configure scans and privacy settings, and analyze web performance metrics from your ObservePoint scans.

Download OpenAPI description
combined.openapi.json
combined.openapi.yaml
Overview
URL
https://www.observepoint.com/contact-us
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/

Alert Summary Report

Alert Summary report endpoints

Operations

Audit Summary Report

Audit Summary report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

Operations

Page Details Report

Detailed information about specific pages including tags, cookies, request logs, and console logs

Operations

Return page cookie information

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies

Get cookies from specified audit run on a given page, getting summary insight is optional

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
Query
getInsightsboolean
Example: getInsights=true
getOriginsboolean

If true then origin story will be returned for each cookie

Example: getOrigins=true
hidePreAuditActionOnlyCookiesboolean

If true then cookies which were only changed during pre-audit actions will be hidden

Default false
Example: hidePreAuditActionOnlyCookies=true
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/cookies?getInsights=true&getOrigins=true&hidePreAuditActionOnlyCookies=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK, return cookies found on a page

Bodyapplication/json
insightsobjectrequired
insights.​noOfUniqueCookiesintegerrequired
insights.​noOfUniqueDomainsintegerrequired
insights.​noOf3rdPartyCookiesintegerrequired
cookiesArray of objectsrequired
cookies[].​namestring
cookies[].​valuestring
cookies[].​domainstring
cookies[].​pathstring
cookies[].​httpOnlyboolean
cookies[].​secureboolean
cookies[].​samesitestring
cookies[].​expiresstring
cookies[].​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"
cookies[].​originobject
cookies[].​initiatorsArray of objects
cookies[].​partitionKeystring
cookies[].​ttlInMinutesinteger(int64)
cookies[].​uniqueInitiatorCountinteger
cookies[].​changesArray of objects
Response
application/json
{
  "insights": {
    "noOfUniqueCookies": 0,
    "noOfUniqueDomains": 0,
    "noOf3rdPartyCookies": 0
  },
  "cookies": [
    { … }
  ]
}

Return network requests fired on a given page

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/request-log

Get request logs from specified audit run on a given 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
Query
pageinteger>= 0

Page number, starts with 0

Default 0
sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"request_start_time""request_url""tag_name""mime_type""response_size""load_time""status_code""geo""date_difference""size_difference"
sortDescboolean

Controls sorting order

Default false
searchstring

Filters results by a search string

showPreAuditActionRequestsboolean

Filters results by cookie origin type

Default false
showFileChangesboolean

For privacy customers, when file changes are requested, we show the changes of the files between previous run and current run.

Default false
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/request-log?page=0&size=50&sortBy=request_start_time&sortDesc=false&search=string&showPreAuditActionRequests=false&showFileChanges=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK, return a list of network requests send

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

requestsArray of objectsrequired
requests[].​harEntryIndexinteger>= 0required

The 0-based index of the HAR entry that this request corresponds to. Used to uniquely identify a request on a page.

requests[].​resourceTypestring

The type of resource that was requested. e.g. 'xhr', 'script', 'image', 'stylesheet', 'font', 'document', 'other'. Available since WORK-24937

requests[].​methodstring

The HTTP method used for the request

requests[].​serverIPAddressstring(ipAddress)

The IP address of the server that responded to the request

requests[].​httpVersionstring

The HTTP version used for the request (e.g. 'HTTP/1.1')

requests[].​requestUrlstringrequired
requests[].​statusCodeintegerrequired

HTTP status code of network request

requests[].​loadTimenumberrequired

Time took for network request to execute, in milliseconds

requests[].​geoLocationInfoobject
requests[].​mimeTypestring
requests[].​fileInfoobject
requests[].​responseSizeBytesinteger
requests[].​startedAtstring(date-time)

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
requests[].​startedAtRelativeToPageNavigationinteger(int64)
requests[].​tagobject
requests[].​fileChangeobject

Available only for JavaScript files for now. Provided only for customers that have Privacy features available.

requests[].​originstring or null
Enum"PRE_AUDIT_ACTION""ON_PAGE"
requests[].​relatedCookiesArray of objects
requests[].​geoLocationstringDeprecated

Use geoLocationInfo property instead. It will be renamed to geoLocation soon

requests[].​tagIdintegerDeprecated

Use tag property instead

Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "requests": [
    { … }
  ]
}

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"
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
initiatorsSummary.​totalNetworkRequestCountinteger>= 1required
initiatorsSummary.​filteredNetworkRequestCountinteger>= 0required
initiatorsSummary.​totalBrokenNetworkRequestCountinteger>= 0required
initiatorsSummary.​filteredBrokenNetworkRequestCountinteger>= 0required
initiatorsSummary.​totalTagCountinteger>= 0required
initiatorsSummary.​filteredTagCountinteger>= 0required
initiatorsSummary.​totalCookieCountinteger>= 0required
initiatorsSummary.​filteredCookieCountinteger>= 0required
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

initiatorsTreeRoot.​harEntryIndexinteger>= 0required

The 0-based index of the HAR entry that this request corresponds to. Used to uniquely identify a request on a page.

initiatorsTreeRoot.​relationToParentstring

Default value is normal, may be omitted. The root node does not have relation.

Enum"normal""weak"
initiatorsTreeRoot.​childrenArray of objects>= 0 itemsrequired

When filters applied, only the following nodes are retained in the children array:

  • leaf nodes matching filters,
  • intermediate nodes matching filters,
  • intermediate nodes not matching filters but having successors matching filters.
initiatorsTreeRoot.​originalSubtreeSizeintegerrequired

Total number of nodes under the current node (including its children, grand-children and so on)

initiatorsTreeRoot.​filteredSubtreeSizeintegerrequired

Number of nodes under the current node (including its children, grand-children and so on) after filtering

Response
application/json
{
  "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
  }
}

Page Summary Report

Page Summary report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Audit Run Data

Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs

Operations

Account Usage Export

Export account usage data

Operations

Alert Export

Export alert data

Operations

Audit Run Export

Export audit run data

Operations

Exports Center

Access requested exports status/information

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Web Journey Run Export

Export web journey run data

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Alerts

Alert management and configuration

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations

Account Usage

Account usage data

Operations

Email Inbox Configuration

APIs for managing email inbox configurations and setting

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inboxes

APIs for getting email messages and results from email inboxes

Operations

Action Set Action Rules

APIs for managing Action Set Action Rules

Operations

Action Set Actions

APIs for managing Action Set Actions

Operations

Action Sets

APIs for managing Action Sets

Operations

Audit Actions

APIs for managing audit actions

Operations

Audit Blocking Config

APIs for managing audit request blocking configuration

Operations

Audit Login Actions

APIs for managing audit login actions

Operations

Audits Management

APIs for managing audits

Operations

Custom Headers

APIs for managing custom HTTP header groups

Operations

Data Sources

APIs for managing Data Sources

Operations

Geo Locations

APIs for geo locations

Operations

Notification Center

Find and manage email subscriptions

Operations

Remote File Mappings

APIs for managing Remote File Mappings

Operations

Rules

APIs for managing rules

Operations

Schedules

APIs for item schedules and calendars

Operations

Site Censuses

APIs for managing Site Census

Operations

User Events

APIs for managing User Events

Operations

Web Journey Blocking Config

APIs for managing web journey request blocking configuration

Operations

Web Journey Custom Headers

APIs for managing web journey custom headers

Operations

Web Journeys Management

APIs for managing Web Journeys

Operations