# 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. ## Servers ObservePoint Production API ``` https://api.observepoint.com ``` ## Security ### API_Key Use the `Authorization` header in your requests with ObservePoint API key as header value. Example: `Authorization: abc123...def456` Type: apiKey In: header Name: Authorization ## Download OpenAPI description [V3 API](https://api-docs.observepoint.com/_bundle/openapi/combined.openapi.yaml) ## Alert Summary Report Alert Summary report endpoints ### Get Alerts statuses overview for specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/overview](https://api-docs.observepoint.com/openapi/combined.openapi/alert-summary-report/getauditrunalertsummaryalertsoverview.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/overview ### Get Alert Summary alerts table data for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts](https://api-docs.observepoint.com/openapi/combined.openapi/alert-summary-report/getauditrunalertsummaryalerts.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts ### Get specific alert data (config + result) for specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}](https://api-docs.observepoint.com/openapi/combined.openapi/alert-summary-report/getauditrunalertsummaryalertbyid.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId} ## Audit Summary Report Audit Summary report endpoints ### Get Audit Summary data for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary](https://api-docs.observepoint.com/openapi/combined.openapi/audit-summary-report/getauditrunauditsummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary ### Get Audit Summary trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/trends](https://api-docs.observepoint.com/openapi/combined.openapi/audit-summary-report/getauditrunauditsummarytrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/trends ### Get Audit Summary specific trend values relative to current day - [GET /v3/web-audits/{auditId}/reports/audit-summary/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/audit-summary-report/getauditsummarytrend.md): GET /v3/web-audits/{auditId}/reports/audit-summary/trends/{trendName} ### Get Audit Summary all primary tags data for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/primary-tags](https://api-docs.observepoint.com/openapi/combined.openapi/audit-summary-report/getauditrunauditsummaryprimarytags.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/primary-tags ### Get Audit Summary all detected tags data for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags](https://api-docs.observepoint.com/openapi/combined.openapi/audit-summary-report/getauditrunauditsummarydetectedtags.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags ### Get Audit Summary scores for specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores](https://api-docs.observepoint.com/openapi/combined.openapi/audit-summary-report/getauditrunauditsummaryscores.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores ### Get Audit Summary scores trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores/trends](https://api-docs.observepoint.com/openapi/combined.openapi/audit-summary-report/getauditrunauditsummaryscorestrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores/trends ### Get Audit Summary specific score trend values relative to current time - [GET /v3/web-audits/{auditId}/reports/audit-summary/scores/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/audit-summary-report/getauditrunauditscoretrend.md): GET /v3/web-audits/{auditId}/reports/audit-summary/scores/trends/{trendName} ## Browser Logs Report Browser Logs report endpoints ### Get Browser Logs summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs](https://api-docs.observepoint.com/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogssummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs ### Get Browser Logs trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/trends](https://api-docs.observepoint.com/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogstrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/trends ### Get Browser Logs specific trend values relative to current time - [GET /v3/web-audits/{auditId}/reports/browser-logs/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogstrend.md): GET /v3/web-audits/{auditId}/reports/browser-logs/trends/{trendName} ### Get Browser Logs most common messages list for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/messages](https://api-docs.observepoint.com/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogsmessages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/messages ### Get Browser Logs page list for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/pages](https://api-docs.observepoint.com/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogspages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/pages ## Cookie Inventory Report Cookie Inventory report endpoints ### Get Cookie Inventory summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorysummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory ### Get Cookie Inventory trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/trends](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorytrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/trends ### Get Cookie Inventory specific trend values relative to current time - [GET /v3/web-audits/{auditId}/reports/cookie-inventory/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorytrend.md): GET /v3/web-audits/{auditId}/reports/cookie-inventory/trends/{trendName} ### Get Cookie Inventory cookie list for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookies](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorycookies.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookies ### Get Cookie Inventory page list for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/pages](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorypages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/pages ### Get Cookie Inventory page list for specific cookie in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookie-pages](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorycookiepages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookie-pages ### Get Cookie Domains list in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/domains](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorycookiedomains.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/domains ## Cookie Privacy report endpoints Cookie privacy report ### Get Cookie Privacy summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacysummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy ### Get Cookie Privacy trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/trends](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacytrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/trends ### Get Cookie Privacy specific trend values relative to current day - [GET /v3/web-audits/{auditId}/reports/cookie-privacy/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacytrend.md): GET /v3/web-audits/{auditId}/reports/cookie-privacy/trends/{trendName} ### Get Cookie Privacy compliance for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/compliance](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacycompliance.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/compliance ### Get Cookie Privacy pages data for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/pages](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacypages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/pages ### Get Cookie Privacy pages data for specific cookie name+domain in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/cookie-pages](https://api-docs.observepoint.com/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacycookiepages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/cookie-pages ## File Changes Report File changes report endpoints ### Get File Changes summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes](https://api-docs.observepoint.com/openapi/combined.openapi/file-changes-report/getauditrunfilechangessummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes ### Get File Changes files for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/files](https://api-docs.observepoint.com/openapi/combined.openapi/file-changes-report/getauditrunfilechangesfiles.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/files ### Get File Changes pages for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/pages](https://api-docs.observepoint.com/openapi/combined.openapi/file-changes-report/getauditrunfilechangespages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/pages ### Get File Changes pages for specific file in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/file-pages](https://api-docs.observepoint.com/openapi/combined.openapi/file-changes-report/getauditrunfilechangespagesforfile.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/file-pages ## Page Details Report Detailed information about specific pages including tags, cookies, request logs, and console logs ### Return specific page information - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/info](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpageinfo.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/info Get page information from specified audit run on a given page ### Get page links - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpagelinks.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection} Get up to 1000 page links with specified direction (from/to this page), use downloadPageLinks to get all items ### Download page links - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/downloadpagelinks.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download Download page links with specified direction (from/to this page) ### Return remote file mapping results - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/file-mapping](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getfilemapping.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/file-mapping Get remote file mapping results from specified audit run on a given page ### Return page tag information - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/tags](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpagetags.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/tags Get tags from specified audit run on a given page, getting summary insight is optional ### Return page cookie information - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpagecookies.md): 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 ### Return network requests fired on a given page - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/request-log](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpagerequestlog.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/request-log Get request logs from specified audit run on a given page ### Get request initiators info for a given page - [POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpageinitiators.md): POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators Get request initiators info for specified audit run page ### Get requests by HAR entry indices - [POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/request-log](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpagerequestsbyharentryindices.md): POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/request-log ### Get cookies for all HAR entries on a page - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/cookies](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpagecookiesbyharentryindices.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/cookies Get cookies for all HAR entries on a page ### Return console logs summary on a given page - [POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log-summary](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpageconsolelogsummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log-summary Get browser console logs summary for specified audit run page ### Return console logs generated on a given page - [POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpageconsolelog.md): POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log Get browser console logs for specified audit run page ### Return insights on a given page for all runs in the given days - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/sparklines](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpagesparklines.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/sparklines ### Get Page Details Web Vitals trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/trends/web-vitals](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpagedetailspagewebvitalstrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/trends/web-vitals ### Return specific insight trend on a given page for all runs in the given duration (days) - [GET /v3/web-audits/{auditId}/pages/{pageId}/insight-trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpageinsighttrend.md): GET /v3/web-audits/{auditId}/pages/{pageId}/insight-trends/{trendName} ### Get Page Details Web Vitals specific trend values relative to current day - [GET /v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getpagedetailspagewebvitalstrend.md): GET /v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName} ### Get cookie origin (deprecated) - [POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies/origin](https://api-docs.observepoint.com/openapi/combined.openapi/page-details-report/getauditcookieoriginstory.md): POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies/origin Get the origin story for a cookie ## Page Summary Report Page Summary report endpoints ### get page summary insights - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary](https://api-docs.observepoint.com/openapi/combined.openapi/page-summary-report/getpagesummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary ### Get insights by page - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/pages](https://api-docs.observepoint.com/openapi/combined.openapi/page-summary-report/getpagesummarybypage.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/pages ### Return insights for all runs in the given duration - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends](https://api-docs.observepoint.com/openapi/combined.openapi/page-summary-report/getpagesummarytrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends ### Get Page Summary Web Vitals trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends/web-vitals](https://api-docs.observepoint.com/openapi/combined.openapi/page-summary-report/getpagesummarywebvitalstrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends/web-vitals ### Return insights on a given page for all runs in the given duration - [GET /v3/web-audits/{auditId}/reports/page-summary/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/page-summary-report/getpagesummarytrend.md): GET /v3/web-audits/{auditId}/reports/page-summary/trends/{trendName} Get page trend insight from specified time span of audit runs ### Get Page Summary Web Vitals specific trend values relative to current day - [GET /v3/web-audits/{auditId}/reports/page-summary/trends/web-vitals/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/page-summary-report/getpagesummarywebvitalstrend.md): GET /v3/web-audits/{auditId}/reports/page-summary/trends/web-vitals/{trendName} ## Request Privacy Report Request Privacy report endpoints ### Get Request Privacy summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy](https://api-docs.observepoint.com/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacysummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy ### Get Request Privacy trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/trends](https://api-docs.observepoint.com/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacytrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/trends ### Get Request Privacy specific trend values relative to current day - [GET /v3/web-audits/{auditId}/reports/request-privacy/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacytrend.md): GET /v3/web-audits/{auditId}/reports/request-privacy/trends/{trendName} ### Get Request Privacy locations for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations](https://api-docs.observepoint.com/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacylocations.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations ### Get Request Privacy compliance for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/compliance](https://api-docs.observepoint.com/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacycompliance.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/compliance ### Get Request Privacy pages data for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/pages](https://api-docs.observepoint.com/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacypages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/pages ### Get Request Privacy pages data for specific request in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/request-pages](https://api-docs.observepoint.com/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacyrequestpages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/request-pages ## Rule Summary Report Rule Summary report endpoints ### Get rule summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary](https://api-docs.observepoint.com/openapi/combined.openapi/rule-summary-report/getauditrunruleresultssummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary ### Get rule status trends for specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/trends](https://api-docs.observepoint.com/openapi/combined.openapi/rule-summary-report/getauditrunruleresultstrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/trends ### Get rule results trend values for specified audit run relative to current day - [GET /v3/web-audits/{auditId}/reports/rule-summary/trends/rule-results](https://api-docs.observepoint.com/openapi/combined.openapi/rule-summary-report/getauditrunruleresultstrend.md): GET /v3/web-audits/{auditId}/reports/rule-summary/trends/rule-results ### Get rule results page count trend values for specified audit run relative to current day - [GET /v3/web-audits/{auditId}/reports/rule-summary/trends/page-count](https://api-docs.observepoint.com/openapi/combined.openapi/rule-summary-report/getauditrunruleresultspagecounttrend.md): GET /v3/web-audits/{auditId}/reports/rule-summary/trends/page-count ### Get all rules overview for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results](https://api-docs.observepoint.com/openapi/combined.openapi/rule-summary-report/getauditrunallruleresultsoverview.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results ### Get rule details for specified rule within specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId}](https://api-docs.observepoint.com/openapi/combined.openapi/rule-summary-report/getauditrunspecificruleresults.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId} ### Get page rule results within specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results](https://api-docs.observepoint.com/openapi/combined.openapi/rule-summary-report/getauditrunpageruleresults.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results ### Get specific rule page results within specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results/{ruleSnapshotId}](https://api-docs.observepoint.com/openapi/combined.openapi/rule-summary-report/getauditrunspecificrulepageruleresults.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results/{ruleSnapshotId} ## Tag Duplicates and Multiples Report Tag Duplicates and Multiples report endpoints ### Get Tag Duplicates & Multiples summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples](https://api-docs.observepoint.com/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples ### Get Tag Duplicates & Multiples trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/trends](https://api-docs.observepoint.com/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/trends ### Get Tag Duplicates & Multiples specific trend values relative to current date - [GET /v3/web-audits/{auditId}/reports/tag-duplicates-and-multiples/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrend.md): GET /v3/web-audits/{auditId}/reports/tag-duplicates-and-multiples/trends/{trendName} ### Get Tag Duplicates & Multiples all tags data for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags](https://api-docs.observepoint.com/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytags.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags ### Get Tag Duplicates & Multiples tag accounts for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags/{tagId}/accounts](https://api-docs.observepoint.com/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytagaccounts.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags/{tagId}/accounts ### Get Tag Duplicates & Multiples pages for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/pages](https://api-docs.observepoint.com/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplespages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/pages ## Tag Health Report Tag Health report endpoints ### Get Tag Health summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health](https://api-docs.observepoint.com/openapi/combined.openapi/tag-health-report/getauditruntaghealthsummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health ### Get Tag Health trends relative to for specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/trends](https://api-docs.observepoint.com/openapi/combined.openapi/tag-health-report/getauditruntaghealthtrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/trends ### Get Tag Health specific trend values relative to current day - [GET /v3/web-audits/{auditId}/reports/tag-health/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/tag-health-report/getauditruntaghealthtrend.md): GET /v3/web-audits/{auditId}/reports/tag-health/trends/{trendName} ### Get Tag Health all tags list for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags](https://api-docs.observepoint.com/openapi/combined.openapi/tag-health-report/getauditruntaghealthtags.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags ### Get Tag Health tag accounts list for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags/{tagId}/accounts](https://api-docs.observepoint.com/openapi/combined.openapi/tag-health-report/getauditruntaghealthtagaccounts.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags/{tagId}/accounts ### Get Tag Health page list for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/pages](https://api-docs.observepoint.com/openapi/combined.openapi/tag-health-report/getauditruntaghealthpages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/pages ## Tag Inventory Report Tag Inventory report endpoints ### Get Tag Inventory summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory](https://api-docs.observepoint.com/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorysummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory ### Get Tag Inventory tag categories summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tag-categories](https://api-docs.observepoint.com/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytagcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tag-categories ### Get Tag Inventory trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/trends](https://api-docs.observepoint.com/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/trends ### Get Tag Inventory specific trend values relative to current time - [GET /v3/web-audits/{auditId}/reports/tag-inventory/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytrend.md): GET /v3/web-audits/{auditId}/reports/tag-inventory/trends/{trendName} ### Get Tag Inventory tag presence for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags](https://api-docs.observepoint.com/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytagpresence.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags ### Get Tag Inventory tag accounts presence for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags/{tagId}/accounts](https://api-docs.observepoint.com/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytagaccountpresence.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags/{tagId}/accounts ### Get Tag Inventory page info for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/pages](https://api-docs.observepoint.com/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorypages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/pages ## Tag Privacy Report Tag privacy report endpoints ### Get Tag Privacy summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy](https://api-docs.observepoint.com/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacysummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy ### Get Tag Privacy trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/trends](https://api-docs.observepoint.com/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacytrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/trends ### Get Tag Privacy specific trend values relative to current day - [GET /v3/web-audits/{auditId}/reports/tag-privacy/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacytrend.md): GET /v3/web-audits/{auditId}/reports/tag-privacy/trends/{trendName} ### Get Tag Privacy compliance for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/compliance](https://api-docs.observepoint.com/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacycompliance.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/compliance ### Get Tag Privacy pages data for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/pages](https://api-docs.observepoint.com/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacypages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/pages ### Get Tag Privacy pages data for specific tag in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/tag-pages](https://api-docs.observepoint.com/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacytagpages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/tag-pages ## Variable Inventory Report Variable Inventory report endpoints ### Get Variable Inventory summary for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorysummary.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory ### Get Variable Inventory trends relative to specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/trends](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytrends.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/trends ### Get Variable Inventory specific trend values relative to current day - [GET /v3/web-audits/{auditId}/reports/variable-inventory/trends/{trendName}](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytrend.md): GET /v3/web-audits/{auditId}/reports/variable-inventory/trends/{trendName} ### Get Variable Inventory tag accounts list for specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tags](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccounts.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tags ### Get top 500 variables sorted by variableSetPageCount - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variables](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariables.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variables This endpoint will only return top 500 variables which are sort by variableSetPageCount (Desc). ### Get Variable Inventory page list for specific tag account in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-pages](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountpages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-pages ### Get Variable Inventory page list for specific tag account variable in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-pages](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariablepages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-pages ### Get Variable Inventory page list where variable is not set for specific tag account variable in specified audit run. This endpoint does not support sorting by variable_count because we retrieve pages that do NOT have that specific variable - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-not-set-pages](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariablenotsetpages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-not-set-pages ### Get Variable Inventory unique values list for specific tag account variable in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-values](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariableuniquevalues.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-values ### Get Variable Inventory page list for specific tag account variable value in specified audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-value-pages](https://api-docs.observepoint.com/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariablevaluepages.md): POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-value-pages ## Audit Run Data Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs ### Get scores for specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/scores](https://api-docs.observepoint.com/openapi/combined.openapi/web-audits/getauditrunscores.md): GET /v3/web-audits/{auditId}/runs/{runId}/scores ### Return pages found in the run - [GET /v3/web-audits/{auditId}/runs/{runId}/pages](https://api-docs.observepoint.com/openapi/combined.openapi/web-audits/getauditrunpages.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages Get all the pages in a given audit run ### Return a list of unique cookies - [GET /v3/web-audits/{auditId}/runs/{runId}/cookies](https://api-docs.observepoint.com/openapi/combined.openapi/web-audits/getcookies.md): GET /v3/web-audits/{auditId}/runs/{runId}/cookies Get all unique cookie name and domain found on all the pages in a given audit run ### Return a list of unique geo-locations - [GET /v3/web-audits/{auditId}/runs/{runId}/geo-locations](https://api-docs.observepoint.com/openapi/combined.openapi/web-audits/getgeolocation.md): GET /v3/web-audits/{auditId}/runs/{runId}/geo-locations Get all unique geo-locations found on all the pages in a given audit run ### Return a list of unique request-domains - [GET /v3/web-audits/{auditId}/runs/{runId}/request-domains](https://api-docs.observepoint.com/openapi/combined.openapi/web-audits/getrequestdomain.md): GET /v3/web-audits/{auditId}/runs/{runId}/request-domains Get all unique request domains found on all the pages in a given audit run ### Return a list of pages with JS variables - [GET /v3/web-audits/{auditId}/runs/{runId}/javascript-variables](https://api-docs.observepoint.com/openapi/combined.openapi/web-audits/getjavascriptvariables.md): GET /v3/web-audits/{auditId}/runs/{runId}/javascript-variables Get all JS variables found on all the pages in a given audit run ### Get run failures summary - [GET /v3/web-audits/{auditId}/runs/{runId}/reports/failures](https://api-docs.observepoint.com/openapi/combined.openapi/web-audits/getauditfailureresults.md): GET /v3/web-audits/{auditId}/runs/{runId}/reports/failures Returns a summary of failures for the given run. Failures summary includes details for Pre-Audit Actions, On-Page Actions, all found links excluded and starting URLs navigation results. ### Get audit run page screenshot URL - [GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/screenshot](https://api-docs.observepoint.com/openapi/combined.openapi/web-audits/generateauditrunpagescreenshot.md): GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/screenshot Returns an pre-signed S3 URL for audit run page card ## Web Journey Cookie Report Cookie analysis and reporting for web journeys ### Get cookies for action - [GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/cookies](https://api-docs.observepoint.com/openapi/combined.openapi/web-journey-cookie-report/getwebjourneyactioncookies.md): GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/cookies Get all cookies affected by the given action ### Get cookie origin - [POST /v3/web-journeys/{webJourneyId}/runs/{runId}/cookies/origin](https://api-docs.observepoint.com/openapi/combined.openapi/web-journey-cookie-report/getwebjourneyruncookieoriginstory.md): POST /v3/web-journeys/{webJourneyId}/runs/{runId}/cookies/origin Get the origin story for a cookie ### Get cookie origin - [POST /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionId}/cookies/origin](https://api-docs.observepoint.com/openapi/combined.openapi/web-journey-cookie-report/getwebjourneyactioncookieoriginstory.md): POST /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionId}/cookies/origin Get the origin story for a cookie ## Account Usage Export Export account usage data ### Create export for account usage - [POST /v3/usage/exports/{exportType}](https://api-docs.observepoint.com/openapi/combined.openapi/account-usage-export/requestusageexport.md): POST /v3/usage/exports/{exportType} ## Alert Export Export alert data ### Create export for alert - [POST /v3/alerts/exports/{exportType}](https://api-docs.observepoint.com/openapi/combined.openapi/alert-export/requestalertexport.md): POST /v3/alerts/exports/{exportType} ## Audit Run Export Export audit run data ### Create export for web audit run - [POST /v3/web-audits/{auditId}/runs/{runId}/exports/{exportType}](https://api-docs.observepoint.com/openapi/combined.openapi/audit-run-export/requestauditrunexport.md): POST /v3/web-audits/{auditId}/runs/{runId}/exports/{exportType} ## Consent Category Export Export consent category data ### Create export for consent category - [POST /v3/consent-categories/exports/{exportType}](https://api-docs.observepoint.com/openapi/combined.openapi/consent-category-export/requestconsentcategoryexport.md): POST /v3/consent-categories/exports/{exportType} ## Exports Center Access requested exports status/information ### Get export center exports - [GET /v3/exports](https://api-docs.observepoint.com/openapi/combined.openapi/exports/getexportcenterexports.md): GET /v3/exports ### Download export - [GET /v3/exports/{exportUuid}](https://api-docs.observepoint.com/openapi/combined.openapi/exports/getexportdownload.md): GET /v3/exports/{exportUuid} ## Manual Journey Run Export Export manual journey run data ### Create export for manual journey run - [POST /v3/manual-journeys/{manualJourneyId}/runs/{runId}/exports/{exportType}](https://api-docs.observepoint.com/openapi/combined.openapi/manual-journey-run-export/requestmanualjourneyrunexport.md): POST /v3/manual-journeys/{manualJourneyId}/runs/{runId}/exports/{exportType} ## Scheduled Exports Manage scheduled grid report data exports ### Get Scheduled Exports - [GET /v3/exports/scheduled](https://api-docs.observepoint.com/openapi/combined.openapi/scheduled-exports/getscheduledexports.md): GET /v3/exports/scheduled ### Create scheduled export - [POST /v3/exports/scheduled](https://api-docs.observepoint.com/openapi/combined.openapi/scheduled-exports/createscheduledexport.md): POST /v3/exports/scheduled ### Get specific Scheduled Export - [GET /v3/exports/scheduled/{scheduledExportId}](https://api-docs.observepoint.com/openapi/combined.openapi/scheduled-exports/getscheduledexportbyid.md): GET /v3/exports/scheduled/{scheduledExportId} ### Update specific Scheduled Export - [PUT /v3/exports/scheduled/{scheduledExportId}](https://api-docs.observepoint.com/openapi/combined.openapi/scheduled-exports/updatescheduledexportbyid.md): PUT /v3/exports/scheduled/{scheduledExportId} ### Delete specific Scheduled Export - [DELETE /v3/exports/scheduled/{scheduledExportId}](https://api-docs.observepoint.com/openapi/combined.openapi/scheduled-exports/deletescheduledexportbyid.md): DELETE /v3/exports/scheduled/{scheduledExportId} ## Web Journey Run Export Export web journey run data ### Create export for web journey run - [POST /v3/web-journeys/{webJourneyId}/runs/{runId}/exports/{exportType}](https://api-docs.observepoint.com/openapi/combined.openapi/web-journey-run-export/requestwebjourneyrunexport.md): POST /v3/web-journeys/{webJourneyId}/runs/{runId}/exports/{exportType} ## Account's Triggered Alerts Account-level triggered alerts ### Get summary for all triggered alerts for the account - [POST /v3/account-triggered-alerts/summary](https://api-docs.observepoint.com/openapi/combined.openapi/account-triggered-alerts/getaccounttriggeredalertssummary.md): POST /v3/account-triggered-alerts/summary ### Get all triggered alerts for the account - [POST /v3/account-triggered-alerts/alerts](https://api-docs.observepoint.com/openapi/combined.openapi/account-triggered-alerts/getaccounttriggeredalerts.md): POST /v3/account-triggered-alerts/alerts ### Get information about specific alert from all triggered alerts for the account - [POST /v3/account-triggered-alerts/alerts/{alertId}](https://api-docs.observepoint.com/openapi/combined.openapi/account-triggered-alerts/getaccounttriggeredspecificalert.md): POST /v3/account-triggered-alerts/alerts/{alertId} ## Account Usage Alerts Alerts related to account usage ### Get Alert Summary alerts data for account usage - [GET /v3/usage/alert-summary/alerts](https://api-docs.observepoint.com/openapi/combined.openapi/account-usage-alerts/getaccountusagealertsummaryalerts.md): GET /v3/usage/alert-summary/alerts Get Alert Summary alerts data for account usage ## Alerts Alert management and configuration ### Create Alert - [POST /v3/alerts](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/createalert.md): POST /v3/alerts ### Get specific Alert by ID - [GET /v3/alerts/{alertId}](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/getalertbyid.md): GET /v3/alerts/{alertId} ### Update specific Alert - [PUT /v3/alerts/{alertId}](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/updatealertbyid.md): PUT /v3/alerts/{alertId} ### Delete specific Alert - [DELETE /v3/alerts/{alertId}](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/deletealertbyid.md): DELETE /v3/alerts/{alertId} ### Update labels for an Alert - [PUT /v3/alerts/{alertId}/labels](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/updatealertlabels.md): PUT /v3/alerts/{alertId}/labels ### Get Alerts Library items - [POST /v3/alerts/library](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/getalertsforlibrary.md): POST /v3/alerts/library ### Get Alerts by metric - [GET /v3/alerts/metrics/{metricType}](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/getalertsbymetric.md): GET /v3/alerts/metrics/{metricType} ### Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned - [POST /v3/alerts/target-items/{itemType}/search](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/searchtargetitemsforalert.md): POST /v3/alerts/target-items/{itemType}/search ### Update target items (data sources) that have specified Alert assigned - [PATCH /v3/alerts/{alertId}/target-items](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/updatetargetitemsofalert.md): PATCH /v3/alerts/{alertId}/target-items ### Search Alerts for assigning them to other items (audits, WJs etc) - [POST /v3/alerts/search/assignments](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/searchalertsforassignment.md): POST /v3/alerts/search/assignments ### Update Alerts assigned to specified item (audit, journey etc) - [PATCH /v3/alerts/assignments/{itemType}/{itemId}](https://api-docs.observepoint.com/openapi/combined.openapi/alerts/updatealertsassignedtoitem.md): PATCH /v3/alerts/assignments/{itemType}/{itemId} ## Email Inbox Message Alerts Email inbox message alerts ### Get all alerts for selected for email inbox message - [POST /v3/email-inbox-message-alerts](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-message-alerts/getemailinboxmessagealerts.md): POST /v3/email-inbox-message-alerts ## Account Usage Account usage data ### Get brief usage overview for account - [GET /v3/usage/overview](https://api-docs.observepoint.com/openapi/combined.openapi/account-usage-v2/getaccountusagev2overview.md): GET /v3/usage/overview ### Get not filterable usage summary for account - [GET /v3/usage/summary](https://api-docs.observepoint.com/openapi/combined.openapi/account-usage-v2/getaccountusagev2notfilterablesummary.md): GET /v3/usage/summary ### Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned - [POST /v3/usage/{itemType}/summary](https://api-docs.observepoint.com/openapi/combined.openapi/account-usage-v2/getaccountusagev2specificitemtypesummary.md): POST /v3/usage/{itemType}/summary ### Get usage trends for specified item type - [POST /v3/usage/{itemType}/trends](https://api-docs.observepoint.com/openapi/combined.openapi/account-usage-v2/getaccountusagev2trends.md): POST /v3/usage/{itemType}/trends ### Get usage trends for rolling week, for specified item type - [GET /v3/usage/{itemType}/daily-trends](https://api-docs.observepoint.com/openapi/combined.openapi/account-usage-v2/getaccountusagev2dailytrends.md): GET /v3/usage/{itemType}/daily-trends ## Email Inbox Configuration APIs for managing email inbox configurations and setting ### Add a new Email Inbox - [POST /v3/email-inboxes](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-configuration/addemailinbox.md): POST /v3/email-inboxes Add a new Email Inbox ### Update an existing Email Inbox - [PUT /v3/email-inboxes/{emailInboxId}](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-configuration/updateemailinbox.md): PUT /v3/email-inboxes/{emailInboxId} Update an existing Email Inbox by Id ### Delete an Email Inbox - [DELETE /v3/email-inboxes/{emailInboxId}](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-configuration/deleteemailinbox.md): DELETE /v3/email-inboxes/{emailInboxId} Delete an Email Inbox by Id ### Associate audit configurations with an existing Email Inbox - [PUT /v3/email-inboxes/{emailInboxId}/audit-configurations](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-configuration/addemailinboxconfigurations.md): PUT /v3/email-inboxes/{emailInboxId}/audit-configurations ### Associate an audit configuration with an existing Email Inbox - [PUT /v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-configuration/addemailinboxconfiguration.md): PUT /v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId} ### Delete an audit configuration from an Email Inbox - [DELETE /v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-configuration/deleteemailinboxconfiguration.md): DELETE /v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId} ### Upsert labels for an existing Email Inbox - [PUT /v3/email-inboxes/{emailInboxId}/labels](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-configuration/upsertinboxlabels.md): PUT /v3/email-inboxes/{emailInboxId}/labels ### Upsert notes for the given Email Inbox - [PUT /v3/email-inboxes/{emailInboxId}/notes](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-configuration/updateemailinboxnotes.md): PUT /v3/email-inboxes/{emailInboxId}/notes ### Cancel all audit runs associated with a given Email Message - [DELETE /v3/email-inboxes/{emailInboxId}/messages/{receivedEmailMessageId}/runs](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-configuration/cancelemailinboxmessageruns.md): DELETE /v3/email-inboxes/{emailInboxId}/messages/{receivedEmailMessageId}/runs ## Email Inbox Messages Get Email Inbox message details ### Get all the details of an email inbox message - [GET /v3/email-inbox-messages/{messageId}](https://api-docs.observepoint.com/openapi/combined.openapi/email-inbox-messages/getemailinboxmessagedetails.md): GET /v3/email-inbox-messages/{messageId} ## Email Inboxes APIs for getting email messages and results from email inboxes ### Return filtered email inboxes - [POST /v3/email-inboxes/library](https://api-docs.observepoint.com/openapi/combined.openapi/email-inboxes/getemailinboxes.md): POST /v3/email-inboxes/library Get all email inboxes that meet the filtering criteria ### Get Email Inbox by id - [GET /v3/email-inboxes/{emailInboxId}](https://api-docs.observepoint.com/openapi/combined.openapi/email-inboxes/getemailinbox.md): GET /v3/email-inboxes/{emailInboxId} Get a Email Inbox by id ### Read the configurations for an Email Inbox by id - [GET /v3/email-inboxes/{emailInboxId}/audit-configurations](https://api-docs.observepoint.com/openapi/combined.openapi/email-inboxes/getemailinboxconfigurations.md): GET /v3/email-inboxes/{emailInboxId}/audit-configurations ### Get all email messages associated with a given Email Inbox - [GET /v3/email-inboxes/{emailInboxId}/messages](https://api-docs.observepoint.com/openapi/combined.openapi/email-inboxes/getemailinboxmessages.md): GET /v3/email-inboxes/{emailInboxId}/messages ### Get all email messages statuses associated with a given Email Inbox - [POST /v3/email-inboxes/{emailInboxId}/messages/statuses](https://api-docs.observepoint.com/openapi/combined.openapi/email-inboxes/getemailinboxmessagesstatuses.md): POST /v3/email-inboxes/{emailInboxId}/messages/statuses ## Action Set Action Rules APIs for managing Action Set Action Rules ### Get action set action rules - [GET /v3/action-sets/{actionSetId}/actions/{actionId}/rules](https://api-docs.observepoint.com/openapi/combined.openapi/action-set-action-rules/getactionsetactionrules.md): GET /v3/action-sets/{actionSetId}/actions/{actionId}/rules Retrieve all rules for a specific action set and action ### Update action set action rules - [PUT /v3/action-sets/{actionSetId}/actions/{actionId}/rules](https://api-docs.observepoint.com/openapi/combined.openapi/action-set-action-rules/updateactionsetactionrules.md): PUT /v3/action-sets/{actionSetId}/actions/{actionId}/rules Update the rules for a specific action set and action with a new set of rule IDs ## Action Set Actions APIs for managing Action Set Actions ### Get action set action - [GET /v3/action-sets/{actionSetId}/actions/{actionId}](https://api-docs.observepoint.com/openapi/combined.openapi/action-set-actions/getactionsetaction.md): GET /v3/action-sets/{actionSetId}/actions/{actionId} Retrieve a specific action from an action set ### Update action set action - [PUT /v3/action-sets/{actionSetId}/actions/{actionId}](https://api-docs.observepoint.com/openapi/combined.openapi/action-set-actions/updateactionsetaction.md): PUT /v3/action-sets/{actionSetId}/actions/{actionId} Update a specific action in an action set ## Action Sets APIs for managing Action Sets ### Get action sets - [GET /v3/action-sets](https://api-docs.observepoint.com/openapi/combined.openapi/action-sets/getactionsets.md): GET /v3/action-sets Retrieve all action sets in the account ### Create action set - [POST /v3/action-sets](https://api-docs.observepoint.com/openapi/combined.openapi/action-sets/createactionset.md): POST /v3/action-sets Create a new action set ### Get action set by ID - [GET /v3/action-sets/{actionSetId}](https://api-docs.observepoint.com/openapi/combined.openapi/action-sets/getactionset.md): GET /v3/action-sets/{actionSetId} Retrieve a specific action set by its ID ### Update action set - [PUT /v3/action-sets/{actionSetId}](https://api-docs.observepoint.com/openapi/combined.openapi/action-sets/updateactionset.md): PUT /v3/action-sets/{actionSetId} Update an existing action set ### Delete action set - [DELETE /v3/action-sets/{actionSetId}](https://api-docs.observepoint.com/openapi/combined.openapi/action-sets/deleteactionset.md): DELETE /v3/action-sets/{actionSetId} Delete an existing action set ## Audit Actions APIs for managing audit actions ### Get actions for an audit - [GET /v3/web-audits/{auditId}/actions](https://api-docs.observepoint.com/openapi/combined.openapi/audit-actions/getauditactions.md): GET /v3/web-audits/{auditId}/actions Retrieve all actions configured for the specified audit ### Update actions for an audit - [PUT /v3/web-audits/{auditId}/actions](https://api-docs.observepoint.com/openapi/combined.openapi/audit-actions/updateauditactions.md): PUT /v3/web-audits/{auditId}/actions Update the actions configured for the specified audit ## Audit Blocking Config APIs for managing audit request blocking configuration ### Get blocking configuration for an Audit - [GET /v3/web-audits/{auditId}/blocking-configuration](https://api-docs.observepoint.com/openapi/combined.openapi/audit-blocking-config/getauditblockingconfig.md): GET /v3/web-audits/{auditId}/blocking-configuration ### Create blocking configuration for an Audit - [PUT /v3/web-audits/{auditId}/blocking-configuration](https://api-docs.observepoint.com/openapi/combined.openapi/audit-blocking-config/createauditblockingconfig.md): PUT /v3/web-audits/{auditId}/blocking-configuration ## Audit Login Actions APIs for managing audit login actions ### Get login actions for an audit - [GET /v3/web-audits/{auditId}/login-actions](https://api-docs.observepoint.com/openapi/combined.openapi/audit-login-actions/getauditloginactions.md): GET /v3/web-audits/{auditId}/login-actions Retrieve all login actions configured for the specified audit ### Update login actions for an audit - [PUT /v3/web-audits/{auditId}/login-actions](https://api-docs.observepoint.com/openapi/combined.openapi/audit-login-actions/updateauditloginactions.md): PUT /v3/web-audits/{auditId}/login-actions Update the login actions configured for the specified audit ## Audits Consent Category APIs for managing audit consent categories ### Get all the consent categories assigned to an audit - [GET /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/getauditconsentcategories.md): GET /v3/web-audits/{auditId}/consent-categories ### Update the consent categories assigned to an audit - [PATCH /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/patchauditconsentcategories.md): PATCH /v3/web-audits/{auditId}/consent-categories Update the consent categories assigned to an audit. The request will be rejected if trying to assign conflicting consent category types to the same audit ### Retrieve all consent categories snapshots that are applied to a specific audit run. - [GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/getauditrunconsentcategories.md): GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories ### Reprocess consent-category for the selected auditId and runIds - [POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/reprocessconsentcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess ### Get all the consent categories assigned to an audit - [GET /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getauditconsentcategories.md): GET /v3/web-audits/{auditId}/consent-categories ### Update the consent categories assigned to an audit - [PATCH /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/patchauditconsentcategories.md): PATCH /v3/web-audits/{auditId}/consent-categories Update the consent categories assigned to an audit. The request will be rejected if trying to assign conflicting consent category types to the same audit ### Retrieve all consent categories snapshots that are applied to a specific audit run. - [GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getauditrunconsentcategories.md): GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories ### Reprocess consent-category for the selected auditId and runIds - [POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/reprocessconsentcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess ### Get all the consent categories assigned to an audit - [GET /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getauditconsentcategories.md): GET /v3/web-audits/{auditId}/consent-categories ### Update the consent categories assigned to an audit - [PATCH /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/patchauditconsentcategories.md): PATCH /v3/web-audits/{auditId}/consent-categories Update the consent categories assigned to an audit. The request will be rejected if trying to assign conflicting consent category types to the same audit ### Retrieve all consent categories snapshots that are applied to a specific audit run. - [GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getauditrunconsentcategories.md): GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories ### Reprocess consent-category for the selected auditId and runIds - [POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/reprocessconsentcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess ## Audits Management APIs for managing audits ### Get all the consent categories assigned to an audit - [GET /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/getauditconsentcategories.md): GET /v3/web-audits/{auditId}/consent-categories ### Update the consent categories assigned to an audit - [PATCH /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/patchauditconsentcategories.md): PATCH /v3/web-audits/{auditId}/consent-categories Update the consent categories assigned to an audit. The request will be rejected if trying to assign conflicting consent category types to the same audit ### Retrieve all consent categories snapshots that are applied to a specific audit run. - [GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/getauditrunconsentcategories.md): GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories ### Reprocess consent-category for the selected auditId and runIds - [POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/reprocessconsentcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess ### Get list of web audits - [GET /v3/web-audits](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getwebaudits.md): GET /v3/web-audits Retrieve all web audits accessible to the authenticated user based on their permissions ### Get latest runs for web audits - [GET /v3/web-audits/latest-runs](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getwebauditlatestruns.md): GET /v3/web-audits/latest-runs Retrieve latest run information for web audits with optional account filtering ### Get audit notes by ID - [GET /v3/web-audits/{auditId}](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getwebauditnotes.md): GET /v3/web-audits/{auditId} Retrieve notes for a specific audit ### Update audit notes - [PUT /v3/web-audits/{auditId}](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/updatewebauditnotes.md): PUT /v3/web-audits/{auditId} Update notes for a specific audit ### run audit now - [POST /v3/web-audits/{auditId}/runs](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/runauditnow.md): POST /v3/web-audits/{auditId}/runs ### Get audit configuration info for specified audit run - [GET /v3/web-audits/{auditId}/runs/{runId}/info](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getauditruninfo.md): GET /v3/web-audits/{auditId}/runs/{runId}/info ### Get all the consent categories assigned to an audit - [GET /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getauditconsentcategories.md): GET /v3/web-audits/{auditId}/consent-categories ### Update the consent categories assigned to an audit - [PATCH /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/patchauditconsentcategories.md): PATCH /v3/web-audits/{auditId}/consent-categories Update the consent categories assigned to an audit. The request will be rejected if trying to assign conflicting consent category types to the same audit ### Retrieve all consent categories snapshots that are applied to a specific audit run. - [GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getauditrunconsentcategories.md): GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories ### Reprocess consent-category for the selected auditId and runIds - [POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/reprocessconsentcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess ### Get all the consent categories assigned to an audit - [GET /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getauditconsentcategories.md): GET /v3/web-audits/{auditId}/consent-categories ### Update the consent categories assigned to an audit - [PATCH /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/patchauditconsentcategories.md): PATCH /v3/web-audits/{auditId}/consent-categories Update the consent categories assigned to an audit. The request will be rejected if trying to assign conflicting consent category types to the same audit ### Retrieve all consent categories snapshots that are applied to a specific audit run. - [GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getauditrunconsentcategories.md): GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories ### Reprocess consent-category for the selected auditId and runIds - [POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/reprocessconsentcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess ## Consent Categories APIs for managing Consent Categories ### Get all the consent categories assigned to an audit - [GET /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/getauditconsentcategories.md): GET /v3/web-audits/{auditId}/consent-categories ### Update the consent categories assigned to an audit - [PATCH /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/patchauditconsentcategories.md): PATCH /v3/web-audits/{auditId}/consent-categories Update the consent categories assigned to an audit. The request will be rejected if trying to assign conflicting consent category types to the same audit ### Retrieve all consent categories snapshots that are applied to a specific audit run. - [GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/getauditrunconsentcategories.md): GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories ### Reprocess consent-category for the selected auditId and runIds - [POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess](https://api-docs.observepoint.com/openapi/combined.openapi/audits-consent-category/reprocessconsentcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess ### Get all the consent categories assigned to an audit - [GET /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getauditconsentcategories.md): GET /v3/web-audits/{auditId}/consent-categories ### Update the consent categories assigned to an audit - [PATCH /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/patchauditconsentcategories.md): PATCH /v3/web-audits/{auditId}/consent-categories Update the consent categories assigned to an audit. The request will be rejected if trying to assign conflicting consent category types to the same audit ### Retrieve all consent categories snapshots that are applied to a specific audit run. - [GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/getauditrunconsentcategories.md): GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories ### Reprocess consent-category for the selected auditId and runIds - [POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess](https://api-docs.observepoint.com/openapi/combined.openapi/audits-management/reprocessconsentcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess ### Get all the consent categories assigned to an audit - [GET /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getauditconsentcategories.md): GET /v3/web-audits/{auditId}/consent-categories ### Update the consent categories assigned to an audit - [PATCH /v3/web-audits/{auditId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/patchauditconsentcategories.md): PATCH /v3/web-audits/{auditId}/consent-categories Update the consent categories assigned to an audit. The request will be rejected if trying to assign conflicting consent category types to the same audit ### Retrieve all consent categories snapshots that are applied to a specific audit run. - [GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getauditrunconsentcategories.md): GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories ### upload categories found in the csv file uploaded previously - [POST /v3/consent-categories/upload](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/uploadconsentcategories.md): POST /v3/consent-categories/upload ### See preview of file content of consent categories uploaded in csv file - [POST /v3/consent-categories/upload/preview](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/uploadconsentcategoriespreview.md): POST /v3/consent-categories/upload/preview File uploaded must be a text/csv file and cannot be larger than 1MB ### Get all consent categories in the account - [GET /v3/consent-categories/library](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getconsentcategorylibrary.md): GET /v3/consent-categories/library ### Create a consent category - [POST /v3/consent-categories](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/createconsentcategories.md): POST /v3/consent-categories ### Get a consent category - [GET /v3/consent-categories/{consentCategoryId}](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getconsentcategory.md): GET /v3/consent-categories/{consentCategoryId} ### Update a consent category - [PUT /v3/consent-categories/{consentCategoryId}](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/updateconsentcategory.md): PUT /v3/consent-categories/{consentCategoryId} ### Delete a consent category - [DELETE /v3/consent-categories/{consentCategoryId}](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/deleteconsentcategory.md): DELETE /v3/consent-categories/{consentCategoryId} ### Upsert notes for the given Consent Category - [PUT /v3/consent-categories/{consentCategoryId}/notes](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/updateconsentcategoriesnotes.md): PUT /v3/consent-categories/{consentCategoryId}/notes ### Get all tag entries of a consent category - [GET /v3/consent-categories/{consentCategoryId}/tags](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getconsentcategorytags.md): GET /v3/consent-categories/{consentCategoryId}/tags ### Patch consent category tag entries - [PATCH /v3/consent-categories/{consentCategoryId}/tags](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/patchconsentcategorytagentries.md): PATCH /v3/consent-categories/{consentCategoryId}/tags ### Get all request domains of a consent category - [GET /v3/consent-categories/{consentCategoryId}/request-domains](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getconsentcategoryrequestdomains.md): GET /v3/consent-categories/{consentCategoryId}/request-domains ### Patch consent category request domains - [PATCH /v3/consent-categories/{consentCategoryId}/request-domains](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/patchconsentcategoryrequestdomains.md): PATCH /v3/consent-categories/{consentCategoryId}/request-domains ### Reprocess consent-category for the selected auditId and runIds - [POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/reprocessconsentcategories.md): POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess ### Get all cookies of a consent category - [GET /v3/consent-categories/{consentCategoryId}/cookies](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getconsentcategorycookieentries.md): GET /v3/consent-categories/{consentCategoryId}/cookies Get all cookies of a consent category ### Patch consent category cookie entries - [PATCH /v3/consent-categories/{consentCategoryId}/cookies](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/patchconsentcategorycookieentries.md): PATCH /v3/consent-categories/{consentCategoryId}/cookies patch a consent category cookie entry ### Get audits assigned to the consent category - [GET /v3/consent-categories/{consentCategoryId}/web-audits](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getconsentcategoryaudits.md): GET /v3/consent-categories/{consentCategoryId}/web-audits Get audits assigned to the consent category ### Modify audit attachments - [PATCH /v3/consent-categories/{consentCategoryId}/web-audits](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/patchconsentcategoryaudits.md): PATCH /v3/consent-categories/{consentCategoryId}/web-audits Modify audit attachments ### Get all labels attached to specified consent category - [GET /v3/consent-categories/{consentCategoryId}/labels](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/getconsentcategoryassignedlabels.md): GET /v3/consent-categories/{consentCategoryId}/labels ### Patch labels attached to specified consent category - [PATCH /v3/consent-categories/{consentCategoryId}/labels](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/patchconsentcategoryassignedlabels.md): PATCH /v3/consent-categories/{consentCategoryId}/labels ### request an export of all consent categories in the account (deprecated) - [POST /v3/consent-categories/export](https://api-docs.observepoint.com/openapi/combined.openapi/consent-categories/exportconsentcategories.md): POST /v3/consent-categories/export Please, use /v3/consent-categories/exports/ACCOUNT_CONSENT_CATEGORY_CONFIGS_EXPORT instead ## Custom Headers APIs for managing custom HTTP header groups ### Get all custom header groups - [GET /v3/custom-headers](https://api-docs.observepoint.com/openapi/combined.openapi/custom-headers/getcustomheadergroupsummary.md): GET /v3/custom-headers ### Create a custom header group - [POST /v3/custom-headers](https://api-docs.observepoint.com/openapi/combined.openapi/custom-headers/createcustomheadergroup.md): POST /v3/custom-headers ### Get a custom header group by ID - [GET /v3/custom-headers/{customHeaderGroupId}](https://api-docs.observepoint.com/openapi/combined.openapi/custom-headers/getcustomheadergroupbyid.md): GET /v3/custom-headers/{customHeaderGroupId} ### Update a custom header group - [PUT /v3/custom-headers/{customHeaderGroupId}](https://api-docs.observepoint.com/openapi/combined.openapi/custom-headers/updatecustomheadergroup.md): PUT /v3/custom-headers/{customHeaderGroupId} ### Delete a custom header group by ID - [DELETE /v3/custom-headers/{customHeaderGroupId}](https://api-docs.observepoint.com/openapi/combined.openapi/custom-headers/deletecustomheadergroupbyid.md): DELETE /v3/custom-headers/{customHeaderGroupId} ### Search for target items (audits or web journeys) for custom header assignment - [POST /v3/custom-headers/target-items/{itemType}/search](https://api-docs.observepoint.com/openapi/combined.openapi/custom-headers/searchcustomheadertargetitems.md): POST /v3/custom-headers/target-items/{itemType}/search ## Data Sources APIs for managing Data Sources ### Get all data sources in the account - [GET /v3/data-sources](https://api-docs.observepoint.com/openapi/combined.openapi/data-sources/getdatasources.md): GET /v3/data-sources this endpoint is get all the data sources in the account with their labels ### Search data sources with specific item IDs - [POST /v3/data-sources/search](https://api-docs.observepoint.com/openapi/combined.openapi/data-sources/getdatasourceswithitemids.md): POST /v3/data-sources/search This endpoint retrieves all the data sources in the account with their labels. ### Search for target items (audits or web journeys) for data source assignment based on searched item type (ALERT, CUSTOM_HEADER, EMAIL_INBOX, RULE) - [POST /v3/data-sources/target-items/{itemType}/search](https://api-docs.observepoint.com/openapi/combined.openapi/data-sources/searchdatasourcestargetitems.md): POST /v3/data-sources/target-items/{itemType}/search ## Geo Locations APIs for geo locations ### Get all available countries for geo-location filtering - [GET /v3/geo-locations/countries](https://api-docs.observepoint.com/openapi/combined.openapi/geo-locations/getgeolocationcountries.md): GET /v3/geo-locations/countries Retrieve a list of all available countries with their associated continent information for use in geo-location based filtering ## Notification Center Find and manage email subscriptions ### Get all emails in an account - [GET /v3/notification-center/emails](https://api-docs.observepoint.com/openapi/combined.openapi/notification-center/getnotificationcenteremails.md): GET /v3/notification-center/emails ### Get emails subscribed to given items - [POST /v3/notification-center/emails](https://api-docs.observepoint.com/openapi/combined.openapi/notification-center/getnotificationcenteremailssubscribedtoitems.md): POST /v3/notification-center/emails ### Search assignable items (audits, journeys, rules etc) for specified email - [POST /v3/notification-center/target-items/{itemType}/search](https://api-docs.observepoint.com/openapi/combined.openapi/notification-center/searchtargetitemsforemails.md): POST /v3/notification-center/target-items/{itemType}/search ## Remote File Mappings APIs for managing Remote File Mappings ### Get remote file mappings - [GET /v3/remote-file-mappings](https://api-docs.observepoint.com/openapi/combined.openapi/remote-file-mappings/getremotefilemappings.md): GET /v3/remote-file-mappings Retrieve all remote file mappings with optional account filtering ### Create remote file mapping - [POST /v3/remote-file-mappings](https://api-docs.observepoint.com/openapi/combined.openapi/remote-file-mappings/createremotefilemapping.md): POST /v3/remote-file-mappings Create a new remote file mapping configuration ### Get remote file mapping by ID - [GET /v3/remote-file-mappings/{rfmId}](https://api-docs.observepoint.com/openapi/combined.openapi/remote-file-mappings/getremotefilemapping.md): GET /v3/remote-file-mappings/{rfmId} Retrieve a specific remote file mapping by its ID ### Update remote file mapping - [PUT /v3/remote-file-mappings/{rfmId}](https://api-docs.observepoint.com/openapi/combined.openapi/remote-file-mappings/updateremotefilemapping.md): PUT /v3/remote-file-mappings/{rfmId} Update an existing remote file mapping ### Delete remote file mapping - [DELETE /v3/remote-file-mappings/{rfmId}](https://api-docs.observepoint.com/openapi/combined.openapi/remote-file-mappings/deleteremotefilemapping.md): DELETE /v3/remote-file-mappings/{rfmId} Delete a specific remote file mapping by its ID ## Rules APIs for managing rules ### Get all rules in an account - [POST /v3/rule-library](https://api-docs.observepoint.com/openapi/combined.openapi/rules/getrulelibraryrules.md): POST /v3/rule-library ## Schedules APIs for item schedules and calendars ### Get all schedule presets - [GET /v3/schedules/presets](https://api-docs.observepoint.com/openapi/combined.openapi/schedules/getschedulepresets.md): GET /v3/schedules/presets ### Generate a description of a schedule's recurrence - [POST /v3/schedules/rule-description](https://api-docs.observepoint.com/openapi/combined.openapi/schedules/createrecurrenceruledescription.md): POST /v3/schedules/rule-description ### Calculate future occurrences based on the new schedules and the old frequencies - [GET /v3/schedules/calendar](https://api-docs.observepoint.com/openapi/combined.openapi/schedules/calendarget.md): GET /v3/schedules/calendar ### Update calendar items' schedules using this endpoint. - [PUT /v3/schedules/calendar](https://api-docs.observepoint.com/openapi/combined.openapi/schedules/calendarput.md): PUT /v3/schedules/calendar ## Site Censuses APIs for managing Site Census ### Get all censuses for an account - [GET /v3/site-censuses](https://api-docs.observepoint.com/openapi/combined.openapi/site-censuses/getsitecensuses.md): GET /v3/site-censuses ### Create a new site census - [POST /v3/site-censuses](https://api-docs.observepoint.com/openapi/combined.openapi/site-censuses/createsitecensus.md): POST /v3/site-censuses ### Get a site census by ID - [GET /v3/site-censuses/{censusId}](https://api-docs.observepoint.com/openapi/combined.openapi/site-censuses/getsitecensusbyid.md): GET /v3/site-censuses/{censusId} ### Update an existing site census - [PUT /v3/site-censuses/{censusId}](https://api-docs.observepoint.com/openapi/combined.openapi/site-censuses/updatesitecensusbyid.md): PUT /v3/site-censuses/{censusId} ### Delete a site census by ID - [DELETE /v3/site-censuses/{censusId}](https://api-docs.observepoint.com/openapi/combined.openapi/site-censuses/deletesitecensusbyid.md): DELETE /v3/site-censuses/{censusId} ### Returns a summary of the current census results data - [GET /v3/site-censuses/{censusId}/current-results](https://api-docs.observepoint.com/openapi/combined.openapi/site-censuses/getsitecensuscurrentresults.md): GET /v3/site-censuses/{censusId}/current-results ### Returns a preview of the current census results data given specific path patterns - [POST /v3/site-censuses/{censusId}/current-results/url-preview](https://api-docs.observepoint.com/openapi/combined.openapi/site-censuses/getsitecensuspatternurlpreview.md): POST /v3/site-censuses/{censusId}/current-results/url-preview ### Starts data-collection for a given census - [POST /v3/site-censuses/{censusId}/start](https://api-docs.observepoint.com/openapi/combined.openapi/site-censuses/startsitecensusdatacollection.md): POST /v3/site-censuses/{censusId}/start ### Stops data-collection for a given census - [POST /v3/site-censuses/{censusId}/stop](https://api-docs.observepoint.com/openapi/combined.openapi/site-censuses/stopsitecensusdatacollection.md): POST /v3/site-censuses/{censusId}/stop ## User Events APIs for managing User Events ### Get user events in the account - [GET /v3/user-events](https://api-docs.observepoint.com/openapi/combined.openapi/user-events/getuserevents.md): GET /v3/user-events This endpoint will get all the changes made by users in the account. This endpoint is only for Admins ## Web Journey Blocking Config APIs for managing web journey request blocking configuration ### Get blocking configuration for a web journey - [GET /v3/web-journeys/{webJourneyId}/blocking-configuration](https://api-docs.observepoint.com/openapi/combined.openapi/web-journey-blocking-config/getwebjourneyblockingconfig.md): GET /v3/web-journeys/{webJourneyId}/blocking-configuration ### Create blocking configuration for a web journey - [PUT /v3/web-journeys/{webJourneyId}/blocking-configuration](https://api-docs.observepoint.com/openapi/combined.openapi/web-journey-blocking-config/createwebjourneyblockingconfig.md): PUT /v3/web-journeys/{webJourneyId}/blocking-configuration ## Web Journey Custom Headers APIs for managing web journey custom headers ### Get custom headers for a web journey - [GET /v3/web-journeys/{webJourneyId}/custom-headers](https://api-docs.observepoint.com/openapi/combined.openapi/web-journey-custom-headers/getwebjourneycustomheaders.md): GET /v3/web-journeys/{webJourneyId}/custom-headers ### Update custom headers for a web journey - [PUT /v3/web-journeys/{webJourneyId}/custom-headers](https://api-docs.observepoint.com/openapi/combined.openapi/web-journey-custom-headers/updatewebjourneycustomheaders.md): PUT /v3/web-journeys/{webJourneyId}/custom-headers ## Web Journeys Management APIs for managing Web Journeys ### Get web journeys - [GET /v3/web-journeys](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneys.md): GET /v3/web-journeys Retrieve all web journeys with optional filtering ### Create web journey - [POST /v3/web-journeys](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/createwebjourney.md): POST /v3/web-journeys Create a new web journey ### Delete web journeys by domain or folder - [DELETE /v3/web-journeys](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/deletewebjourneys.md): DELETE /v3/web-journeys Delete web journeys by domain ID or folder ID ### Get web journey by ID - [GET /v3/web-journeys/{webJourneyId}](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourney.md): GET /v3/web-journeys/{webJourneyId} Retrieve a specific web journey by its ID ### Update web journey - [PUT /v3/web-journeys/{webJourneyId}](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/updatewebjourney.md): PUT /v3/web-journeys/{webJourneyId} Update an existing web journey ### Delete web journey - [DELETE /v3/web-journeys/{webJourneyId}](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/deletewebjourney.md): DELETE /v3/web-journeys/{webJourneyId} Delete a specific web journey by its ID ### Get web journey status - [GET /v3/web-journeys/{webJourneyId}/status](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneystatus.md): GET /v3/web-journeys/{webJourneyId}/status Retrieve the current status of a web journey ### Get web journey actions - [GET /v3/web-journeys/{webJourneyId}/actions](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyactions.md): GET /v3/web-journeys/{webJourneyId}/actions Retrieve all actions for a web journey ### Update web journey actions - [PUT /v3/web-journeys/{webJourneyId}/actions](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/updatewebjourneyactions.md): PUT /v3/web-journeys/{webJourneyId}/actions Update all actions for a web journey ### Get web journey action by ID - [GET /v3/web-journeys/{webJourneyId}/actions/{actionId}](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyaction.md): GET /v3/web-journeys/{webJourneyId}/actions/{actionId} Retrieve a specific action by its ID within a web journey ### Update web journey action - [PUT /v3/web-journeys/{webJourneyId}/actions/{actionId}](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/updatewebjourneyaction.md): PUT /v3/web-journeys/{webJourneyId}/actions/{actionId} Update a specific action within a web journey ### Get web journey run status - [GET /v3/web-journeys/{webJourneyId}/runs/{runId}/status](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyrunstatus.md): GET /v3/web-journeys/{webJourneyId}/runs/{runId}/status Retrieve the status of a specific web journey run ### Delete web journey run - [DELETE /v3/web-journeys/{webJourneyId}/runs/{runId}](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/deletewebjourneyrun.md): DELETE /v3/web-journeys/{webJourneyId}/runs/{runId} Stop/discard a specific web journey run ### Delete current web journey run - [DELETE /v3/web-journeys/{webJourneyId}/runs/current](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/deletecurrentwebjourneyrun.md): DELETE /v3/web-journeys/{webJourneyId}/runs/current Stop/discard the current web journey run ### Get web journey notification configuration - [GET /v3/web-journeys/{webJourneyId}/notificationconfig](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneynotificationconfig.md): GET /v3/web-journeys/{webJourneyId}/notificationconfig Retrieve notification settings for a web journey ### Update web journey notification configuration - [PUT /v3/web-journeys/{webJourneyId}/notificationconfig](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/updatewebjourneynotificationconfig.md): PUT /v3/web-journeys/{webJourneyId}/notificationconfig Update or create notification settings for a web journey ### Get web journey rules - [GET /v3/web-journeys/{webJourneyId}/rules](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyrules.md): GET /v3/web-journeys/{webJourneyId}/rules Retrieve all rules associated with a web journey ### Update web journey rules - [PUT /v3/web-journeys/{webJourneyId}/rules](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/updatewebjourneyrules.md): PUT /v3/web-journeys/{webJourneyId}/rules Bind rules to a web journey and its actions ### Get web journey action rules - [GET /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyactionrules.md): GET /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules Retrieve rules for a specific action within a web journey ### Update web journey action rules - [PUT /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/updatewebjourneyactionrules.md): PUT /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules Bind rules to a specific action within a web journey ### Get web journey remote file mappings - [GET /v3/web-journeys/{webJourneyId}/remotefilemappings](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyremotefilemappings.md): GET /v3/web-journeys/{webJourneyId}/remotefilemappings Retrieve all remote file mappings associated with a web journey ### Update web journey remote file mappings - [PUT /v3/web-journeys/{webJourneyId}/remotefilemappings](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/updatewebjourneyremotefilemappings.md): PUT /v3/web-journeys/{webJourneyId}/remotefilemappings Bind remote file mappings to a web journey ### Get action requests - [GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyactionrequests.md): GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests Retrieve all network requests made during an action execution ### Get action logs - [GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyactionlogs.md): GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs Retrieve console logs generated during an action execution ### Get all labels attached to specified web journey - [GET /v3/web-journeys/{webJourneyId}/labels](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyassignedlabels.md): GET /v3/web-journeys/{webJourneyId}/labels ### Patch labels attached to specified web journey - [PATCH /v3/web-journeys/{webJourneyId}/labels](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/patchwebjourneyassignedlabels.md): PATCH /v3/web-journeys/{webJourneyId}/labels ### Get journey configuration info for specified journey run - [GET /v3/web-journeys/{webJourneyId}/runs/{runId}/info](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/getwebjourneyruninfo.md): GET /v3/web-journeys/{webJourneyId}/runs/{runId}/info ### Run web journey - [POST /v3/web-journeys/{webJourneyId}/runs](https://api-docs.observepoint.com/openapi/combined.openapi/web-journeys-management/runwebjourney.md): POST /v3/web-journeys/{webJourneyId}/runs Creates a new run for the specified web journey. The journey must exist, have actions configured, and not already be running.