{"items":[{"type":"link","label":"V3 API","link":"/openapi/combined.openapi","routeSlug":"/openapi/combined.openapi","content":{"contentType":"overview","meta":{"name":"V3 API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"combined.openapi.json","url":"/_bundle/openapi/combined.openapi.json?download"},{"kind":"download","label":"combined.openapi.yaml","url":"/_bundle/openapi/combined.openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.observepoint.com/contact-us","url":"https://www.observepoint.com/contact-us"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"V3 API","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"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."}],"sectionId":"/openapi/combined.openapi"}],"sectionId":"/openapi/combined.openapi"}]}]}},{"type":"separator","label":"Audit Reports","content":null},{"type":"group","label":"Alert Summary Report","link":"/openapi/combined.openapi/alert-summary-report","routeSlug":"/openapi/combined.openapi/alert-summary-report","items":[{"label":"Get Alerts statuses overview for specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alert-summary-report/getauditrunalertsummaryalertsoverview","routeSlug":"/openapi/combined.openapi/alert-summary-report/getauditrunalertsummaryalertsoverview","metadata":{"seo":{"title":"Get Alerts statuses overview for specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/overview"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAlertSummaryAlertsOverview","name":"Get Alerts statuses overview for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1overview/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Alerts statuses overview for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/alert-summary/overview"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1overview/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/overview","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/overview","href":"alert-summary-report/getauditrunalertsummaryalertsoverview","openApiOperationId":"getAuditRunAlertSummaryAlertsOverview","summary":"Get Alerts statuses overview for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Alert Summary alerts overview data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AlertSummary_AlertsOverviewResponseDTO"}},"schemaId":"components/schemas/AuditRun_AlertSummary_AlertsOverviewResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1overview/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AlertSummary_AlertsOverviewResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AlertSummary_AlertsOverviewResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert-summary-report/getauditrunalertsummaryalertsoverview"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/overview"},{"label":"Get Alert Summary alerts table data for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alert-summary-report/getauditrunalertsummaryalerts","routeSlug":"/openapi/combined.openapi/alert-summary-report/getauditrunalertsummaryalerts","metadata":{"seo":{"title":"Get Alert Summary alerts table data for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAlertSummaryAlerts","name":"Get Alert Summary alerts table data for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1alerts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Alert Summary alerts table data for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/alert-summary/alerts"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1alerts/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_598"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1alerts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_AlertSummary_SummaryRequestDTO"}},"schemaId":"components/schemas/AuditRun_AlertSummary_SummaryRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1alerts/post/requestBody","description":"Filters applicable to Alert Summary report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_AuditSummary_AlertsSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_AlertSummary_SummaryRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts","href":"alert-summary-report/getauditrunalertsummaryalerts","openApiOperationId":"getAuditRunAlertSummaryAlerts","summary":"Get Alert Summary alerts table data for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_AlertSummary_SummaryRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_AlertSummary_SummaryRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Alert Summary alerts data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_AlertsResponseDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_AlertsResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1alerts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_AlertsResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_AlertsResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert-summary-report/getauditrunalertsummaryalerts"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts"},{"label":"Get specific alert data (config + result) for specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alert-summary-report/getauditrunalertsummaryalertbyid","routeSlug":"/openapi/combined.openapi/alert-summary-report/getauditrunalertsummaryalertbyid","metadata":{"seo":{"title":"Get specific alert data (config + result) for specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAlertSummaryAlertById","name":"Get specific alert data (config + result) for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1alerts~1{alertId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specific alert data (config + result) for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/alert-summary/alerts/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{alertId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"alertId","in":"path","schemaId":"schema_600","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1alerts~1{alertId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"alertId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}","href":"alert-summary-report/getauditrunalertsummaryalertbyid","openApiOperationId":"getAuditRunAlertSummaryAlertById","summary":"Get specific alert data (config + result) for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Alert Summary specific alert data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_SpecificAlertResponseDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_SpecificAlertResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1alert-summary~1alerts~1{alertId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_SpecificAlertResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_SpecificAlertResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert-summary-report/getauditrunalertsummaryalertbyid"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}"}],"content":{"contentType":"group","meta":{"name":"alert-summary-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alert Summary Report","showPageActions":true},{"nodeType":"markdoc","content":"Alert Summary report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/overview","summary":"Get Alerts statuses overview for specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alert-summary-report/getauditrunalertsummaryalertsoverview","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts","summary":"Get Alert Summary alerts table data for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alert-summary-report/getauditrunalertsummaryalerts","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}","summary":"Get specific alert data (config + result) for specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alert-summary-report/getauditrunalertsummaryalertbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit Summary Report","link":"/openapi/combined.openapi/audit-summary-report","routeSlug":"/openapi/combined.openapi/audit-summary-report","items":[{"label":"Get Audit Summary data for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummary","routeSlug":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummary","metadata":{"seo":{"title":"Get Audit Summary data for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAuditSummary","name":"Get Audit Summary data for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Audit Summary data for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/audit-summary"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary/post/requestBody","description":"Filters applicable to Audit Summary report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary","href":"audit-summary-report/getauditrunauditsummary","openApiOperationId":"getAuditRunAuditSummary","summary":"Get Audit Summary data for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit Summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-summary-report/getauditrunauditsummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary"},{"label":"Get Audit Summary trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummarytrends","routeSlug":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummarytrends","metadata":{"seo":{"title":"Get Audit Summary trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAuditSummaryTrends","name":"Get Audit Summary trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Audit Summary trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/audit-summary/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/trends","href":"audit-summary-report/getauditrunauditsummarytrends","openApiOperationId":"getAuditRunAuditSummaryTrends","summary":"Get Audit Summary trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit Summary trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_TrendsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_TrendsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-summary-report/getauditrunauditsummarytrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/trends"},{"label":"Get Audit Summary specific trend values relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-summary-report/getauditsummarytrend","routeSlug":"/openapi/combined.openapi/audit-summary-report/getauditsummarytrend","metadata":{"seo":{"title":"Get Audit Summary specific trend values relative to current day","description":"GET /v3/web-audits/{auditId}/reports/audit-summary/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditSummaryTrend","name":"Get Audit Summary specific trend values relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1audit-summary~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Audit Summary specific trend values relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/audit-summary/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_601","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1audit-summary~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1audit-summary~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/audit-summary/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_AuditSummary_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/audit-summary/trends/{trendName}","href":"audit-summary-report/getauditsummarytrend","openApiOperationId":"getAuditSummaryTrend","summary":"Get Audit Summary specific trend values relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit Summary specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1audit-summary~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-summary-report/getauditsummarytrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/audit-summary/trends/{trendName}"},{"label":"Get Audit Summary all primary tags data for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummaryprimarytags","routeSlug":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummaryprimarytags","metadata":{"seo":{"title":"Get Audit Summary all primary tags data for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/primary-tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAuditSummaryPrimaryTags","name":"Get Audit Summary all primary tags data for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1primary-tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Audit Summary all primary tags data for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/audit-summary/primary-tags"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1primary-tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1primary-tags/post/requestBody","description":"Filters applicable to Audit Summary report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/primary-tags","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO"}},"responseCodes":["200","400","401","404","424"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/primary-tags","href":"audit-summary-report/getauditrunauditsummaryprimarytags","openApiOperationId":"getAuditRunAuditSummaryPrimaryTags","summary":"Get Audit Summary all primary tags data for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit Summary all primary tags data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_PrimaryTagsDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_PrimaryTagsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"424","description":"The method could not be performed on the resource because the requested action depended on another action and that action failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1primary-tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_PrimaryTagsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_PrimaryTagsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"424","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-summary-report/getauditrunauditsummaryprimarytags"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/primary-tags"},{"label":"Get Audit Summary all detected tags data for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummarydetectedtags","routeSlug":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummarydetectedtags","metadata":{"seo":{"title":"Get Audit Summary all detected tags data for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAuditSummaryDetectedTags","name":"Get Audit Summary all detected tags data for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Audit Summary all detected tags data for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/audit-summary/tags"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1tags/post/requestBody","description":"Filters applicable to Audit Summary report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags","href":"audit-summary-report/getauditrunauditsummarydetectedtags","openApiOperationId":"getAuditRunAuditSummaryDetectedTags","summary":"Get Audit Summary all detected tags data for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit Summary all detected tags data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_DetectedTagsDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_DetectedTagsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_DetectedTagsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_DetectedTagsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-summary-report/getauditrunauditsummarydetectedtags"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags"},{"label":"Get Audit Summary scores for specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummaryscores","routeSlug":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummaryscores","metadata":{"seo":{"title":"Get Audit Summary scores for specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAuditSummaryScores","name":"Get Audit Summary scores for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1scores/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Audit Summary scores for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/audit-summary/scores"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1scores/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores","href":"audit-summary-report/getauditrunauditsummaryscores","openApiOperationId":"getAuditRunAuditSummaryScores","summary":"Get Audit Summary scores for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit Summary scores data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_ScoresDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_ScoresDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1scores/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_ScoresDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_ScoresDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-summary-report/getauditrunauditsummaryscores"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores"},{"label":"Get Audit Summary scores trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummaryscorestrends","routeSlug":"/openapi/combined.openapi/audit-summary-report/getauditrunauditsummaryscorestrends","metadata":{"seo":{"title":"Get Audit Summary scores trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAuditSummaryScoresTrends","name":"Get Audit Summary scores trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1scores~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Audit Summary scores trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/audit-summary/scores/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1scores~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores/trends","href":"audit-summary-report/getauditrunauditsummaryscorestrends","openApiOperationId":"getAuditRunAuditSummaryScoresTrends","summary":"Get Audit Summary scores trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit Summary all scores trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_AllScoresTrendValuesDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_AllScoresTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1audit-summary~1scores~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_AllScoresTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_AllScoresTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-summary-report/getauditrunauditsummaryscorestrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores/trends"},{"label":"Get Audit Summary specific score trend values relative to current time","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-summary-report/getauditrunauditscoretrend","routeSlug":"/openapi/combined.openapi/audit-summary-report/getauditrunauditscoretrend","metadata":{"seo":{"title":"Get Audit Summary specific score trend values relative to current time","description":"GET /v3/web-audits/{auditId}/reports/audit-summary/scores/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAuditScoreTrend","name":"Get Audit Summary specific score trend values relative to current time","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1audit-summary~1scores~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Audit Summary specific score trend values relative to current time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/audit-summary/scores/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_603","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1audit-summary~1scores~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1audit-summary~1scores~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/audit-summary/scores/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_AuditSummary_ScoreTrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/audit-summary/scores/trends/{trendName}","href":"audit-summary-report/getauditrunauditscoretrend","openApiOperationId":"getAuditRunAuditScoreTrend","summary":"Get Audit Summary specific score trend values relative to current time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit Score specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_ScoreTrendValuesDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_ScoreTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1audit-summary~1scores~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_ScoreTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_ScoreTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-summary-report/getauditrunauditscoretrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/audit-summary/scores/trends/{trendName}"}],"content":{"contentType":"group","meta":{"name":"audit-summary-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit Summary Report","showPageActions":true},{"nodeType":"markdoc","content":"Audit Summary report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary","summary":"Get Audit Summary data for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-summary-report/getauditrunauditsummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/trends","summary":"Get Audit Summary trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-summary-report/getauditrunauditsummarytrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/audit-summary/trends/{trendName}","summary":"Get Audit Summary specific trend values relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-summary-report/getauditsummarytrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/primary-tags","summary":"Get Audit Summary all primary tags data for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-summary-report/getauditrunauditsummaryprimarytags","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags","summary":"Get Audit Summary all detected tags data for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-summary-report/getauditrunauditsummarydetectedtags","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores","summary":"Get Audit Summary scores for specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-summary-report/getauditrunauditsummaryscores","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores/trends","summary":"Get Audit Summary scores trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-summary-report/getauditrunauditsummaryscorestrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/audit-summary/scores/trends/{trendName}","summary":"Get Audit Summary specific score trend values relative to current time","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-summary-report/getauditrunauditscoretrend","deprecated":false}]}]}]}]}},{"type":"group","label":"Browser Logs Report","link":"/openapi/combined.openapi/browser-logs-report","routeSlug":"/openapi/combined.openapi/browser-logs-report","items":[{"label":"Get Browser Logs summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogssummary","routeSlug":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogssummary","metadata":{"seo":{"title":"Get Browser Logs summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunBrowserLogsSummary","name":"Get Browser Logs summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Browser Logs summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/browser-logs"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO"}},"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs/post/requestBody","description":"Filters applicable to Browser Logs report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs","href":"browser-logs-report/getauditrunbrowserlogssummary","openApiOperationId":"getAuditRunBrowserLogsSummary","summary":"Get Browser Logs summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Browser Logs summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_BrowserLogs_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_BrowserLogs_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browser-logs-report/getauditrunbrowserlogssummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs"},{"label":"Get Browser Logs trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogstrends","routeSlug":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogstrends","metadata":{"seo":{"title":"Get Browser Logs trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunBrowserLogsTrends","name":"Get Browser Logs trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Browser Logs trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/browser-logs/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/trends","href":"browser-logs-report/getauditrunbrowserlogstrends","openApiOperationId":"getAuditRunBrowserLogsTrends","summary":"Get Browser Logs trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Browser Logs trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_BrowserLogs_TrendsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_BrowserLogs_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_TrendsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browser-logs-report/getauditrunbrowserlogstrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/trends"},{"label":"Get Browser Logs specific trend values relative to current time","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogstrend","routeSlug":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogstrend","metadata":{"seo":{"title":"Get Browser Logs specific trend values relative to current time","description":"GET /v3/web-audits/{auditId}/reports/browser-logs/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunBrowserLogsTrend","name":"Get Browser Logs specific trend values relative to current time","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1browser-logs~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Browser Logs specific trend values relative to current time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/browser-logs/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_604","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1browser-logs~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1browser-logs~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/browser-logs/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_BrowserLogs_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/browser-logs/trends/{trendName}","href":"browser-logs-report/getauditrunbrowserlogstrend","openApiOperationId":"getAuditRunBrowserLogsTrend","summary":"Get Browser Logs specific trend values relative to current time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Browser Logs specific trend values data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1browser-logs~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browser-logs-report/getauditrunbrowserlogstrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/browser-logs/trends/{trendName}"},{"label":"Get Browser Logs most common messages list for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogsmessages","routeSlug":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogsmessages","metadata":{"seo":{"title":"Get Browser Logs most common messages list for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/messages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunBrowserLogsMessages","name":"Get Browser Logs most common messages list for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1messages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Browser Logs most common messages list for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/browser-logs/messages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1messages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_605"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1messages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO"}},"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1messages/post/requestBody","description":"Filters applicable to Browser Logs report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/messages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_BrowserLogs_MessagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/messages","href":"browser-logs-report/getauditrunbrowserlogsmessages","openApiOperationId":"getAuditRunBrowserLogsMessages","summary":"Get Browser Logs most common messages list for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Browser Logs most common messages","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_MessagesDTO"}},"schemaId":"components/schemas/AuditRun_BrowserLogs_MessagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1messages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_BrowserLogs_MessagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_MessagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browser-logs-report/getauditrunbrowserlogsmessages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/messages"},{"label":"Get Browser Logs page list for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogspages","routeSlug":"/openapi/combined.openapi/browser-logs-report/getauditrunbrowserlogspages","metadata":{"seo":{"title":"Get Browser Logs page list for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunBrowserLogsPages","name":"Get Browser Logs page list for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Browser Logs page list for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/browser-logs/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_606"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_PagesRequestDTO"}},"schemaId":"components/schemas/AuditRun_BrowserLogs_PagesRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1pages/post/requestBody","description":"Filters applicable to Browser Logs report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_BrowserLogs_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_PagesRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/pages","href":"browser-logs-report/getauditrunbrowserlogspages","openApiOperationId":"getAuditRunBrowserLogsPages","summary":"Get Browser Logs page list for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_BrowserLogs_PagesRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_PagesRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Browser Logs pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_PagesDTO"}},"schemaId":"components/schemas/AuditRun_BrowserLogs_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1browser-logs~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_BrowserLogs_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_BrowserLogs_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browser-logs-report/getauditrunbrowserlogspages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/pages"}],"content":{"contentType":"group","meta":{"name":"browser-logs-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Browser Logs Report","showPageActions":true},{"nodeType":"markdoc","content":"Browser Logs report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs","summary":"Get Browser Logs summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/browser-logs-report/getauditrunbrowserlogssummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/trends","summary":"Get Browser Logs trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/browser-logs-report/getauditrunbrowserlogstrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/browser-logs/trends/{trendName}","summary":"Get Browser Logs specific trend values relative to current time","prefix":{"name":"get","color":"get"},"badges":[],"link":"/browser-logs-report/getauditrunbrowserlogstrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/messages","summary":"Get Browser Logs most common messages list for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/browser-logs-report/getauditrunbrowserlogsmessages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/pages","summary":"Get Browser Logs page list for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/browser-logs-report/getauditrunbrowserlogspages","deprecated":false}]}]}]}]}},{"type":"group","label":"Cookie Inventory Report","link":"/openapi/combined.openapi/cookie-inventory-report","routeSlug":"/openapi/combined.openapi/cookie-inventory-report","items":[{"label":"Get Cookie Inventory summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorysummary","routeSlug":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorysummary","metadata":{"seo":{"title":"Get Cookie Inventory summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookieInventorySummary","name":"Get Cookie Inventory summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Inventory summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-inventory"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory/post/requestBody","description":"Filters applicable to Cookie Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory","href":"cookie-inventory-report/getauditruncookieinventorysummary","openApiOperationId":"getAuditRunCookieInventorySummary","summary":"Get Cookie Inventory summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Inventory summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookieInventory_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-inventory-report/getauditruncookieinventorysummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory"},{"label":"Get Cookie Inventory trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorytrends","routeSlug":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorytrends","metadata":{"seo":{"title":"Get Cookie Inventory trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookieInventoryTrends","name":"Get Cookie Inventory trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Inventory trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-inventory/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/trends","href":"cookie-inventory-report/getauditruncookieinventorytrends","openApiOperationId":"getAuditRunCookieInventoryTrends","summary":"Get Cookie Inventory trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Inventory trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_TrendsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookieInventory_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_TrendsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-inventory-report/getauditruncookieinventorytrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/trends"},{"label":"Get Cookie Inventory specific trend values relative to current time","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorytrend","routeSlug":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorytrend","metadata":{"seo":{"title":"Get Cookie Inventory specific trend values relative to current time","description":"GET /v3/web-audits/{auditId}/reports/cookie-inventory/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookieInventoryTrend","name":"Get Cookie Inventory specific trend values relative to current time","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1cookie-inventory~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Inventory specific trend values relative to current time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-inventory/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_607","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1cookie-inventory~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1cookie-inventory~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/cookie-inventory/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_CookieInventory_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/cookie-inventory/trends/{trendName}","href":"cookie-inventory-report/getauditruncookieinventorytrend","openApiOperationId":"getAuditRunCookieInventoryTrend","summary":"Get Cookie Inventory specific trend values relative to current time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Inventory specific trend values data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1cookie-inventory~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-inventory-report/getauditruncookieinventorytrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/cookie-inventory/trends/{trendName}"},{"label":"Get Cookie Inventory cookie list for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorycookies","routeSlug":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorycookies","metadata":{"seo":{"title":"Get Cookie Inventory cookie list for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookieInventoryCookies","name":"Get Cookie Inventory cookie list for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Inventory cookie list for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-inventory/cookies"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookies/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_609"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookies/post/requestBody","description":"Filters applicable to Cookie Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookies","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_CookieInventory_CookiesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookies","href":"cookie-inventory-report/getauditruncookieinventorycookies","openApiOperationId":"getAuditRunCookieInventoryCookies","summary":"Get Cookie Inventory cookie list for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Inventory cookies data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_CookiesListDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_CookiesListDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookieInventory_CookiesListDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_CookiesListDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-inventory-report/getauditruncookieinventorycookies"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookies"},{"label":"Get Cookie Inventory page list for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorypages","routeSlug":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorypages","metadata":{"seo":{"title":"Get Cookie Inventory page list for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookieInventoryPages","name":"Get Cookie Inventory page list for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Inventory page list for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-inventory/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_610"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1pages/post/requestBody","description":"Filters applicable to Cookie Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_CookieInventory_PageSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/pages","href":"cookie-inventory-report/getauditruncookieinventorypages","openApiOperationId":"getAuditRunCookieInventoryPages","summary":"Get Cookie Inventory page list for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Inventory pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_PagesListDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_PagesListDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookieInventory_PagesListDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_PagesListDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-inventory-report/getauditruncookieinventorypages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/pages"},{"label":"Get Cookie Inventory page list for specific cookie in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorycookiepages","routeSlug":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorycookiepages","metadata":{"seo":{"title":"Get Cookie Inventory page list for specific cookie in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookie-pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookieInventoryCookiePages","name":"Get Cookie Inventory page list for specific cookie in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookie-pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Inventory page list for specific cookie in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-inventory/cookie-pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookie-pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_610"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookie-pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_CookiePagesRequestDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_CookiePagesRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookie-pages/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters applicable to Cookie Inventory report + specific cookie to check out its pages"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookie-pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_CookieInventory_PageSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_CookiePagesRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookie-pages","href":"cookie-inventory-report/getauditruncookieinventorycookiepages","openApiOperationId":"getAuditRunCookieInventoryCookiePages","summary":"Get Cookie Inventory page list for specific cookie in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_CookieInventory_CookiePagesRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_CookiePagesRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Inventory specific cookie pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_PagesListDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_PagesListDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1cookie-pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookieInventory_PagesListDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_PagesListDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-inventory-report/getauditruncookieinventorycookiepages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookie-pages"},{"label":"Get Cookie Domains list in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorycookiedomains","routeSlug":"/openapi/combined.openapi/cookie-inventory-report/getauditruncookieinventorycookiedomains","metadata":{"seo":{"title":"Get Cookie Domains list in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/domains"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookieInventoryCookieDomains","name":"Get Cookie Domains list in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1domains/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Domains list in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-inventory/domains"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1domains/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_611"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1domains/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1domains/post/requestBody","description":"Filters applicable to Cookie Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/domains","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_CookieInventory_DomainSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/domains","href":"cookie-inventory-report/getauditruncookieinventorycookiedomains","openApiOperationId":"getAuditRunCookieInventoryCookieDomains","summary":"Get Cookie Domains list in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Inventory domains data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_DomainsListDTO"}},"schemaId":"components/schemas/AuditRun_CookieInventory_DomainsListDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-inventory~1domains/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookieInventory_DomainsListDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookieInventory_DomainsListDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-inventory-report/getauditruncookieinventorycookiedomains"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/domains"}],"content":{"contentType":"group","meta":{"name":"cookie-inventory-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cookie Inventory Report","showPageActions":true},{"nodeType":"markdoc","content":"Cookie Inventory report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory","summary":"Get Cookie Inventory summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cookie-inventory-report/getauditruncookieinventorysummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/trends","summary":"Get Cookie Inventory trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cookie-inventory-report/getauditruncookieinventorytrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/cookie-inventory/trends/{trendName}","summary":"Get Cookie Inventory specific trend values relative to current time","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cookie-inventory-report/getauditruncookieinventorytrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookies","summary":"Get Cookie Inventory cookie list for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cookie-inventory-report/getauditruncookieinventorycookies","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/pages","summary":"Get Cookie Inventory page list for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cookie-inventory-report/getauditruncookieinventorypages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookie-pages","summary":"Get Cookie Inventory page list for specific cookie in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cookie-inventory-report/getauditruncookieinventorycookiepages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/domains","summary":"Get Cookie Domains list in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cookie-inventory-report/getauditruncookieinventorycookiedomains","deprecated":false}]}]}]}]}},{"type":"group","label":"Cookie Privacy report endpoints","link":"/openapi/combined.openapi/cookie-privacy-report","routeSlug":"/openapi/combined.openapi/cookie-privacy-report","items":[{"label":"Get Cookie Privacy summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacysummary","routeSlug":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacysummary","metadata":{"seo":{"title":"Get Cookie Privacy summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookiePrivacySummary","name":"Get Cookie Privacy summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Privacy summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-privacy"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy/post/requestBody","description":"Filters applicable to Cookie Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy","href":"cookie-privacy-report/getauditruncookieprivacysummary","openApiOperationId":"getAuditRunCookiePrivacySummary","summary":"Get Cookie Privacy summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Privacy summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_CookiePrivacy_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookiePrivacy_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-privacy-report/getauditruncookieprivacysummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy"},{"label":"Get Cookie Privacy trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacytrends","routeSlug":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacytrends","metadata":{"seo":{"title":"Get Cookie Privacy trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookiePrivacyTrends","name":"Get Cookie Privacy trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Privacy trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-privacy/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/trends","href":"cookie-privacy-report/getauditruncookieprivacytrends","openApiOperationId":"getAuditRunCookiePrivacyTrends","summary":"Get Cookie Privacy trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Privacy trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_CookiePrivacy_TrendsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookiePrivacy_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_TrendsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-privacy-report/getauditruncookieprivacytrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/trends"},{"label":"Get Cookie Privacy specific trend values relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacytrend","routeSlug":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacytrend","metadata":{"seo":{"title":"Get Cookie Privacy specific trend values relative to current day","description":"GET /v3/web-audits/{auditId}/reports/cookie-privacy/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookiePrivacyTrend","name":"Get Cookie Privacy specific trend values relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1cookie-privacy~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Privacy specific trend values relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-privacy/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_612","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1cookie-privacy~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1cookie-privacy~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/cookie-privacy/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_CookiePrivacy_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/cookie-privacy/trends/{trendName}","href":"cookie-privacy-report/getauditruncookieprivacytrend","openApiOperationId":"getAuditRunCookiePrivacyTrend","summary":"Get Cookie Privacy specific trend values relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Privacy specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1cookie-privacy~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-privacy-report/getauditruncookieprivacytrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/cookie-privacy/trends/{trendName}"},{"label":"Get Cookie Privacy compliance for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacycompliance","routeSlug":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacycompliance","metadata":{"seo":{"title":"Get Cookie Privacy compliance for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/compliance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookiePrivacyCompliance","name":"Get Cookie Privacy compliance for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1compliance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Privacy compliance for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-privacy/compliance"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1compliance/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_613"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1compliance/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1compliance/post/requestBody","description":"Filters applicable to Cookie Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/compliance","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/compliance","href":"cookie-privacy-report/getauditruncookieprivacycompliance","openApiOperationId":"getAuditRunCookiePrivacyCompliance","summary":"Get Cookie Privacy compliance for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Privacy compliance data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiesComplianceDTO"}},"schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiesComplianceDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1compliance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiesComplianceDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiesComplianceDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-privacy-report/getauditruncookieprivacycompliance"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/compliance"},{"label":"Get Cookie Privacy pages data for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacypages","routeSlug":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacypages","metadata":{"seo":{"title":"Get Cookie Privacy pages data for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookiePrivacyPages","name":"Get Cookie Privacy pages data for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Privacy pages data for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-privacy/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_614"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1pages/post/requestBody","description":"Filters applicable to Cookie Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/pages","href":"cookie-privacy-report/getauditruncookieprivacypages","openApiOperationId":"getAuditRunCookiePrivacyPages","summary":"Get Cookie Privacy pages data for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Privacy pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesDTO"}},"schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-privacy-report/getauditruncookieprivacypages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/pages"},{"label":"Get Cookie Privacy pages data for specific cookie name+domain in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacycookiepages","routeSlug":"/openapi/combined.openapi/cookie-privacy-report/getauditruncookieprivacycookiepages","metadata":{"seo":{"title":"Get Cookie Privacy pages data for specific cookie name+domain in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/cookie-pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunCookiePrivacyCookiePages","name":"Get Cookie Privacy pages data for specific cookie name+domain in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1cookie-pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cookie Privacy pages data for specific cookie name+domain in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/cookie-privacy/cookie-pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1cookie-pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_614"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1cookie-pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiePagesRequestDTO"}},"schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiePagesRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1cookie-pages/post/requestBody","description":"Filters applicable to Cookie Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/cookie-pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiePagesRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/cookie-pages","href":"cookie-privacy-report/getauditruncookieprivacycookiepages","openApiOperationId":"getAuditRunCookiePrivacyCookiePages","summary":"Get Cookie Privacy pages data for specific cookie name+domain in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiePagesRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_CookiePagesRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookie Privacy pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesDTO"}},"schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1cookie-privacy~1cookie-pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_CookiePrivacy_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cookie-privacy-report/getauditruncookieprivacycookiepages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/cookie-pages"}],"content":{"contentType":"group","meta":{"name":"cookie-privacy-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cookie Privacy report endpoints","showPageActions":true},{"nodeType":"markdoc","content":"Cookie privacy report"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy","summary":"Get Cookie Privacy summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cookie-privacy-report/getauditruncookieprivacysummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/trends","summary":"Get Cookie Privacy trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cookie-privacy-report/getauditruncookieprivacytrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/cookie-privacy/trends/{trendName}","summary":"Get Cookie Privacy specific trend values relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cookie-privacy-report/getauditruncookieprivacytrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/compliance","summary":"Get Cookie Privacy compliance for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cookie-privacy-report/getauditruncookieprivacycompliance","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/pages","summary":"Get Cookie Privacy pages data for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cookie-privacy-report/getauditruncookieprivacypages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/cookie-pages","summary":"Get Cookie Privacy pages data for specific cookie name+domain in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cookie-privacy-report/getauditruncookieprivacycookiepages","deprecated":false}]}]}]}]}},{"type":"group","label":"File Changes Report","link":"/openapi/combined.openapi/file-changes-report","routeSlug":"/openapi/combined.openapi/file-changes-report","items":[{"label":"Get File Changes summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/file-changes-report/getauditrunfilechangessummary","routeSlug":"/openapi/combined.openapi/file-changes-report/getauditrunfilechangessummary","metadata":{"seo":{"title":"Get File Changes summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunFileChangesSummary","name":"Get File Changes summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get File Changes summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/file-changes"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO"}},"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes/post/requestBody","description":"Filters applicable to File Changes report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes","href":"file-changes-report/getauditrunfilechangessummary","openApiOperationId":"getAuditRunFileChangesSummary","summary":"Get File Changes summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File Changes summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_FileChanges_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_FileChanges_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-changes-report/getauditrunfilechangessummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes"},{"label":"Get File Changes files for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/file-changes-report/getauditrunfilechangesfiles","routeSlug":"/openapi/combined.openapi/file-changes-report/getauditrunfilechangesfiles","metadata":{"seo":{"title":"Get File Changes files for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/files"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunFileChangesFiles","name":"Get File Changes files for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get File Changes files for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/file-changes/files"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1files/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_615"},{"name":"sortBy","in":"query","schemaId":"schema_616"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO"}},"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1files/post/requestBody","description":"Filters applicable to File Changes report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/files","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_615"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_FileChanges_FilesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/files","href":"file-changes-report/getauditrunfilechangesfiles","openApiOperationId":"getAuditRunFileChangesFiles","summary":"Get File Changes files for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File Changes summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_FilesDTO"}},"schemaId":"components/schemas/AuditRun_FileChanges_FilesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1files/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_FileChanges_FilesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_FilesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-changes-report/getauditrunfilechangesfiles"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/files"},{"label":"Get File Changes pages for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/file-changes-report/getauditrunfilechangespages","routeSlug":"/openapi/combined.openapi/file-changes-report/getauditrunfilechangespages","metadata":{"seo":{"title":"Get File Changes pages for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunFileChangesPages","name":"Get File Changes pages for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get File Changes pages for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/file-changes/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_617"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO"}},"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1pages/post/requestBody","description":"Filters applicable to File Changes report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_FileChanges_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/pages","href":"file-changes-report/getauditrunfilechangespages","openApiOperationId":"getAuditRunFileChangesPages","summary":"Get File Changes pages for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File Changes pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_PagesDTO"}},"schemaId":"components/schemas/AuditRun_FileChanges_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_FileChanges_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-changes-report/getauditrunfilechangespages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/pages"},{"label":"Get File Changes pages for specific file in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/file-changes-report/getauditrunfilechangespagesforfile","routeSlug":"/openapi/combined.openapi/file-changes-report/getauditrunfilechangespagesforfile","metadata":{"seo":{"title":"Get File Changes pages for specific file in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/file-pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunFileChangesPagesForFile","name":"Get File Changes pages for specific file in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1file-pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get File Changes pages for specific file in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/file-changes/file-pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1file-pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_617"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1file-pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_FilePagesRequestDTO"}},"schemaId":"components/schemas/AuditRun_FileChanges_FilePagesRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1file-pages/post/requestBody","description":"Filters applicable to File Changes report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/file-pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_FileChanges_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_FilePagesRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/file-pages","href":"file-changes-report/getauditrunfilechangespagesforfile","openApiOperationId":"getAuditRunFileChangesPagesForFile","summary":"Get File Changes pages for specific file in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_FileChanges_FilePagesRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_FilePagesRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File Changes pages data for specific file","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_PagesDTO"}},"schemaId":"components/schemas/AuditRun_FileChanges_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1file-changes~1file-pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_FileChanges_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_FileChanges_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-changes-report/getauditrunfilechangespagesforfile"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/file-pages"}],"content":{"contentType":"group","meta":{"name":"file-changes-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Changes Report","showPageActions":true},{"nodeType":"markdoc","content":"File changes report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes","summary":"Get File Changes summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-changes-report/getauditrunfilechangessummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/files","summary":"Get File Changes files for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-changes-report/getauditrunfilechangesfiles","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/pages","summary":"Get File Changes pages for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-changes-report/getauditrunfilechangespages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/file-pages","summary":"Get File Changes pages for specific file in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-changes-report/getauditrunfilechangespagesforfile","deprecated":false}]}]}]}]}},{"type":"group","label":"Page Details Report","link":"/openapi/combined.openapi/page-details-report","routeSlug":"/openapi/combined.openapi/page-details-report","items":[{"label":"Return specific page information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpageinfo","routeSlug":"/openapi/combined.openapi/page-details-report/getpageinfo","metadata":{"seo":{"title":"Return specific page information","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageInfo","name":"Return specific page information","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return specific page information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/info"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get page information from specified audit run on a given page"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1info/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"withLinkSummary","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter to request inclusion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in response"},"children":[]}]}]}]},{"name":"withParentPage","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter to request inclusion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in response"},"children":[]}]}]}]},{"name":"withScreenshotUrl","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter to request inclusion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screenshot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in response"},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/info","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[{"name":"withLinkSummary","in":"query","required":false,"schemaId":"schema_599"},{"name":"withParentPage","in":"query","required":false,"schemaId":"schema_599"},{"name":"withScreenshotUrl","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/info","href":"page-details-report/getpageinfo","openApiOperationId":"getPageInfo","summary":"Return specific page information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page Info by page Id","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageInfo"}},"schemaId":"components/schemas/PageInfo"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1info/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageInfo"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpageinfo"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/info"},{"label":"Get page links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpagelinks","routeSlug":"/openapi/combined.openapi/page-details-report/getpagelinks","metadata":{"seo":{"title":"Get page links","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageLinks","name":"Get page links","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1links~1{linkDirection}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get page links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/links/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{linkDirection}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get up to 1000 page links with specified direction (from/to this page), use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"downloadPageLinks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get all items"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true},{"name":"linkDirection","in":"path","schemaId":"schema_619","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1links~1{linkDirection}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"options","in":"query","schemaId":"schema_620","description":"Applicable to links from this page"},{"name":"thisUrlType","in":"query","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable to links to this page."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"missing - links pointing to either initial or final url"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - links pointing to initial url,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"final"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - links pointing to final url, if there was no redirect, final url will be the the same as initial"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1links~1{linkDirection}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"},{"name":"linkDirection","in":"path","required":true,"schemaId":"components/schemas/AuditRun_PageInfo_LinkDirection"}],"query":[{"name":"options","in":"query","schemaId":"schema_620","style":"form"},{"name":"thisUrlType","in":"query","schemaId":"components/schemas/AuditRun_PageInfo_ThisUrlTypeEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}","href":"page-details-report/getpagelinks","openApiOperationId":"getPageLinks","summary":"Get page links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page links","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageInfo_LinksDTO"}},"schemaId":"components/schemas/AuditRun_PageInfo_LinksDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1links~1{linkDirection}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_PageInfo_LinksDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageInfo_LinksDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpagelinks"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}"},{"label":"Download page links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/downloadpagelinks","routeSlug":"/openapi/combined.openapi/page-details-report/downloadpagelinks","metadata":{"seo":{"title":"Download page links","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadPageLinks","name":"Download page links","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1links~1{linkDirection}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download page links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/links/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{linkDirection}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/download"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download page links with specified direction (from/to this page)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true},{"name":"linkDirection","in":"path","schemaId":"schema_619","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1links~1{linkDirection}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"options","in":"query","schemaId":"schema_620","description":"Applicable to links from this page"},{"name":"thisUrlType","in":"query","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable to links to this page."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"missing - links pointing to either initial or final url"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - links pointing to initial url,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"final"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - links pointing to final url, if there was no redirect, final url will be the the same as initial"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1links~1{linkDirection}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"},{"name":"linkDirection","in":"path","required":true,"schemaId":"components/schemas/AuditRun_PageInfo_LinkDirection"}],"query":[{"name":"options","in":"query","schemaId":"schema_620","style":"form"},{"name":"thisUrlType","in":"query","schemaId":"components/schemas/AuditRun_PageInfo_ThisUrlTypeEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download","href":"page-details-report/downloadpagelinks","openApiOperationId":"downloadPageLinks","summary":"Download page links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page links","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_622"}},"schemaId":"schema_622","headers":{"content-disposition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the name of the downloaded file (in case of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" content)"},"children":[]}]}]}],"schema":{"type":"string","example":"attachment; filename=\"page-summary-links-to-this-page-My_Audit-2022-03-22_15-16-17.csv\""}}},"headerSchemaId":"schema_623"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1links~1{linkDirection}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_622","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_622"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/downloadpagelinks"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download"},{"label":"Return remote file mapping results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getfilemapping","routeSlug":"/openapi/combined.openapi/page-details-report/getfilemapping","metadata":{"seo":{"title":"Return remote file mapping results","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/file-mapping"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFileMapping","name":"Return remote file mapping results","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1file-mapping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return remote file mapping results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/file-mapping"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get remote file mapping results from specified audit run on a given page"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1file-mapping/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/file-mapping","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/file-mapping","href":"page-details-report/getfilemapping","openApiOperationId":"getFileMapping","summary":"Return remote file mapping results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page Info by page Id","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_624"}},"schemaId":"schema_624"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1file-mapping/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_624","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_624"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getfilemapping"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/file-mapping"},{"label":"Return page tag information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpagetags","routeSlug":"/openapi/combined.openapi/page-details-report/getpagetags","metadata":{"seo":{"title":"Return page tag information","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageTags","name":"Return page tag information","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return page tag information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/tags"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get tags from specified audit run on a given page, getting summary insight is optional"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1tags/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"getInsights","in":"query","schemaId":"schema_625","example":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/tags","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[{"name":"getInsights","in":"query","required":false,"example":true,"schemaId":"schema_625"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/tags","href":"page-details-report/getpagetags","openApiOperationId":"getPageTags","summary":"Return page tag information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Info by page Id, pageTagInsights object is optional","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagInfoDTOWithInsights"}},"schemaId":"components/schemas/TagInfoDTOWithInsights"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TagInfoDTOWithInsights","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagInfoDTOWithInsights"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpagetags"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/tags"},{"label":"Return page cookie information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpagecookies","routeSlug":"/openapi/combined.openapi/page-details-report/getpagecookies","metadata":{"seo":{"title":"Return page cookie information","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageCookies","name":"Return page cookie information","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1cookies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return page cookie information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/cookies"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get cookies from specified audit run on a given page, getting summary insight is optional"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1cookies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"getInsights","in":"query","schemaId":"schema_625","example":true},{"name":"getOrigins","in":"query","schemaId":"schema_625","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then origin story will be returned for each cookie"},"children":[]}]}]}],"example":true},{"name":"hidePreAuditActionOnlyCookies","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then cookies which were only changed during pre-audit actions will be hidden"},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1cookies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[{"name":"getInsights","in":"query","required":false,"example":true,"schemaId":"schema_625"},{"name":"getOrigins","in":"query","required":false,"example":true,"schemaId":"schema_625"},{"name":"hidePreAuditActionOnlyCookies","in":"query","required":false,"example":true,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies","href":"page-details-report/getpagecookies","openApiOperationId":"getPageCookies","summary":"Return page cookie information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return cookies found on a page","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditPageCookiesDTO"}},"schemaId":"components/schemas/AuditPageCookiesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1cookies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditPageCookiesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditPageCookiesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpagecookies"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies"},{"label":"Return network requests fired on a given page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpagerequestlog","routeSlug":"/openapi/combined.openapi/page-details-report/getpagerequestlog","metadata":{"seo":{"title":"Return network requests fired on a given page","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/request-log"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageRequestLog","name":"Return network requests fired on a given page","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1request-log/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return network requests fired on a given page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/request-log"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get request logs from specified audit run on a given page"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1request-log/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_626"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"search","in":"query","schemaId":"schema_627","description":"Filters results by a search string"},{"name":"showPreAuditActionRequests","in":"query","schemaId":"schema_599","description":"Filters results by cookie origin type"},{"name":"hideIdentifiedTags","in":"query","schemaId":"schema_599","description":"Hides requests identified as marketing tags"},{"name":"showFileChanges","in":"query","schemaId":"schema_599","description":"For privacy customers, when file changes are requested, we show the changes of the files between previous run and current run."}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1request-log/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/request-log","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_PageDetails_RequestLogSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"search","in":"query","required":false,"schemaId":"schema_627"},{"name":"showPreAuditActionRequests","in":"query","required":false,"schemaId":"schema_599"},{"name":"hideIdentifiedTags","in":"query","required":false,"schemaId":"schema_599"},{"name":"showFileChanges","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/request-log","href":"page-details-report/getpagerequestlog","openApiOperationId":"getPageRequestLog","summary":"Return network requests fired on a given page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of network requests send","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RequestLogDTO"}},"schemaId":"components/schemas/RequestLogDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1request-log/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RequestLogDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RequestLogDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpagerequestlog"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/request-log"},{"label":"Get request initiators info for a given page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpageinitiators","routeSlug":"/openapi/combined.openapi/page-details-report/getpageinitiators","metadata":{"seo":{"title":"Get request initiators info for a given page","description":"POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageInitiators","name":"Get request initiators info for a given page","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get request initiators info for a given page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/initiators"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get request initiators info for specified audit run page"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRunPage_InitiatorsTree_RequestDTO"}},"schemaId":"components/schemas/AuditRunPage_InitiatorsTree_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRunPage_InitiatorsTree_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators","href":"page-details-report/getpageinitiators","openApiOperationId":"getPageInitiators","summary":"Get request initiators info for a given page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRunPage_InitiatorsTree_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRunPage_InitiatorsTree_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRunPage_InitiatorsTree_ResponseDTO"}},"schemaId":"components/schemas/AuditRunPage_InitiatorsTree_ResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRunPage_InitiatorsTree_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRunPage_InitiatorsTree_ResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpageinitiators"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators"},{"label":"Get requests by HAR entry indices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpagerequestsbyharentryindices","routeSlug":"/openapi/combined.openapi/page-details-report/getpagerequestsbyharentryindices","metadata":{"seo":{"title":"Get requests by HAR entry indices","description":"POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/request-log"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageRequestsByHarEntryIndices","name":"Get requests by HAR entry indices","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators~1request-log/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get requests by HAR entry indices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/initiators/request-log"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators~1request-log/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryByHarEntryIndices_RequestDto"}},"schemaId":"components/schemas/QueryByHarEntryIndices_RequestDto","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators~1request-log/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/request-log","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryByHarEntryIndices_RequestDto"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/request-log","href":"page-details-report/getpagerequestsbyharentryindices","openApiOperationId":"getPageRequestsByHarEntryIndices","summary":"Get requests by HAR entry indices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/QueryByHarEntryIndices_RequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryByHarEntryIndices_RequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRequestsByHarEntryIndices_ResponseDto"}},"schemaId":"components/schemas/GetRequestsByHarEntryIndices_ResponseDto"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators~1request-log/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRequestsByHarEntryIndices_ResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRequestsByHarEntryIndices_ResponseDto"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpagerequestsbyharentryindices"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/request-log"},{"label":"Get cookies for all HAR entries on a page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpagecookiesbyharentryindices","routeSlug":"/openapi/combined.openapi/page-details-report/getpagecookiesbyharentryindices","metadata":{"seo":{"title":"Get cookies for all HAR entries on a page","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/cookies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageCookiesByHarEntryIndices","name":"Get cookies for all HAR entries on a page","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators~1cookies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cookies for all HAR entries on a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/initiators/cookies"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get cookies for all HAR entries on a page"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators~1cookies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/cookies","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/cookies","href":"page-details-report/getpagecookiesbyharentryindices","openApiOperationId":"getPageCookiesByHarEntryIndices","summary":"Get cookies for all HAR entries on a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCookiesByHarEntryIndices_ResponseDto"}},"schemaId":"components/schemas/GetCookiesByHarEntryIndices_ResponseDto"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1initiators~1cookies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCookiesByHarEntryIndices_ResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCookiesByHarEntryIndices_ResponseDto"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpagecookiesbyharentryindices"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/cookies"},{"label":"Return console logs summary on a given page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpageconsolelogsummary","routeSlug":"/openapi/combined.openapi/page-details-report/getpageconsolelogsummary","metadata":{"seo":{"title":"Return console logs summary on a given page","description":"POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log-summary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageConsoleLogSummary","name":"Return console logs summary on a given page","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1console-log-summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return console logs summary on a given page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/console-log-summary"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get browser console logs summary for specified audit run page"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1console-log-summary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO"}},"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1console-log-summary/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log-summary","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log-summary","href":"page-details-report/getpageconsolelogsummary","openApiOperationId":"getPageConsoleLogSummary","summary":"Return console logs summary on a given page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsoleLogSummary"}},"schemaId":"components/schemas/ConsoleLogSummary"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1console-log-summary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsoleLogSummary","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsoleLogSummary"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpageconsolelogsummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log-summary"},{"label":"Return console logs generated on a given page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpageconsolelog","routeSlug":"/openapi/combined.openapi/page-details-report/getpageconsolelog","metadata":{"seo":{"title":"Return console logs generated on a given page","description":"POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageConsoleLog","name":"Return console logs generated on a given page","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1console-log/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return console logs generated on a given page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/console-log"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get browser console logs for specified audit run page"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1console-log/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_615"},{"name":"sortBy","in":"query","schemaId":"schema_628"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1console-log/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO"}},"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1console-log/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_615"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRunPage_BrowserLogs_MessagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log","href":"page-details-report/getpageconsolelog","openApiOperationId":"getPageConsoleLog","summary":"Return console logs generated on a given page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of console logs generated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRunPage_ConsoleLogsDTO"}},"schemaId":"components/schemas/AuditRunPage_ConsoleLogsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1console-log/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRunPage_ConsoleLogsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRunPage_ConsoleLogsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpageconsolelog"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log"},{"label":"Return insights on a given page for all runs in the given days","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpagesparklines","routeSlug":"/openapi/combined.openapi/page-details-report/getpagesparklines","metadata":{"seo":{"title":"Return insights on a given page for all runs in the given days","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/sparklines"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageSparklines","name":"Return insights on a given page for all runs in the given days","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1sparklines/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return insights on a given page for all runs in the given days","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/sparklines"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1sparklines/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/sparklines","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/sparklines","href":"page-details-report/getpagesparklines","openApiOperationId":"getPageSparklines","summary":"Return insights on a given page for all runs in the given days"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page Insights by page Id","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SparkLinesDTO"}},"schemaId":"components/schemas/SparkLinesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1sparklines/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SparkLinesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SparkLinesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpagesparklines"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/sparklines"},{"label":"Get Page Details Web Vitals trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpagedetailspagewebvitalstrends","routeSlug":"/openapi/combined.openapi/page-details-report/getpagedetailspagewebvitalstrends","metadata":{"seo":{"title":"Get Page Details Web Vitals trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/trends/web-vitals"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageDetailsPageWebVitalsTrends","name":"Get Page Details Web Vitals trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1trends~1web-vitals/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Page Details Web Vitals trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/trends/web-vitals"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1trends~1web-vitals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/trends/web-vitals","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/trends/web-vitals","href":"page-details-report/getpagedetailspagewebvitalstrends","openApiOperationId":"getPageDetailsPageWebVitalsTrends","summary":"Get Page Details Web Vitals trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page Details Web Vitals trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageDetails_WebVitalsTrends_Response"}},"schemaId":"components/schemas/AuditRun_PageDetails_WebVitalsTrends_Response"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1trends~1web-vitals/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_PageDetails_WebVitalsTrends_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageDetails_WebVitalsTrends_Response"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpagedetailspagewebvitalstrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/trends/web-vitals"},{"label":"Return specific insight trend on a given page for all runs in the given duration (days)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpageinsighttrend","routeSlug":"/openapi/combined.openapi/page-details-report/getpageinsighttrend","metadata":{"seo":{"title":"Return specific insight trend on a given page for all runs in the given duration (days)","description":"GET /v3/web-audits/{auditId}/pages/{pageId}/insight-trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageInsightTrend","name":"Return specific insight trend on a given page for all runs in the given duration (days)","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1pages~1{pageId}~1insight-trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return specific insight trend on a given page for all runs in the given duration (days)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/insight-trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true},{"name":"trendName","in":"path","schemaId":"schema_629","description":"name of the insight trend type","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1pages~1{pageId}~1insight-trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"day","in":"query","schemaId":"schema_630","description":"how many days of run records should be included","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1pages~1{pageId}~1insight-trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/pages/{pageId}/insight-trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"},{"name":"trendName","in":"path","required":true,"example":"pageSize","schemaId":"components/schemas/AuditRun_PageDetails_TrendsEnum"}],"query":[{"name":"day","in":"query","required":true,"example":120,"schemaId":"schema_630"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/pages/{pageId}/insight-trends/{trendName}","href":"page-details-report/getpageinsighttrend","openApiOperationId":"getPageInsightTrend","summary":"Return specific insight trend on a given page for all runs in the given duration (days)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A array of page insights","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageTrendsDTO"}},"schemaId":"components/schemas/PageTrendsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1pages~1{pageId}~1insight-trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageTrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageTrendsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpageinsighttrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/pages/{pageId}/insight-trends/{trendName}"},{"label":"Get Page Details Web Vitals specific trend values relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-details-report/getpagedetailspagewebvitalstrend","routeSlug":"/openapi/combined.openapi/page-details-report/getpagedetailspagewebvitalstrend","metadata":{"seo":{"title":"Get Page Details Web Vitals specific trend values relative to current day","description":"GET /v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageDetailsPageWebVitalsTrend","name":"Get Page Details Web Vitals specific trend values relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1pages~1{pageId}~1trends~1web-vitals~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Page Details Web Vitals specific trend values relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/trends/web-vitals/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true},{"name":"trendName","in":"path","schemaId":"schema_631","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1pages~1{pageId}~1trends~1web-vitals~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1pages~1{pageId}~1trends~1web-vitals~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_WebVitalsTrends_Enum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName}","href":"page-details-report/getpagedetailspagewebvitalstrend","openApiOperationId":"getPageDetailsPageWebVitalsTrend","summary":"Get Page Details Web Vitals specific trend values relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page Details Web Vitals specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageDetails_SpecificWebVitalsTrend_Response"}},"schemaId":"components/schemas/AuditRun_PageDetails_SpecificWebVitalsTrend_Response"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1pages~1{pageId}~1trends~1web-vitals~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_PageDetails_SpecificWebVitalsTrend_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageDetails_SpecificWebVitalsTrend_Response"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-details-report/getpagedetailspagewebvitalstrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName}"}],"content":{"contentType":"group","meta":{"name":"page-details-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Page Details Report","showPageActions":true},{"nodeType":"markdoc","content":"Detailed information about specific pages including tags, cookies, request logs, and console logs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/info","summary":"Return specific page information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpageinfo","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}","summary":"Get page links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpagelinks","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download","summary":"Download page links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/downloadpagelinks","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/file-mapping","summary":"Return remote file mapping results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getfilemapping","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/tags","summary":"Return page tag information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpagetags","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies","summary":"Return page cookie information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpagecookies","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/request-log","summary":"Return network requests fired on a given page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpagerequestlog","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators","summary":"Get request initiators info for a given page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/page-details-report/getpageinitiators","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/request-log","summary":"Get requests by HAR entry indices","prefix":{"name":"post","color":"post"},"badges":[],"link":"/page-details-report/getpagerequestsbyharentryindices","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/cookies","summary":"Get cookies for all HAR entries on a page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpagecookiesbyharentryindices","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log-summary","summary":"Return console logs summary on a given page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/page-details-report/getpageconsolelogsummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log","summary":"Return console logs generated on a given page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/page-details-report/getpageconsolelog","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/sparklines","summary":"Return insights on a given page for all runs in the given days","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpagesparklines","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/trends/web-vitals","summary":"Get Page Details Web Vitals trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpagedetailspagewebvitalstrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/pages/{pageId}/insight-trends/{trendName}","summary":"Return specific insight trend on a given page for all runs in the given duration (days)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpageinsighttrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName}","summary":"Get Page Details Web Vitals specific trend values relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-details-report/getpagedetailspagewebvitalstrend","deprecated":false}]}]}]}]}},{"type":"group","label":"Page Summary Report","link":"/openapi/combined.openapi/page-summary-report","routeSlug":"/openapi/combined.openapi/page-summary-report","items":[{"label":"get page summary insights","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-summary-report/getpagesummary","routeSlug":"/openapi/combined.openapi/page-summary-report/getpagesummary","metadata":{"seo":{"title":"get page summary insights","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageSummary","name":"get page summary insights","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"get page summary insights","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/page-summary"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PageSummaryRequestDTO"}},"schemaId":"components/schemas/PageSummaryRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PageSummaryRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary","href":"page-summary-report/getpagesummary","openApiOperationId":"getPageSummary","summary":"get page summary insights"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/PageSummaryRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PageSummaryRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return page summary insights","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageInsightsResponse"}},"schemaId":"components/schemas/PageInsightsResponse"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageInsightsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageInsightsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-summary-report/getpagesummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary"},{"label":"Get insights by page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-summary-report/getpagesummarybypage","routeSlug":"/openapi/combined.openapi/page-summary-report/getpagesummarybypage","metadata":{"seo":{"title":"Get insights by page","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageSummaryByPage","name":"Get insights by page","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get insights by page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/page-summary/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_632"},{"name":"sortBy","in":"query","schemaId":"schema_633"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PageSummaryRequestDTO"}},"schemaId":"components/schemas/PageSummaryRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1pages/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_632"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_PageSummary_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PageSummaryRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/pages","href":"page-summary-report/getpagesummarybypage","openApiOperationId":"getPageSummaryByPage","summary":"Get insights by page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/PageSummaryRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PageSummaryRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return insights by page","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageSummaryPagesDTO"}},"schemaId":"components/schemas/PageSummaryPagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageSummaryPagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageSummaryPagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-summary-report/getpagesummarybypage"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/pages"},{"label":"Return insights for all runs in the given duration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-summary-report/getpagesummarytrends","routeSlug":"/openapi/combined.openapi/page-summary-report/getpagesummarytrends","metadata":{"seo":{"title":"Return insights for all runs in the given duration","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageSummaryTrends","name":"Return insights for all runs in the given duration","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return insights for all runs in the given duration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/page-summary/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends","href":"page-summary-report/getpagesummarytrends","openApiOperationId":"getPageSummaryTrends","summary":"Return insights for all runs in the given duration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Insights by runId","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageSummarySparkLinesDTO"}},"schemaId":"components/schemas/PageSummarySparkLinesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageSummarySparkLinesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageSummarySparkLinesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-summary-report/getpagesummarytrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends"},{"label":"Get Page Summary Web Vitals trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-summary-report/getpagesummarywebvitalstrends","routeSlug":"/openapi/combined.openapi/page-summary-report/getpagesummarywebvitalstrends","metadata":{"seo":{"title":"Get Page Summary Web Vitals trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends/web-vitals"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageSummaryWebVitalsTrends","name":"Get Page Summary Web Vitals trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1trends~1web-vitals/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Page Summary Web Vitals trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/page-summary/trends/web-vitals"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1trends~1web-vitals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends/web-vitals","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends/web-vitals","href":"page-summary-report/getpagesummarywebvitalstrends","openApiOperationId":"getPageSummaryWebVitalsTrends","summary":"Get Page Summary Web Vitals trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page Summary Web Vitals trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageSummary_WebVitalsTrends_Response"}},"schemaId":"components/schemas/AuditRun_PageSummary_WebVitalsTrends_Response"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1page-summary~1trends~1web-vitals/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_PageSummary_WebVitalsTrends_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageSummary_WebVitalsTrends_Response"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-summary-report/getpagesummarywebvitalstrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends/web-vitals"},{"label":"Return insights on a given page for all runs in the given duration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-summary-report/getpagesummarytrend","routeSlug":"/openapi/combined.openapi/page-summary-report/getpagesummarytrend","metadata":{"seo":{"title":"Return insights on a given page for all runs in the given duration","description":"GET /v3/web-audits/{auditId}/reports/page-summary/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageSummaryTrend","name":"Return insights on a given page for all runs in the given duration","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1page-summary~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return insights on a given page for all runs in the given duration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/page-summary/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get page trend insight from specified time span of audit runs"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_634","description":"name of the insight","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1page-summary~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1page-summary~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/page-summary/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_PageSummary_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/page-summary/trends/{trendName}","href":"page-summary-report/getpagesummarytrend","openApiOperationId":"getPageSummaryTrend","summary":"Return insights on a given page for all runs in the given duration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"list of page insight","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1page-summary~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-summary-report/getpagesummarytrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/page-summary/trends/{trendName}"},{"label":"Get Page Summary Web Vitals specific trend values relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/page-summary-report/getpagesummarywebvitalstrend","routeSlug":"/openapi/combined.openapi/page-summary-report/getpagesummarywebvitalstrend","metadata":{"seo":{"title":"Get Page Summary Web Vitals specific trend values relative to current day","description":"GET /v3/web-audits/{auditId}/reports/page-summary/trends/web-vitals/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageSummaryWebVitalsTrend","name":"Get Page Summary Web Vitals specific trend values relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1page-summary~1trends~1web-vitals~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Page Summary Web Vitals specific trend values relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/page-summary/trends/web-vitals/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_631","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1page-summary~1trends~1web-vitals~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1page-summary~1trends~1web-vitals~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/page-summary/trends/web-vitals/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_WebVitalsTrends_Enum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/page-summary/trends/web-vitals/{trendName}","href":"page-summary-report/getpagesummarywebvitalstrend","openApiOperationId":"getPageSummaryWebVitalsTrend","summary":"Get Page Summary Web Vitals specific trend values relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page Summary Web Vitals specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageSummary_SpecificWebVitalsTrend_Response"}},"schemaId":"components/schemas/AuditRun_PageSummary_SpecificWebVitalsTrend_Response"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1page-summary~1trends~1web-vitals~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_PageSummary_SpecificWebVitalsTrend_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_PageSummary_SpecificWebVitalsTrend_Response"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/page-summary-report/getpagesummarywebvitalstrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/page-summary/trends/web-vitals/{trendName}"}],"content":{"contentType":"group","meta":{"name":"page-summary-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Page Summary Report","showPageActions":true},{"nodeType":"markdoc","content":"Page Summary report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary","summary":"get page summary insights","prefix":{"name":"post","color":"post"},"badges":[],"link":"/page-summary-report/getpagesummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/pages","summary":"Get insights by page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/page-summary-report/getpagesummarybypage","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends","summary":"Return insights for all runs in the given duration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-summary-report/getpagesummarytrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/trends/web-vitals","summary":"Get Page Summary Web Vitals trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-summary-report/getpagesummarywebvitalstrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/page-summary/trends/{trendName}","summary":"Return insights on a given page for all runs in the given duration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-summary-report/getpagesummarytrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/page-summary/trends/web-vitals/{trendName}","summary":"Get Page Summary Web Vitals specific trend values relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/page-summary-report/getpagesummarywebvitalstrend","deprecated":false}]}]}]}]}},{"type":"group","label":"Request Privacy Report","link":"/openapi/combined.openapi/request-privacy-report","routeSlug":"/openapi/combined.openapi/request-privacy-report","items":[{"label":"Get Request Privacy summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacysummary","routeSlug":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacysummary","metadata":{"seo":{"title":"Get Request Privacy summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRequestPrivacySummary","name":"Get Request Privacy summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Request Privacy summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/request-privacy"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy/post/requestBody","description":"Filters applicable to Request Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy","href":"request-privacy-report/getauditrunrequestprivacysummary","openApiOperationId":"getAuditRunRequestPrivacySummary","summary":"Get Request Privacy summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Privacy summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RequestPrivacy_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-privacy-report/getauditrunrequestprivacysummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy"},{"label":"Get Request Privacy trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacytrends","routeSlug":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacytrends","metadata":{"seo":{"title":"Get Request Privacy trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRequestPrivacyTrends","name":"Get Request Privacy trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Request Privacy trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/request-privacy/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/trends","href":"request-privacy-report/getauditrunrequestprivacytrends","openApiOperationId":"getAuditRunRequestPrivacyTrends","summary":"Get Request Privacy trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Privacy trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_TrendsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RequestPrivacy_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_TrendsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-privacy-report/getauditrunrequestprivacytrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/trends"},{"label":"Get Request Privacy specific trend values relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacytrend","routeSlug":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacytrend","metadata":{"seo":{"title":"Get Request Privacy specific trend values relative to current day","description":"GET /v3/web-audits/{auditId}/reports/request-privacy/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRequestPrivacyTrend","name":"Get Request Privacy specific trend values relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1request-privacy~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Request Privacy specific trend values relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/request-privacy/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_635","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1request-privacy~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1request-privacy~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/request-privacy/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_RequestPrivacy_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/request-privacy/trends/{trendName}","href":"request-privacy-report/getauditrunrequestprivacytrend","openApiOperationId":"getAuditRunRequestPrivacyTrend","summary":"Get Request Privacy specific trend values relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Privacy specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1request-privacy~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-privacy-report/getauditrunrequestprivacytrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/request-privacy/trends/{trendName}"},{"label":"Get Request Privacy locations for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacylocations","routeSlug":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacylocations","metadata":{"seo":{"title":"Get Request Privacy locations for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRequestPrivacyLocations","name":"Get Request Privacy locations for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1locations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Request Privacy locations for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/request-privacy/locations"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1locations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1locations/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters applicable to Request Privacy report. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter is not abided by this endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations","href":"request-privacy-report/getauditrunrequestprivacylocations","openApiOperationId":"getAuditRunRequestPrivacyLocations","summary":"Get Request Privacy locations for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Privacy locations data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestLocationsDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestLocationsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1locations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestLocationsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestLocationsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-privacy-report/getauditrunrequestprivacylocations"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations"},{"label":"Get Request Privacy compliance for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacycompliance","routeSlug":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacycompliance","metadata":{"seo":{"title":"Get Request Privacy compliance for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/compliance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRequestPrivacyCompliance","name":"Get Request Privacy compliance for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1compliance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Request Privacy compliance for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/request-privacy/compliance"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1compliance/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_636"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1compliance/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1compliance/post/requestBody","description":"Filters applicable to Request Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/compliance","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestsSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/compliance","href":"request-privacy-report/getauditrunrequestprivacycompliance","openApiOperationId":"getAuditRunRequestPrivacyCompliance","summary":"Get Request Privacy compliance for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Privacy compliance data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestsComplianceDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestsComplianceDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1compliance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestsComplianceDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestsComplianceDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-privacy-report/getauditrunrequestprivacycompliance"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/compliance"},{"label":"Get Request Privacy pages data for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacypages","routeSlug":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacypages","metadata":{"seo":{"title":"Get Request Privacy pages data for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRequestPrivacyPages","name":"Get Request Privacy pages data for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Request Privacy pages data for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/request-privacy/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_637"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1pages/post/requestBody","description":"Filters applicable to Request Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/pages","href":"request-privacy-report/getauditrunrequestprivacypages","openApiOperationId":"getAuditRunRequestPrivacyPages","summary":"Get Request Privacy pages data for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Privacy pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-privacy-report/getauditrunrequestprivacypages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/pages"},{"label":"Get Request Privacy pages data for specific request in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacyrequestpages","routeSlug":"/openapi/combined.openapi/request-privacy-report/getauditrunrequestprivacyrequestpages","metadata":{"seo":{"title":"Get Request Privacy pages data for specific request in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/request-pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRequestPrivacyRequestPages","name":"Get Request Privacy pages data for specific request in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1request-pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Request Privacy pages data for specific request in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/request-privacy/request-pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1request-pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_637"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1request-pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestPagesRequestDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestPagesRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1request-pages/post/requestBody","description":"Filters applicable to Request Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/request-pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestPagesRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/request-pages","href":"request-privacy-report/getauditrunrequestprivacyrequestpages","openApiOperationId":"getAuditRunRequestPrivacyRequestPages","summary":"Get Request Privacy pages data for specific request in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestPagesRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_RequestPagesRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Privacy pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesDTO"}},"schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1request-privacy~1request-pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RequestPrivacy_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-privacy-report/getauditrunrequestprivacyrequestpages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/request-pages"}],"content":{"contentType":"group","meta":{"name":"request-privacy-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Privacy Report","showPageActions":true},{"nodeType":"markdoc","content":"Request Privacy report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy","summary":"Get Request Privacy summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-privacy-report/getauditrunrequestprivacysummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/trends","summary":"Get Request Privacy trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/request-privacy-report/getauditrunrequestprivacytrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/request-privacy/trends/{trendName}","summary":"Get Request Privacy specific trend values relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/request-privacy-report/getauditrunrequestprivacytrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations","summary":"Get Request Privacy locations for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-privacy-report/getauditrunrequestprivacylocations","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/compliance","summary":"Get Request Privacy compliance for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-privacy-report/getauditrunrequestprivacycompliance","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/pages","summary":"Get Request Privacy pages data for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-privacy-report/getauditrunrequestprivacypages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/request-pages","summary":"Get Request Privacy pages data for specific request in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-privacy-report/getauditrunrequestprivacyrequestpages","deprecated":false}]}]}]}]}},{"type":"group","label":"Rule Summary Report","link":"/openapi/combined.openapi/rule-summary-report","routeSlug":"/openapi/combined.openapi/rule-summary-report","items":[{"label":"Get rule summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/rule-summary-report/getauditrunruleresultssummary","routeSlug":"/openapi/combined.openapi/rule-summary-report/getauditrunruleresultssummary","metadata":{"seo":{"title":"Get rule summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRuleResultsSummary","name":"Get rule summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rule summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/rule-summary"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_RequestDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary","href":"rule-summary-report/getauditrunruleresultssummary","openApiOperationId":"getAuditRunRuleResultsSummary","summary":"Get rule summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RuleSummary_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Total Pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rules Applied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rule Instances by Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pages by Rule Status"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleResultsSummaryDTO"}},"schemaId":"components/schemas/AuditRun_RuleResultsSummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RuleResultsSummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleResultsSummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rule-summary-report/getauditrunruleresultssummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary"},{"label":"Get rule status trends for specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/rule-summary-report/getauditrunruleresultstrends","routeSlug":"/openapi/combined.openapi/rule-summary-report/getauditrunruleresultstrends","metadata":{"seo":{"title":"Get rule status trends for specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRuleResultsTrends","name":"Get rule status trends for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rule status trends for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/rule-summary/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/trends","href":"rule-summary-report/getauditrunruleresultstrends","openApiOperationId":"getAuditRunRuleResultsTrends","summary":"Get rule status trends for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audit rule results trends overview (a.k.a. trendlines a.k.a. sparklines) for both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rule Instances by Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pages by Rule Status"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_RuleResults_AllTrendsDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_RuleResults_AllTrendsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RuleSummary_RuleResults_AllTrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_RuleResults_AllTrendsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rule-summary-report/getauditrunruleresultstrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/trends"},{"label":"Get rule results trend values for specified audit run relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/rule-summary-report/getauditrunruleresultstrend","routeSlug":"/openapi/combined.openapi/rule-summary-report/getauditrunruleresultstrend","metadata":{"seo":{"title":"Get rule results trend values for specified audit run relative to current day","description":"GET /v3/web-audits/{auditId}/reports/rule-summary/trends/rule-results"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRuleResultsTrend","name":"Get rule results trend values for specified audit run relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1rule-summary~1trends~1rule-results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rule results trend values for specified audit run relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/rule-summary/trends/rule-results"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1rule-summary~1trends~1rule-results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_638","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1rule-summary~1trends~1rule-results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/rule-summary/trends/rule-results","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_638"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/rule-summary/trends/rule-results","href":"rule-summary-report/getauditrunruleresultstrend","openApiOperationId":"getAuditRunRuleResultsTrend","summary":"Get rule results trend values for specified audit run relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit rule results trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_RuleResultsTrendDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_RuleResultsTrendDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1rule-summary~1trends~1rule-results/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RuleSummary_RuleResultsTrendDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_RuleResultsTrendDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rule-summary-report/getauditrunruleresultstrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/rule-summary/trends/rule-results"},{"label":"Get rule results page count trend values for specified audit run relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/rule-summary-report/getauditrunruleresultspagecounttrend","routeSlug":"/openapi/combined.openapi/rule-summary-report/getauditrunruleresultspagecounttrend","metadata":{"seo":{"title":"Get rule results page count trend values for specified audit run relative to current day","description":"GET /v3/web-audits/{auditId}/reports/rule-summary/trends/page-count"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunRuleResultsPageCountTrend","name":"Get rule results page count trend values for specified audit run relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1rule-summary~1trends~1page-count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rule results page count trend values for specified audit run relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/rule-summary/trends/page-count"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1rule-summary~1trends~1page-count/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_638","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1rule-summary~1trends~1page-count/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/rule-summary/trends/page-count","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_638"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/rule-summary/trends/page-count","href":"rule-summary-report/getauditrunruleresultspagecounttrend","openApiOperationId":"getAuditRunRuleResultsPageCountTrend","summary":"Get rule results page count trend values for specified audit run relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit rule results page count trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_RuleResults_PageCountTrendDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_RuleResults_PageCountTrendDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1rule-summary~1trends~1page-count/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RuleSummary_RuleResults_PageCountTrendDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_RuleResults_PageCountTrendDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rule-summary-report/getauditrunruleresultspagecounttrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/rule-summary/trends/page-count"},{"label":"Get all rules overview for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/rule-summary-report/getauditrunallruleresultsoverview","routeSlug":"/openapi/combined.openapi/rule-summary-report/getauditrunallruleresultsoverview","metadata":{"seo":{"title":"Get all rules overview for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunAllRuleResultsOverview","name":"Get all rules overview for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1rule-results/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all rules overview for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/rule-summary/rule-results"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1rule-results/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1rule-results/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results","href":"rule-summary-report/getauditrunallruleresultsoverview","openApiOperationId":"getAuditRunAllRuleResultsOverview","summary":"Get all rules overview for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rule Details by Page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - all rules overview"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsOverviewDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsOverviewDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1rule-results/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsOverviewDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsOverviewDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rule-summary-report/getauditrunallruleresultsoverview"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results"},{"label":"Get rule details for specified rule within specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/rule-summary-report/getauditrunspecificruleresults","routeSlug":"/openapi/combined.openapi/rule-summary-report/getauditrunspecificruleresults","metadata":{"seo":{"title":"Get rule details for specified rule within specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunSpecificRuleResults","name":"Get rule details for specified rule within specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1rule-results~1{ruleSnapshotId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rule details for specified rule within specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/rule-summary/rule-results/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ruleSnapshotId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"ruleSnapshotId","in":"path","schemaId":"schema_639","description":"Rule snapshot ID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1rule-results~1{ruleSnapshotId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsRequestDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1rule-results~1{ruleSnapshotId}/post/requestBody","description":"Filters (page filtering supported only)"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"ruleSnapshotId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsRequestDTO"}},"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId}","href":"rule-summary-report/getauditrunspecificruleresults","openApiOperationId":"getAuditRunSpecificRuleResults","summary":"Get rule details for specified rule within specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rule Details by Page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - single rule details"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1rule-results~1{ruleSnapshotId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rule-summary-report/getauditrunspecificruleresults"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId}"},{"label":"Get page rule results within specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/rule-summary-report/getauditrunpageruleresults","routeSlug":"/openapi/combined.openapi/rule-summary-report/getauditrunpageruleresults","metadata":{"seo":{"title":"Get page rule results within specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunPageRuleResults","name":"Get page rule results within specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get page rule results within specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/rule-summary/page-rule-results"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_640"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_RuleSummary_AllRules_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results","href":"rule-summary-report/getauditrunpageruleresults","openApiOperationId":"getAuditRunPageRuleResults","summary":"Get page rule results within specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pages list with rule failures (when no specific rule condition/outcome selected)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_PageRuleResultsDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_PageRuleResultsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RuleSummary_PageRuleResultsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_PageRuleResultsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rule-summary-report/getauditrunpageruleresults"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results"},{"label":"Get specific rule page results within specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/rule-summary-report/getauditrunspecificrulepageruleresults","routeSlug":"/openapi/combined.openapi/rule-summary-report/getauditrunspecificrulepageruleresults","metadata":{"seo":{"title":"Get specific rule page results within specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results/{ruleSnapshotId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunSpecificRulePageRuleResults","name":"Get specific rule page results within specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results~1{ruleSnapshotId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specific rule page results within specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/rule-summary/page-rule-results/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ruleSnapshotId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"ruleSnapshotId","in":"path","schemaId":"schema_639","description":"Rule snapshot ID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results~1{ruleSnapshotId}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_641"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results~1{ruleSnapshotId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRulePagesRequestDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRulePagesRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results~1{ruleSnapshotId}/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results/{ruleSnapshotId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"ruleSnapshotId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRule_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRulePagesRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results/{ruleSnapshotId}","href":"rule-summary-report/getauditrunspecificrulepageruleresults","openApiOperationId":"getAuditRunSpecificRulePageRuleResults","summary":"Get specific rule page results within specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRulePagesRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRulePagesRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pages list with rule condition details (when specific rule condition/outcome is selected)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRulePageRuleResultsDTO"}},"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRulePageRuleResultsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1rule-summary~1page-rule-results~1{ruleSnapshotId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRulePageRuleResultsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_RuleSummary_SpecificRulePageRuleResultsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rule-summary-report/getauditrunspecificrulepageruleresults"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results/{ruleSnapshotId}"}],"content":{"contentType":"group","meta":{"name":"rule-summary-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rule Summary Report","showPageActions":true},{"nodeType":"markdoc","content":"Rule Summary report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary","summary":"Get rule summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rule-summary-report/getauditrunruleresultssummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/trends","summary":"Get rule status trends for specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rule-summary-report/getauditrunruleresultstrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/rule-summary/trends/rule-results","summary":"Get rule results trend values for specified audit run relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rule-summary-report/getauditrunruleresultstrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/rule-summary/trends/page-count","summary":"Get rule results page count trend values for specified audit run relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rule-summary-report/getauditrunruleresultspagecounttrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results","summary":"Get all rules overview for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rule-summary-report/getauditrunallruleresultsoverview","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId}","summary":"Get rule details for specified rule within specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rule-summary-report/getauditrunspecificruleresults","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results","summary":"Get page rule results within specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rule-summary-report/getauditrunpageruleresults","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results/{ruleSnapshotId}","summary":"Get specific rule page results within specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rule-summary-report/getauditrunspecificrulepageruleresults","deprecated":false}]}]}]}]}},{"type":"group","label":"Tag Duplicates and Multiples Report","link":"/openapi/combined.openapi/tag-duplicates-and-multiples-report","routeSlug":"/openapi/combined.openapi/tag-duplicates-and-multiples-report","items":[{"label":"Get Tag Duplicates & Multiples summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummary","routeSlug":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummary","metadata":{"seo":{"title":"Get Tag Duplicates & Multiples summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagDuplicatesAndMultiplesSummary","name":"Get Tag Duplicates & Multiples summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Duplicates & Multiples summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-duplicates-and-multiples"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters applicable to Tag Duplicates & Multiples report"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples","href":"tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummary","openApiOperationId":"getAuditRunTagDuplicatesAndMultiplesSummary","summary":"Get Tag Duplicates & Multiples summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag Duplicates & Multiples summary data"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples"},{"label":"Get Tag Duplicates & Multiples trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrends","routeSlug":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrends","metadata":{"seo":{"title":"Get Tag Duplicates & Multiples trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagDuplicatesAndMultiplesTrends","name":"Get Tag Duplicates & Multiples trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Duplicates & Multiples trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-duplicates-and-multiples/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/trends","href":"tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrends","openApiOperationId":"getAuditRunTagDuplicatesAndMultiplesTrends","summary":"Get Tag Duplicates & Multiples trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag Duplicates & Multiples trends data"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/trends"},{"label":"Get Tag Duplicates & Multiples specific trend values relative to current date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrend","routeSlug":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrend","metadata":{"seo":{"title":"Get Tag Duplicates & Multiples specific trend values relative to current date","description":"GET /v3/web-audits/{auditId}/reports/tag-duplicates-and-multiples/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagDuplicatesAndMultiplesTrend","name":"Get Tag Duplicates & Multiples specific trend values relative to current date","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-duplicates-and-multiples~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Duplicates & Multiples specific trend values relative to current date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-duplicates-and-multiples/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_642","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-duplicates-and-multiples~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-duplicates-and-multiples~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/tag-duplicates-and-multiples/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/tag-duplicates-and-multiples/trends/{trendName}","href":"tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrend","openApiOperationId":"getAuditRunTagDuplicatesAndMultiplesTrend","summary":"Get Tag Duplicates & Multiples specific trend values relative to current date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag Duplicates & Multiples specific trend data relative to current date"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-duplicates-and-multiples~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/tag-duplicates-and-multiples/trends/{trendName}"},{"label":"Get Tag Duplicates & Multiples all tags data for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytags","routeSlug":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytags","metadata":{"seo":{"title":"Get Tag Duplicates & Multiples all tags data for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagDuplicatesAndMultiplesSummaryTags","name":"Get Tag Duplicates & Multiples all tags data for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Duplicates & Multiples all tags data for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-duplicates-and-multiples/tags"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1tags/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters applicable to Tag Duplicates & Multiples report"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags","href":"tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytags","openApiOperationId":"getAuditRunTagDuplicatesAndMultiplesSummaryTags","summary":"Get Tag Duplicates & Multiples all tags data for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag Duplicates & Multiples all tags data"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsDTO"}},"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytags"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags"},{"label":"Get Tag Duplicates & Multiples tag accounts for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytagaccounts","routeSlug":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytagaccounts","metadata":{"seo":{"title":"Get Tag Duplicates & Multiples tag accounts for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags/{tagId}/accounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagDuplicatesAndMultiplesSummaryTagAccounts","name":"Get Tag Duplicates & Multiples tag accounts for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1tags~1{tagId}~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Duplicates & Multiples tag accounts for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-duplicates-and-multiples/tags/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{tagId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/accounts"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"tagId","in":"path","schemaId":"schema_643","description":"Tag ID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1tags~1{tagId}~1accounts/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_644"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1tags~1{tagId}~1accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_FilteredRequestDTO"}},"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_FilteredRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1tags~1{tagId}~1accounts/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters applicable to Tag Duplicates & Multiples report"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags/{tagId}/accounts","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"tagId","in":"path","required":true,"schemaId":"components/schemas/TagId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_FilteredRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags/{tagId}/accounts","href":"tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytagaccounts","openApiOperationId":"getAuditRunTagDuplicatesAndMultiplesSummaryTagAccounts","summary":"Get Tag Duplicates & Multiples tag accounts for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_FilteredRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_FilteredRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag Duplicates & Multiples summary data"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsDTO"}},"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1tags~1{tagId}~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytagaccounts"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags/{tagId}/accounts"},{"label":"Get Tag Duplicates & Multiples pages for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplespages","routeSlug":"/openapi/combined.openapi/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplespages","metadata":{"seo":{"title":"Get Tag Duplicates & Multiples pages for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagDuplicatesAndMultiplesPages","name":"Get Tag Duplicates & Multiples pages for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Duplicates & Multiples pages for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-duplicates-and-multiples/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_645"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesRequestDTO"}},"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1pages/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters applicable to Tag Duplicates & Multiples report"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/pages","href":"tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplespages","openApiOperationId":"getAuditRunTagDuplicatesAndMultiplesPages","summary":"Get Tag Duplicates & Multiples pages for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag Duplicates & Multiples page data"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesDTO"}},"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-duplicates-and-multiples~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplespages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/pages"}],"content":{"contentType":"group","meta":{"name":"tag-duplicates-and-multiples-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag Duplicates and Multiples Report","showPageActions":true},{"nodeType":"markdoc","content":"Tag Duplicates and Multiples report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples","summary":"Get Tag Duplicates & Multiples summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/trends","summary":"Get Tag Duplicates & Multiples trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/tag-duplicates-and-multiples/trends/{trendName}","summary":"Get Tag Duplicates & Multiples specific trend values relative to current date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplestrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags","summary":"Get Tag Duplicates & Multiples all tags data for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytags","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/tags/{tagId}/accounts","summary":"Get Tag Duplicates & Multiples tag accounts for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplessummarytagaccounts","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-duplicates-and-multiples/pages","summary":"Get Tag Duplicates & Multiples pages for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-duplicates-and-multiples-report/getauditruntagduplicatesandmultiplespages","deprecated":false}]}]}]}]}},{"type":"group","label":"Tag Health Report","link":"/openapi/combined.openapi/tag-health-report","routeSlug":"/openapi/combined.openapi/tag-health-report","items":[{"label":"Get Tag Health summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthsummary","routeSlug":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthsummary","metadata":{"seo":{"title":"Get Tag Health summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagHealthSummary","name":"Get Tag Health summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Health summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-health"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health/post/requestBody","description":"Filters applicable to Tag Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health","href":"tag-health-report/getauditruntaghealthsummary","openApiOperationId":"getAuditRunTagHealthSummary","summary":"Get Tag Health summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Health summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_TagHealth_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagHealth_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-health-report/getauditruntaghealthsummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health"},{"label":"Get Tag Health trends relative to for specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthtrends","routeSlug":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthtrends","metadata":{"seo":{"title":"Get Tag Health trends relative to for specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagHealthTrends","name":"Get Tag Health trends relative to for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Health trends relative to for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-health/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/trends","href":"tag-health-report/getauditruntaghealthtrends","openApiOperationId":"getAuditRunTagHealthTrends","summary":"Get Tag Health trends relative to for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Health trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_TagHealth_TrendsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagHealth_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_TrendsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-health-report/getauditruntaghealthtrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/trends"},{"label":"Get Tag Health specific trend values relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthtrend","routeSlug":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthtrend","metadata":{"seo":{"title":"Get Tag Health specific trend values relative to current day","description":"GET /v3/web-audits/{auditId}/reports/tag-health/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagHealthTrend","name":"Get Tag Health specific trend values relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-health~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Health specific trend values relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-health/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_646","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-health~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-health~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/tag-health/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_TagHealth_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/tag-health/trends/{trendName}","href":"tag-health-report/getauditruntaghealthtrend","openApiOperationId":"getAuditRunTagHealthTrend","summary":"Get Tag Health specific trend values relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Health specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-health~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-health-report/getauditruntaghealthtrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/tag-health/trends/{trendName}"},{"label":"Get Tag Health all tags list for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthtags","routeSlug":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthtags","metadata":{"seo":{"title":"Get Tag Health all tags list for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagHealthTags","name":"Get Tag Health all tags list for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Health all tags list for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-health/tags"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1tags/post/requestBody","description":"Filters applicable to Tag Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags","href":"tag-health-report/getauditruntaghealthtags","openApiOperationId":"getAuditRunTagHealthTags","summary":"Get Tag Health all tags list for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Health all tags data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_TagListDTO"}},"schemaId":"components/schemas/AuditRun_TagHealth_TagListDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagHealth_TagListDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_TagListDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-health-report/getauditruntaghealthtags"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags"},{"label":"Get Tag Health tag accounts list for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthtagaccounts","routeSlug":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthtagaccounts","metadata":{"seo":{"title":"Get Tag Health tag accounts list for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags/{tagId}/accounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagHealthTagAccounts","name":"Get Tag Health tag accounts list for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1tags~1{tagId}~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Health tag accounts list for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-health/tags/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{tagId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/accounts"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"tagId","in":"path","schemaId":"schema_643","description":"Tag ID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1tags~1{tagId}~1accounts/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_647"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1tags~1{tagId}~1accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_FilteredRequestDTO"}},"schemaId":"components/schemas/AuditRun_TagHealth_FilteredRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1tags~1{tagId}~1accounts/post/requestBody","description":"Filters applicable to Tag Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags/{tagId}/accounts","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"tagId","in":"path","required":true,"schemaId":"components/schemas/TagId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_TagHealth_TagAccountsSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_FilteredRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags/{tagId}/accounts","href":"tag-health-report/getauditruntaghealthtagaccounts","openApiOperationId":"getAuditRunTagHealthTagAccounts","summary":"Get Tag Health tag accounts list for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagHealth_FilteredRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_FilteredRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Health tag accounts data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_TagAccountListDTO"}},"schemaId":"components/schemas/AuditRun_TagHealth_TagAccountListDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1tags~1{tagId}~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagHealth_TagAccountListDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_TagAccountListDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-health-report/getauditruntaghealthtagaccounts"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags/{tagId}/accounts"},{"label":"Get Tag Health page list for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthpages","routeSlug":"/openapi/combined.openapi/tag-health-report/getauditruntaghealthpages","metadata":{"seo":{"title":"Get Tag Health page list for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagHealthPages","name":"Get Tag Health page list for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Health page list for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-health/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_648"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1pages/post/requestBody","description":"Filters applicable to Tag Health report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_TagHealth_PageSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/pages","href":"tag-health-report/getauditruntaghealthpages","openApiOperationId":"getAuditRunTagHealthPages","summary":"Get Tag Health page list for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Health pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_PageListDTO"}},"schemaId":"components/schemas/AuditRun_TagHealth_PageListDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-health~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagHealth_PageListDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagHealth_PageListDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-health-report/getauditruntaghealthpages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/pages"}],"content":{"contentType":"group","meta":{"name":"tag-health-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag Health Report","showPageActions":true},{"nodeType":"markdoc","content":"Tag Health report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health","summary":"Get Tag Health summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-health-report/getauditruntaghealthsummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/trends","summary":"Get Tag Health trends relative to for specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag-health-report/getauditruntaghealthtrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/tag-health/trends/{trendName}","summary":"Get Tag Health specific trend values relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag-health-report/getauditruntaghealthtrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags","summary":"Get Tag Health all tags list for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-health-report/getauditruntaghealthtags","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags/{tagId}/accounts","summary":"Get Tag Health tag accounts list for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-health-report/getauditruntaghealthtagaccounts","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/pages","summary":"Get Tag Health page list for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-health-report/getauditruntaghealthpages","deprecated":false}]}]}]}]}},{"type":"group","label":"Tag Inventory Report","link":"/openapi/combined.openapi/tag-inventory-report","routeSlug":"/openapi/combined.openapi/tag-inventory-report","items":[{"label":"Get Tag Inventory summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorysummary","routeSlug":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorysummary","metadata":{"seo":{"title":"Get Tag Inventory summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagInventorySummary","name":"Get Tag Inventory summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Inventory summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-inventory"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory/post/requestBody","description":"Filters applicable to Tag Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory","href":"tag-inventory-report/getauditruntaginventorysummary","openApiOperationId":"getAuditRunTagInventorySummary","summary":"Get Tag Inventory summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Inventory summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagInventory_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-inventory-report/getauditruntaginventorysummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory"},{"label":"Get Tag Inventory tag categories summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytagcategories","routeSlug":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytagcategories","metadata":{"seo":{"title":"Get Tag Inventory tag categories summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tag-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagInventoryTagCategories","name":"Get Tag Inventory tag categories summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tag-categories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Inventory tag categories summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-inventory/tag-categories"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tag-categories/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tag-categories/post/requestBody","description":"Filters applicable to Tag Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tag-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tag-categories","href":"tag-inventory-report/getauditruntaginventorytagcategories","openApiOperationId":"getAuditRunTagInventoryTagCategories","summary":"Get Tag Inventory tag categories summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Inventory tag categories summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_TagCategoriesSummaryDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_TagCategoriesSummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tag-categories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagInventory_TagCategoriesSummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_TagCategoriesSummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-inventory-report/getauditruntaginventorytagcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tag-categories"},{"label":"Get Tag Inventory trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytrends","routeSlug":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytrends","metadata":{"seo":{"title":"Get Tag Inventory trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagInventoryTrends","name":"Get Tag Inventory trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Inventory trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-inventory/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/trends","href":"tag-inventory-report/getauditruntaginventorytrends","openApiOperationId":"getAuditRunTagInventoryTrends","summary":"Get Tag Inventory trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Inventory trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_TrendsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagInventory_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_TrendsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-inventory-report/getauditruntaginventorytrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/trends"},{"label":"Get Tag Inventory specific trend values relative to current time","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytrend","routeSlug":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytrend","metadata":{"seo":{"title":"Get Tag Inventory specific trend values relative to current time","description":"GET /v3/web-audits/{auditId}/reports/tag-inventory/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagInventoryTrend","name":"Get Tag Inventory specific trend values relative to current time","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-inventory~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Inventory specific trend values relative to current time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-inventory/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_649","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-inventory~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-inventory~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/tag-inventory/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_TagInventory_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/tag-inventory/trends/{trendName}","href":"tag-inventory-report/getauditruntaginventorytrend","openApiOperationId":"getAuditRunTagInventoryTrend","summary":"Get Tag Inventory specific trend values relative to current time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Inventory specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-inventory~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-inventory-report/getauditruntaginventorytrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/tag-inventory/trends/{trendName}"},{"label":"Get Tag Inventory tag presence for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytagpresence","routeSlug":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytagpresence","metadata":{"seo":{"title":"Get Tag Inventory tag presence for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagInventoryTagPresence","name":"Get Tag Inventory tag presence for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Inventory tag presence for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-inventory/tags"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tags/post/requestBody","description":"Filters applicable to Tag Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags","href":"tag-inventory-report/getauditruntaginventorytagpresence","openApiOperationId":"getAuditRunTagInventoryTagPresence","summary":"Get Tag Inventory tag presence for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Inventory tag presence data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_TagPresenceDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_TagPresenceDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagInventory_TagPresenceDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_TagPresenceDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-inventory-report/getauditruntaginventorytagpresence"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags"},{"label":"Get Tag Inventory tag accounts presence for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytagaccountpresence","routeSlug":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorytagaccountpresence","metadata":{"seo":{"title":"Get Tag Inventory tag accounts presence for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags/{tagId}/accounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagInventoryTagAccountPresence","name":"Get Tag Inventory tag accounts presence for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tags~1{tagId}~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Inventory tag accounts presence for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-inventory/tags/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{tagId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/accounts"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"tagId","in":"path","schemaId":"schema_643","description":"Tag ID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tags~1{tagId}~1accounts/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_608"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tags~1{tagId}~1accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_FilteredRequestDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_FilteredRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tags~1{tagId}~1accounts/post/requestBody","description":"Filters applicable to Tag Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags/{tagId}/accounts","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"tagId","in":"path","required":true,"schemaId":"components/schemas/TagId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_608"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_FilteredRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags/{tagId}/accounts","href":"tag-inventory-report/getauditruntaginventorytagaccountpresence","openApiOperationId":"getAuditRunTagInventoryTagAccountPresence","summary":"Get Tag Inventory tag accounts presence for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagInventory_FilteredRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_FilteredRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Inventory specific tag accounts presence data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_TagAccountPresenceDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_TagAccountPresenceDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1tags~1{tagId}~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagInventory_TagAccountPresenceDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_TagAccountPresenceDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-inventory-report/getauditruntaginventorytagaccountpresence"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags/{tagId}/accounts"},{"label":"Get Tag Inventory page info for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorypages","routeSlug":"/openapi/combined.openapi/tag-inventory-report/getauditruntaginventorypages","metadata":{"seo":{"title":"Get Tag Inventory page info for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagInventoryPages","name":"Get Tag Inventory page info for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Inventory page info for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-inventory/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_650"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1pages/post/requestBody","description":"Filters applicable to Tag Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_TagInventory_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/pages","href":"tag-inventory-report/getauditruntaginventorypages","openApiOperationId":"getAuditRunTagInventoryPages","summary":"Get Tag Inventory page info for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Inventory page tag presence data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_PagesDTO"}},"schemaId":"components/schemas/AuditRun_TagInventory_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-inventory~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagInventory_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagInventory_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-inventory-report/getauditruntaginventorypages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/pages"}],"content":{"contentType":"group","meta":{"name":"tag-inventory-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag Inventory Report","showPageActions":true},{"nodeType":"markdoc","content":"Tag Inventory report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory","summary":"Get Tag Inventory summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-inventory-report/getauditruntaginventorysummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tag-categories","summary":"Get Tag Inventory tag categories summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-inventory-report/getauditruntaginventorytagcategories","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/trends","summary":"Get Tag Inventory trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag-inventory-report/getauditruntaginventorytrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/tag-inventory/trends/{trendName}","summary":"Get Tag Inventory specific trend values relative to current time","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag-inventory-report/getauditruntaginventorytrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags","summary":"Get Tag Inventory tag presence for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-inventory-report/getauditruntaginventorytagpresence","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags/{tagId}/accounts","summary":"Get Tag Inventory tag accounts presence for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-inventory-report/getauditruntaginventorytagaccountpresence","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/pages","summary":"Get Tag Inventory page info for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-inventory-report/getauditruntaginventorypages","deprecated":false}]}]}]}]}},{"type":"group","label":"Tag Privacy Report","link":"/openapi/combined.openapi/tag-privacy-report","routeSlug":"/openapi/combined.openapi/tag-privacy-report","items":[{"label":"Get Tag Privacy summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacysummary","routeSlug":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacysummary","metadata":{"seo":{"title":"Get Tag Privacy summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagPrivacySummary","name":"Get Tag Privacy summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Privacy summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-privacy"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy/post/requestBody","description":"Filters applicable to Tag Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy","href":"tag-privacy-report/getauditruntagprivacysummary","openApiOperationId":"getAuditRunTagPrivacySummary","summary":"Get Tag Privacy summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Privacy summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_TagPrivacy_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagPrivacy_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-privacy-report/getauditruntagprivacysummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy"},{"label":"Get Tag Privacy trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacytrends","routeSlug":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacytrends","metadata":{"seo":{"title":"Get Tag Privacy trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagPrivacyTrends","name":"Get Tag Privacy trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Privacy trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-privacy/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/trends","href":"tag-privacy-report/getauditruntagprivacytrends","openApiOperationId":"getAuditRunTagPrivacyTrends","summary":"Get Tag Privacy trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Privacy trends data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_TagPrivacy_TrendsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagPrivacy_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_TrendsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-privacy-report/getauditruntagprivacytrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/trends"},{"label":"Get Tag Privacy specific trend values relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacytrend","routeSlug":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacytrend","metadata":{"seo":{"title":"Get Tag Privacy specific trend values relative to current day","description":"GET /v3/web-audits/{auditId}/reports/tag-privacy/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagPrivacyTrend","name":"Get Tag Privacy specific trend values relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-privacy~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Privacy specific trend values relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-privacy/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_651","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-privacy~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-privacy~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/tag-privacy/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_TagPrivacy_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/tag-privacy/trends/{trendName}","href":"tag-privacy-report/getauditruntagprivacytrend","openApiOperationId":"getAuditRunTagPrivacyTrend","summary":"Get Tag Privacy specific trend values relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Privacy specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1tag-privacy~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-privacy-report/getauditruntagprivacytrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/tag-privacy/trends/{trendName}"},{"label":"Get Tag Privacy compliance for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacycompliance","routeSlug":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacycompliance","metadata":{"seo":{"title":"Get Tag Privacy compliance for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/compliance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagPrivacyCompliance","name":"Get Tag Privacy compliance for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1compliance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Privacy compliance for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-privacy/compliance"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1compliance/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_652"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1compliance/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1compliance/post/requestBody","description":"Filters applicable to Tag Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/compliance","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_TagPrivacy_TagsSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/compliance","href":"tag-privacy-report/getauditruntagprivacycompliance","openApiOperationId":"getAuditRunTagPrivacyCompliance","summary":"Get Tag Privacy compliance for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Privacy compliance data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_TagsComplianceDTO"}},"schemaId":"components/schemas/AuditRun_TagPrivacy_TagsComplianceDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1compliance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagPrivacy_TagsComplianceDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_TagsComplianceDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-privacy-report/getauditruntagprivacycompliance"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/compliance"},{"label":"Get Tag Privacy pages data for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacypages","routeSlug":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacypages","metadata":{"seo":{"title":"Get Tag Privacy pages data for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagPrivacyPages","name":"Get Tag Privacy pages data for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Privacy pages data for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-privacy/pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_653"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO"}},"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1pages/post/requestBody","description":"Filters applicable to Tag Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_TagPrivacy_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/pages","href":"tag-privacy-report/getauditruntagprivacypages","openApiOperationId":"getAuditRunTagPrivacyPages","summary":"Get Tag Privacy pages data for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Privacy pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_PagesDTO"}},"schemaId":"components/schemas/AuditRun_TagPrivacy_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagPrivacy_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-privacy-report/getauditruntagprivacypages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/pages"},{"label":"Get Tag Privacy pages data for specific tag in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacytagpages","routeSlug":"/openapi/combined.openapi/tag-privacy-report/getauditruntagprivacytagpages","metadata":{"seo":{"title":"Get Tag Privacy pages data for specific tag in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/tag-pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunTagPrivacyTagPages","name":"Get Tag Privacy pages data for specific tag in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1tag-pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag Privacy pages data for specific tag in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/tag-privacy/tag-pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1tag-pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_653"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1tag-pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_TagPagesRequestDTO"}},"schemaId":"components/schemas/AuditRun_TagPrivacy_TagPagesRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1tag-pages/post/requestBody","description":"Filters applicable to Tag Privacy report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/tag-pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_TagPrivacy_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_TagPagesRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/tag-pages","href":"tag-privacy-report/getauditruntagprivacytagpages","openApiOperationId":"getAuditRunTagPrivacyTagPages","summary":"Get Tag Privacy pages data for specific tag in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_TagPrivacy_TagPagesRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_TagPagesRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag Privacy pages data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_PagesDTO"}},"schemaId":"components/schemas/AuditRun_TagPrivacy_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1tag-privacy~1tag-pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_TagPrivacy_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_TagPrivacy_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-privacy-report/getauditruntagprivacytagpages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/tag-pages"}],"content":{"contentType":"group","meta":{"name":"tag-privacy-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag Privacy Report","showPageActions":true},{"nodeType":"markdoc","content":"Tag privacy report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy","summary":"Get Tag Privacy summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-privacy-report/getauditruntagprivacysummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/trends","summary":"Get Tag Privacy trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag-privacy-report/getauditruntagprivacytrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/tag-privacy/trends/{trendName}","summary":"Get Tag Privacy specific trend values relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag-privacy-report/getauditruntagprivacytrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/compliance","summary":"Get Tag Privacy compliance for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-privacy-report/getauditruntagprivacycompliance","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/pages","summary":"Get Tag Privacy pages data for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-privacy-report/getauditruntagprivacypages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/tag-pages","summary":"Get Tag Privacy pages data for specific tag in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-privacy-report/getauditruntagprivacytagpages","deprecated":false}]}]}]}]}},{"type":"group","label":"Variable Inventory Report","link":"/openapi/combined.openapi/variable-inventory-report","routeSlug":"/openapi/combined.openapi/variable-inventory-report","items":[{"label":"Get Variable Inventory summary for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorysummary","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorysummary","metadata":{"seo":{"title":"Get Variable Inventory summary for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventorySummary","name":"Get Variable Inventory summary for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Variable Inventory summary for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory/post/requestBody","description":"Filters applicable to Variable Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory","href":"variable-inventory-report/getauditrunvariableinventorysummary","openApiOperationId":"getAuditRunVariableInventorySummary","summary":"Get Variable Inventory summary for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_SummaryDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_VariableInventory_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorysummary"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory"},{"label":"Get Variable Inventory trends relative to specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytrends","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytrends","metadata":{"seo":{"title":"Get Variable Inventory trends relative to specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventoryTrends","name":"Get Variable Inventory trends relative to specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Variable Inventory trends relative to specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/trends","href":"variable-inventory-report/getauditrunvariableinventorytrends","openApiOperationId":"getAuditRunVariableInventoryTrends","summary":"Get Variable Inventory trends relative to specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory summary data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TrendsDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_TrendsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_VariableInventory_TrendsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TrendsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorytrends"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/trends"},{"label":"Get Variable Inventory specific trend values relative to current day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytrend","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytrend","metadata":{"seo":{"title":"Get Variable Inventory specific trend values relative to current day","description":"GET /v3/web-audits/{auditId}/reports/variable-inventory/trends/{trendName}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventoryTrend","name":"Get Variable Inventory specific trend values relative to current day","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1variable-inventory~1trends~1{trendName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Variable Inventory specific trend values relative to current day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory/trends/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{trendName}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"trendName","in":"path","schemaId":"schema_654","description":"name of requested trend","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1variable-inventory~1trends~1{trendName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_602","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1variable-inventory~1trends~1{trendName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/reports/variable-inventory/trends/{trendName}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"trendName","in":"path","required":true,"schemaId":"components/schemas/AuditRun_VariableInventory_TrendsEnum"}],"query":[{"name":"days","in":"query","required":true,"schemaId":"schema_602"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/web-audits/{auditId}/reports/variable-inventory/trends/{trendName}","href":"variable-inventory-report/getauditrunvariableinventorytrend","openApiOperationId":"getAuditRunVariableInventoryTrend","summary":"Get Variable Inventory specific trend values relative to current day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory specific trend values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}},"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1reports~1variable-inventory~1trends~1{trendName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemRun_SpecificTrendValuesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorytrend"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/reports/variable-inventory/trends/{trendName}"},{"label":"Get Variable Inventory tag accounts list for specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccounts","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccounts","metadata":{"seo":{"title":"Get Variable Inventory tag accounts list for specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventoryTagAccounts","name":"Get Variable Inventory tag accounts list for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Variable Inventory tag accounts list for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory/tags"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tags/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_608"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tags/post/requestBody","description":"Filters applicable to Variable Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tags","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_608"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tags","href":"variable-inventory-report/getauditrunvariableinventorytagaccounts","openApiOperationId":"getAuditRunVariableInventoryTagAccounts","summary":"Get Variable Inventory tag accounts list for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory tag accounts list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagsDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_TagsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_VariableInventory_TagsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorytagaccounts"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tags"},{"label":"Get top 500 variables sorted by variableSetPageCount","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariables","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariables","metadata":{"seo":{"title":"Get top 500 variables sorted by variableSetPageCount","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variables"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventoryTagAccountVariables","name":"Get top 500 variables sorted by variableSetPageCount","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variables/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get top 500 variables sorted by variableSetPageCount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory/tag-account-variables"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint will only return top 500 variables which are sort by variableSetPageCount (Desc)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variables/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variables/post/requestBody","description":"Filters applicable to Variable Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variables","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variables","href":"variable-inventory-report/getauditrunvariableinventorytagaccountvariables","openApiOperationId":"getAuditRunVariableInventoryTagAccountVariables","summary":"Get top 500 variables sorted by variableSetPageCount"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory tag account variables list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariablesDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariablesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variables/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariablesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariablesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariables"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variables"},{"label":"Get Variable Inventory page list for specific tag account in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountpages","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountpages","metadata":{"seo":{"title":"Get Variable Inventory page list for specific tag account in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventoryTagAccountPages","name":"Get Variable Inventory page list for specific tag account in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Variable Inventory page list for specific tag account in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory/tag-account-pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_655"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-pages/post/requestBody","description":"Filters applicable to Variable Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_VariableInventory_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-pages","href":"variable-inventory-report/getauditrunvariableinventorytagaccountpages","openApiOperationId":"getAuditRunVariableInventoryTagAccountPages","summary":"Get Variable Inventory page list for specific tag account in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory - page list for specified tag account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_PagesDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_VariableInventory_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorytagaccountpages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-pages"},{"label":"Get Variable Inventory page list for specific tag account variable in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariablepages","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariablepages","metadata":{"seo":{"title":"Get Variable Inventory page list for specific tag account variable in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventoryTagAccountVariablePages","name":"Get Variable Inventory page list for specific tag account variable in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Variable Inventory page list for specific tag account variable in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory/tag-account-variable-pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_655"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-pages/post/requestBody","description":"Filters applicable to Variable Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_VariableInventory_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-pages","href":"variable-inventory-report/getauditrunvariableinventorytagaccountvariablepages","openApiOperationId":"getAuditRunVariableInventoryTagAccountVariablePages","summary":"Get Variable Inventory page list for specific tag account variable in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory - page list for specified tag account variable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_PagesDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_PagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_VariableInventory_PagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_PagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariablepages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-pages"},{"label":"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","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariablenotsetpages","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariablenotsetpages","metadata":{"seo":{"title":"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","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-not-set-pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventoryTagAccountVariableNotSetPages","name":"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","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-not-set-pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"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","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory/tag-account-variable-not-set-pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-not-set-pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_655"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-not-set-pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-not-set-pages/post/requestBody","description":"Filters applicable to Variable Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-not-set-pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_VariableInventory_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-not-set-pages","href":"variable-inventory-report/getauditrunvariableinventorytagaccountvariablenotsetpages","openApiOperationId":"getAuditRunVariableInventoryTagAccountVariableNotSetPages","summary":"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"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory tag account variable not set pages list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_VariableNotSetPagesDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_VariableNotSetPagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-not-set-pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_VariableInventory_VariableNotSetPagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_VariableNotSetPagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariablenotsetpages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-not-set-pages"},{"label":"Get Variable Inventory unique values list for specific tag account variable in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariableuniquevalues","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariableuniquevalues","metadata":{"seo":{"title":"Get Variable Inventory unique values list for specific tag account variable in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-values"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventoryTagAccountVariableUniqueValues","name":"Get Variable Inventory unique values list for specific tag account variable in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-values/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Variable Inventory unique values list for specific tag account variable in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory/tag-account-variable-values"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-values/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_656"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-values/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-values/post/requestBody","description":"Filters applicable to Variable Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-values","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_VariableInventory_VariableValuesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-values","href":"variable-inventory-report/getauditrunvariableinventorytagaccountvariableuniquevalues","openApiOperationId":"getAuditRunVariableInventoryTagAccountVariableUniqueValues","summary":"Get Variable Inventory unique values list for specific tag account variable in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory tag account variable unique values list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_UniqueVariableValuesDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_UniqueVariableValuesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-values/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_VariableInventory_UniqueVariableValuesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_UniqueVariableValuesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariableuniquevalues"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-values"},{"label":"Get Variable Inventory page list for specific tag account variable value in specified audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariablevaluepages","routeSlug":"/openapi/combined.openapi/variable-inventory-report/getauditrunvariableinventorytagaccountvariablevaluepages","metadata":{"seo":{"title":"Get Variable Inventory page list for specific tag account variable value in specified audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-value-pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunVariableInventoryTagAccountVariableValuePages","name":"Get Variable Inventory page list for specific tag account variable value in specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-value-pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Variable Inventory page list for specific tag account variable value in specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/variable-inventory/tag-account-variable-value-pages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-value-pages/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_655"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-value-pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableValueRequestDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableValueRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-value-pages/post/requestBody","description":"Filters applicable to Variable Inventory report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-value-pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_VariableInventory_PagesSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableValueRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-value-pages","href":"variable-inventory-report/getauditrunvariableinventorytagaccountvariablevaluepages","openApiOperationId":"getAuditRunVariableInventoryTagAccountVariableValuePages","summary":"Get Variable Inventory page list for specific tag account variable value in specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableValueRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_TagAccountVariableValueRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Variable Inventory tag account variable pages list with unique variable values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_VariableValuePagesDTO"}},"schemaId":"components/schemas/AuditRun_VariableInventory_VariableValuePagesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1variable-inventory~1tag-account-variable-value-pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_VariableInventory_VariableValuePagesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_VariableInventory_VariableValuePagesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariablevaluepages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-value-pages"}],"content":{"contentType":"group","meta":{"name":"variable-inventory-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Variable Inventory Report","showPageActions":true},{"nodeType":"markdoc","content":"Variable Inventory report endpoints"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory","summary":"Get Variable Inventory summary for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorysummary","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/trends","summary":"Get Variable Inventory trends relative to specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorytrends","deprecated":false},{"title":"/v3/web-audits/{auditId}/reports/variable-inventory/trends/{trendName}","summary":"Get Variable Inventory specific trend values relative to current day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorytrend","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tags","summary":"Get Variable Inventory tag accounts list for specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorytagaccounts","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variables","summary":"Get top 500 variables sorted by variableSetPageCount","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariables","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-pages","summary":"Get Variable Inventory page list for specific tag account in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorytagaccountpages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-pages","summary":"Get Variable Inventory page list for specific tag account variable in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariablepages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-not-set-pages","summary":"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","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariablenotsetpages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-values","summary":"Get Variable Inventory unique values list for specific tag account variable in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariableuniquevalues","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory/tag-account-variable-value-pages","summary":"Get Variable Inventory page list for specific tag account variable value in specified audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-inventory-report/getauditrunvariableinventorytagaccountvariablevaluepages","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit Run Data","link":"/openapi/combined.openapi/web-audits","routeSlug":"/openapi/combined.openapi/web-audits","items":[{"label":"Get scores for specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-audits/getauditrunscores","routeSlug":"/openapi/combined.openapi/web-audits/getauditrunscores","metadata":{"seo":{"title":"Get scores for specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/scores"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunScores","name":"Get scores for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1scores/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get scores for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/scores"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1scores/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/scores","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/scores","href":"web-audits/getauditrunscores","openApiOperationId":"getAuditRunScores","summary":"Get scores for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit scores data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_ScoresDTO"}},"schemaId":"components/schemas/AuditRun_AuditSummary_ScoresDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1scores/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_AuditSummary_ScoresDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_AuditSummary_ScoresDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-audits/getauditrunscores"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/scores"},{"label":"Return pages found in the run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-audits/getauditrunpages","routeSlug":"/openapi/combined.openapi/web-audits/getauditrunpages","metadata":{"seo":{"title":"Return pages found in the run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunPages","name":"Return pages found in the run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return pages found in the run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all the pages in a given audit run"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_657"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AuditRun_PagesSort"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages","href":"web-audits/getauditrunpages","openApiOperationId":"getAuditRunPages","summary":"Return pages found in the run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of unique pages found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_Pages_DTO"}},"schemaId":"components/schemas/AuditRun_Pages_DTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_Pages_DTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_Pages_DTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-audits/getauditrunpages"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages"},{"label":"Return a list of unique cookies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-audits/getcookies","routeSlug":"/openapi/combined.openapi/web-audits/getcookies","metadata":{"seo":{"title":"Return a list of unique cookies","description":"GET /v3/web-audits/{auditId}/runs/{runId}/cookies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCookies","name":"Return a list of unique cookies","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1cookies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a list of unique cookies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/cookies"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all unique cookie name and domain found on all the pages in a given audit run"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1cookies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/cookies","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/cookies","href":"web-audits/getcookies","openApiOperationId":"getCookies","summary":"Return a list of unique cookies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of unique cookies found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}},"schemaId":"schema_658"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1cookies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_658","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-audits/getcookies"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/cookies"},{"label":"Return a list of unique geo-locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-audits/getgeolocation","routeSlug":"/openapi/combined.openapi/web-audits/getgeolocation","metadata":{"seo":{"title":"Return a list of unique geo-locations","description":"GET /v3/web-audits/{auditId}/runs/{runId}/geo-locations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGeoLocation","name":"Return a list of unique geo-locations","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1geo-locations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a list of unique geo-locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/geo-locations"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all unique geo-locations found on all the pages in a given audit run"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1geo-locations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/geo-locations","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/geo-locations","href":"web-audits/getgeolocation","openApiOperationId":"getGeoLocation","summary":"Return a list of unique geo-locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of unique geo-locations found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1geo-locations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-audits/getgeolocation"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/geo-locations"},{"label":"Return a list of unique request-domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-audits/getrequestdomain","routeSlug":"/openapi/combined.openapi/web-audits/getrequestdomain","metadata":{"seo":{"title":"Return a list of unique request-domains","description":"GET /v3/web-audits/{auditId}/runs/{runId}/request-domains"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRequestDomain","name":"Return a list of unique request-domains","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1request-domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a list of unique request-domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/request-domains"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all unique request domains found on all the pages in a given audit run"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1request-domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/request-domains","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/request-domains","href":"web-audits/getrequestdomain","openApiOperationId":"getRequestDomain","summary":"Return a list of unique request-domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of request-domains found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RequestDomainDTO"}},"schemaId":"components/schemas/RequestDomainDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1request-domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RequestDomainDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RequestDomainDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-audits/getrequestdomain"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/request-domains"},{"label":"Return a list of pages with JS variables","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-audits/getjavascriptvariables","routeSlug":"/openapi/combined.openapi/web-audits/getjavascriptvariables","metadata":{"seo":{"title":"Return a list of pages with JS variables","description":"GET /v3/web-audits/{auditId}/runs/{runId}/javascript-variables"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJavaScriptVariables","name":"Return a list of pages with JS variables","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1javascript-variables/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a list of pages with JS variables","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/javascript-variables"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all JS variables found on all the pages in a given audit run"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1javascript-variables/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_597","description":"Number of items to be returned at once"},{"name":"startAfterPageId","in":"query","schemaId":"schema_618","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offset result, start from pageId next to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startAfterPageId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch first page, don't supply this parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch subsequent pages, supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.pagination.lastPageId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from previous response"},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1javascript-variables/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/javascript-variables","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"startAfterPageId","in":"query","required":false,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/javascript-variables","href":"web-audits/getjavascriptvariables","openApiOperationId":"getJavaScriptVariables","summary":"Return a list of pages with JS variables"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pages with JS variables","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagesWithJsVariablesDTO"}},"schemaId":"components/schemas/PagesWithJsVariablesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1javascript-variables/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagesWithJsVariablesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagesWithJsVariablesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-audits/getjavascriptvariables"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/javascript-variables"},{"label":"Get run failures summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-audits/getauditfailureresults","routeSlug":"/openapi/combined.openapi/web-audits/getauditfailureresults","metadata":{"seo":{"title":"Get run failures summary","description":"GET /v3/web-audits/{auditId}/runs/{runId}/reports/failures"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditFailureResults","name":"Get run failures summary","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1failures/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get run failures summary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/reports/failures"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a summary of failures for the given run."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failures summary includes details for Pre-Audit Actions, On-Page Actions, all found links excluded and starting URLs navigation results."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1failures/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/reports/failures","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/reports/failures","href":"web-audits/getauditfailureresults","openApiOperationId":"getAuditFailureResults","summary":"Get run failures summary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The result of the execution of the Audit Pre-Audit Actions if any","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditFailureResults"}},"schemaId":"components/schemas/AuditFailureResults"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1reports~1failures/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditFailureResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditFailureResults"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-audits/getauditfailureresults"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/reports/failures"},{"label":"Get audit run page screenshot URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-audits/generateauditrunpagescreenshot","routeSlug":"/openapi/combined.openapi/web-audits/generateauditrunpagescreenshot","metadata":{"seo":{"title":"Get audit run page screenshot URL","description":"GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/screenshot"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateAuditRunPageScreenshot","name":"Get audit run page screenshot URL","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1screenshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get audit run page screenshot URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/pages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/screenshot"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an pre-signed S3 URL for audit run page card"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"pageId","in":"path","schemaId":"schema_618","description":"Unique identification number for web audit run-page, it is different from dcUUID","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1screenshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/screenshot","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"pageId","in":"path","required":true,"example":"f9d32cc7cc2046d6decb145a80289287f5226323","schemaId":"components/schemas/PageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["302","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/screenshot","href":"web-audits/generateauditrunpagescreenshot","openApiOperationId":"generateAuditRunPageScreenshot","summary":"Get audit run page screenshot URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"redirect with pre-signed S3 URL for screenshot of a page of an audit run","headers":{"Location":{"description":"The URL to which the client will be redirected","schema":{"type":"string"}}},"headerSchemaId":"schema_660"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1pages~1{pageId}~1screenshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-audits/generateauditrunpagescreenshot"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/screenshot"}],"content":{"contentType":"group","meta":{"name":"web-audits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit Run Data","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/scores","summary":"Get scores for specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-audits/getauditrunscores","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages","summary":"Return pages found in the run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-audits/getauditrunpages","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/cookies","summary":"Return a list of unique cookies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-audits/getcookies","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/geo-locations","summary":"Return a list of unique geo-locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-audits/getgeolocation","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/request-domains","summary":"Return a list of unique request-domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-audits/getrequestdomain","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/javascript-variables","summary":"Return a list of pages with JS variables","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-audits/getjavascriptvariables","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/reports/failures","summary":"Get run failures summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-audits/getauditfailureresults","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/screenshot","summary":"Get audit run page screenshot URL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-audits/generateauditrunpagescreenshot","deprecated":false}]}]}]}]}},{"type":"separator","label":"Web Journey Reports","content":null},{"type":"group","label":"Web Journey Cookie Report","link":"/openapi/combined.openapi/web-journey-cookie-report","routeSlug":"/openapi/combined.openapi/web-journey-cookie-report","items":[{"label":"Get cookies for action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journey-cookie-report/getwebjourneyactioncookies","routeSlug":"/openapi/combined.openapi/web-journey-cookie-report/getwebjourneyactioncookies","metadata":{"seo":{"title":"Get cookies for action","description":"GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/cookies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyActionCookies","name":"Get cookies for action","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionSequenceId}~1cookies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cookies for action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSequenceId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/cookies"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all cookies affected by the given action"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"actionSequenceId","in":"path","schemaId":"schema_662","description":"Unique identification number for web-journey action","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionSequenceId}~1cookies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/cookies","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"actionSequenceId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/cookies","href":"web-journey-cookie-report/getwebjourneyactioncookies","openApiOperationId":"getWebJourneyActionCookies","summary":"Get cookies for action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookies","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyActionCookiesDTO"}},"schemaId":"components/schemas/WebJourneyActionCookiesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionSequenceId}~1cookies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyActionCookiesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyActionCookiesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journey-cookie-report/getwebjourneyactioncookies"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/cookies"},{"label":"Get cookie origin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journey-cookie-report/getwebjourneyruncookieoriginstory","routeSlug":"/openapi/combined.openapi/web-journey-cookie-report/getwebjourneyruncookieoriginstory","metadata":{"seo":{"title":"Get cookie origin","description":"POST /v3/web-journeys/{webJourneyId}/runs/{runId}/cookies/origin"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyRunCookieOriginStory","name":"Get cookie origin","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1cookies~1origin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cookie origin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/cookies/origin"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the origin story for a cookie"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1cookies~1origin/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CookieOriginRequestDTO"}},"schemaId":"components/schemas/CookieOriginRequestDTO","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1cookies~1origin/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-journeys/{webJourneyId}/runs/{runId}/cookies/origin","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CookieOriginRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/{runId}/cookies/origin","href":"web-journey-cookie-report/getwebjourneyruncookieoriginstory","openApiOperationId":"getWebJourneyRunCookieOriginStory","summary":"Get cookie origin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CookieOriginRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CookieOriginRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of origin story actions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRunCookieOrigin"}},"schemaId":"components/schemas/WebJourneyRunCookieOrigin"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1cookies~1origin/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyRunCookieOrigin","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRunCookieOrigin"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journey-cookie-report/getwebjourneyruncookieoriginstory"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/{runId}/cookies/origin"},{"label":"Get cookie origin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journey-cookie-report/getwebjourneyactioncookieoriginstory","routeSlug":"/openapi/combined.openapi/web-journey-cookie-report/getwebjourneyactioncookieoriginstory","metadata":{"seo":{"title":"Get cookie origin","description":"POST /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionId}/cookies/origin"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyActionCookieOriginStory","name":"Get cookie origin","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionId}~1cookies~1origin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cookie origin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/cookies/origin"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the origin story for a cookie"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"actionId","in":"path","schemaId":"schema_663","description":"Unique identification number for web-journey action","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionId}~1cookies~1origin/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CookieOriginRequestDTO"}},"schemaId":"components/schemas/CookieOriginRequestDTO","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionId}~1cookies~1origin/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionId}/cookies/origin","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"actionId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CookieOriginRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionId}/cookies/origin","href":"web-journey-cookie-report/getwebjourneyactioncookieoriginstory","openApiOperationId":"getWebJourneyActionCookieOriginStory","summary":"Get cookie origin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CookieOriginRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CookieOriginRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of story actions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyResponseCookieOriginDto"}},"schemaId":"components/schemas/WebJourneyResponseCookieOriginDto"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionId}~1cookies~1origin/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyResponseCookieOriginDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyResponseCookieOriginDto"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journey-cookie-report/getwebjourneyactioncookieoriginstory"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionId}/cookies/origin"}],"content":{"contentType":"group","meta":{"name":"web-journey-cookie-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Web Journey Cookie Report","showPageActions":true},{"nodeType":"markdoc","content":"Cookie analysis and reporting for web journeys"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/cookies","summary":"Get cookies for action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journey-cookie-report/getwebjourneyactioncookies","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/runs/{runId}/cookies/origin","summary":"Get cookie origin","prefix":{"name":"post","color":"post"},"badges":[],"link":"/web-journey-cookie-report/getwebjourneyruncookieoriginstory","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionId}/cookies/origin","summary":"Get cookie origin","prefix":{"name":"post","color":"post"},"badges":[],"link":"/web-journey-cookie-report/getwebjourneyactioncookieoriginstory","deprecated":false}]}]}]}]}},{"type":"separator","label":"Exports","content":null},{"type":"group","label":"Account Usage Export","link":"/openapi/combined.openapi/account-usage-export","routeSlug":"/openapi/combined.openapi/account-usage-export","items":[{"label":"Create export for account usage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-usage-export/requestusageexport","routeSlug":"/openapi/combined.openapi/account-usage-export/requestusageexport","metadata":{"seo":{"title":"Create export for account usage","description":"POST /v3/usage/exports/{exportType}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestUsageExport","name":"Create export for account usage","isWebhook":false,"pointer":"/paths/~1v3~1usage~1exports~1{exportType}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create export for account usage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/usage/exports/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{exportType}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"exportType","in":"path","schemaId":"schema_664","description":"Controls accepted values","required":true}],"pointer":"/paths/~1v3~1usage~1exports~1{exportType}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_665"}},"schemaId":"schema_665","pointer":"/paths/~1v3~1usage~1exports~1{exportType}/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/usage/exports/{exportType}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"exportType","in":"path","required":true,"schemaId":"components/schemas/AccountUsageExportTypeEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_665"}},"responseCodes":["201","400","401","404"],"pointer":"/v3/usage/exports/{exportType}","href":"account-usage-export/requestusageexport","openApiOperationId":"requestUsageExport","summary":"Create export for account usage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_665","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_665"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Details of created export","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}},"schemaId":"components/schemas/ExportResultDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1usage~1exports~1{exportType}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ExportResultDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-usage-export/requestusageexport"}],"panels":[]}]},"httpPath":"/v3/usage/exports/{exportType}"}],"content":{"contentType":"group","meta":{"name":"account-usage-export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Usage Export","showPageActions":true},{"nodeType":"markdoc","content":"Export account usage data"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/usage/exports/{exportType}","summary":"Create export for account usage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-usage-export/requestusageexport","deprecated":false}]}]}]}]}},{"type":"group","label":"Alert Export","link":"/openapi/combined.openapi/alert-export","routeSlug":"/openapi/combined.openapi/alert-export","items":[{"label":"Create export for alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alert-export/requestalertexport","routeSlug":"/openapi/combined.openapi/alert-export/requestalertexport","metadata":{"seo":{"title":"Create export for alert","description":"POST /v3/alerts/exports/{exportType}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestAlertExport","name":"Create export for alert","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1exports~1{exportType}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create export for alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/exports/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{exportType}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"exportType","in":"path","schemaId":"schema_666","description":"Controls accepted values","required":true}],"pointer":"/paths/~1v3~1alerts~1exports~1{exportType}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_667"},{"name":"sortBy","in":"query","schemaId":"schema_668","description":"Controls sorting"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"allData","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IF "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" THEN only one results page will be exported ELSE all data will be exported"},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1alerts~1exports~1{exportType}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_669"}},"schemaId":"schema_669","pointer":"/paths/~1v3~1alerts~1exports~1{exportType}/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/alerts/exports/{exportType}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"exportType","in":"path","required":true,"schemaId":"components/schemas/AlertExportTypeEnum"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_667"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_668"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"allData","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_669"}},"responseCodes":["201","400","401","404"],"pointer":"/v3/alerts/exports/{exportType}","href":"alert-export/requestalertexport","openApiOperationId":"requestAlertExport","summary":"Create export for alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_669","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_669"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Details of created export","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}},"schemaId":"components/schemas/ExportResultDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1exports~1{exportType}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ExportResultDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert-export/requestalertexport"}],"panels":[]}]},"httpPath":"/v3/alerts/exports/{exportType}"}],"content":{"contentType":"group","meta":{"name":"alert-export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alert Export","showPageActions":true},{"nodeType":"markdoc","content":"Export alert data"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/alerts/exports/{exportType}","summary":"Create export for alert","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alert-export/requestalertexport","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit Run Export","link":"/openapi/combined.openapi/audit-run-export","routeSlug":"/openapi/combined.openapi/audit-run-export","items":[{"label":"Create export for web audit run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-run-export/requestauditrunexport","routeSlug":"/openapi/combined.openapi/audit-run-export/requestauditrunexport","metadata":{"seo":{"title":"Create export for web audit run","description":"POST /v3/web-audits/{auditId}/runs/{runId}/exports/{exportType}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestAuditRunExport","name":"Create export for web audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1exports~1{exportType}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create export for web audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/exports/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{exportType}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"exportType","in":"path","schemaId":"schema_670","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls accepted values and their bytes for page "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and request body"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1exports~1{exportType}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_671"},{"name":"sortBy","in":"query","schemaId":"schema_672","description":"Controls sorting"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"allData","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IF "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" THEN only one results page will be exported ELSE all data will be exported"},"children":[]}]}]}]},{"name":"noLimit","in":"query","schemaId":"schema_599","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IF "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or not specified THEN export will be limited to 1,000,000 rows ELSE all data will be exported"},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1exports~1{exportType}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_673"}},"schemaId":"schema_673","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1exports~1{exportType}/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/exports/{exportType}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"exportType","in":"path","required":true,"schemaId":"components/schemas/AuditRun_ExportTypeEnum"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_671"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_672"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"allData","in":"query","required":false,"schemaId":"schema_599"},{"name":"noLimit","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_673"}},"responseCodes":["201","400","401","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/exports/{exportType}","href":"audit-run-export/requestauditrunexport","openApiOperationId":"requestAuditRunExport","summary":"Create export for web audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_673","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_673"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Details of created export","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}},"schemaId":"components/schemas/ExportResultDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1exports~1{exportType}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ExportResultDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-run-export/requestauditrunexport"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/exports/{exportType}"}],"content":{"contentType":"group","meta":{"name":"audit-run-export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit Run Export","showPageActions":true},{"nodeType":"markdoc","content":"Export audit run data"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/runs/{runId}/exports/{exportType}","summary":"Create export for web audit run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-run-export/requestauditrunexport","deprecated":false}]}]}]}]}},{"type":"group","label":"Consent Category Export","link":"/openapi/combined.openapi/consent-category-export","routeSlug":"/openapi/combined.openapi/consent-category-export","items":[{"label":"Create export for consent category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-category-export/requestconsentcategoryexport","routeSlug":"/openapi/combined.openapi/consent-category-export/requestconsentcategoryexport","metadata":{"seo":{"title":"Create export for consent category","description":"POST /v3/consent-categories/exports/{exportType}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestConsentCategoryExport","name":"Create export for consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1exports~1{exportType}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create export for consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/exports/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{exportType}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"exportType","in":"path","schemaId":"schema_674","description":"Controls accepted values","required":true}],"pointer":"/paths/~1v3~1consent-categories~1exports~1{exportType}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/consent-categories/exports/{exportType}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"exportType","in":"path","required":true,"schemaId":"components/schemas/ConsentCategory_ExportTypeEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["201","400","401","404"],"pointer":"/v3/consent-categories/exports/{exportType}","href":"consent-category-export/requestconsentcategoryexport","openApiOperationId":"requestConsentCategoryExport","summary":"Create export for consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Details of created export","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}},"schemaId":"components/schemas/ExportResultDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1exports~1{exportType}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ExportResultDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-category-export/requestconsentcategoryexport"}],"panels":[]}]},"httpPath":"/v3/consent-categories/exports/{exportType}"}],"content":{"contentType":"group","meta":{"name":"consent-category-export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consent Category Export","showPageActions":true},{"nodeType":"markdoc","content":"Export consent category data"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/consent-categories/exports/{exportType}","summary":"Create export for consent category","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consent-category-export/requestconsentcategoryexport","deprecated":false}]}]}]}]}},{"type":"group","label":"Exports Center","link":"/openapi/combined.openapi/exports","routeSlug":"/openapi/combined.openapi/exports","items":[{"label":"Get export center exports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/exports/getexportcenterexports","routeSlug":"/openapi/combined.openapi/exports/getexportcenterexports","metadata":{"seo":{"title":"Get export center exports","description":"GET /v3/exports"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExportCenterExports","name":"Get export center exports","isWebhook":false,"pointer":"/paths/~1v3~1exports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get export center exports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/exports"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_675"},{"name":"sortBy","in":"query","schemaId":"schema_676","description":"Controls sorting"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"exportedItemType","in":"query","schemaId":"schema_677","description":"aggregate filter for different export types and item types"},{"name":"search","in":"query","schemaId":"schema_678","description":"Filter by item or export name in \"contains\" mode"},{"name":"requestedByUserId","in":"query","schemaId":"schema_679","description":"Filter by user ID of export requestor"},{"name":"exportIds","in":"query","schemaId":"schema_680","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by a list of one or more export IDs, comma separated (example exportIds=1,2 or exportIds=1)"},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1exports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/exports","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_675"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/ExportCenter_ExportsSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"exportedItemType","in":"query","required":false,"schemaId":"components/schemas/ExportCenter_ExportedItemTypeEnum"},{"name":"search","in":"query","required":false,"example":"my audit","schemaId":"schema_678"},{"name":"requestedByUserId","in":"query","required":false,"example":123,"schemaId":"components/schemas/UserId"},{"name":"exportIds","in":"query","required":false,"schemaId":"schema_680","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/exports","href":"exports/getexportcenterexports","openApiOperationId":"getExportCenterExports","summary":"Get export center exports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Export Center exports","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportCenter_ExportsDTO"}},"schemaId":"components/schemas/ExportCenter_ExportsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1exports/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExportCenter_ExportsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportCenter_ExportsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exports/getexportcenterexports"}],"panels":[]}]},"httpPath":"/v3/exports"},{"label":"Download export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/exports/getexportdownload","routeSlug":"/openapi/combined.openapi/exports/getexportdownload","metadata":{"seo":{"title":"Download export","description":"GET /v3/exports/{exportUuid}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExportDownload","name":"Download export","isWebhook":false,"pointer":"/paths/~1v3~1exports~1{exportUuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/exports/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{exportUuid}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"exportUuid","in":"path","schemaId":"schema_681","description":"UUID of the export file","required":true}],"pointer":"/paths/~1v3~1exports~1{exportUuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/exports/{exportUuid}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"exportUuid","in":"path","required":true,"schemaId":"components/schemas/ExportUuid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["302","404"],"pointer":"/v3/exports/{exportUuid}","href":"exports/getexportdownload","openApiOperationId":"getExportDownload","summary":"Download export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Redirect to presigned export link","headers":{"Location":{"schema":{"type":"string"}}},"headerSchemaId":"schema_682"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1exports~1{exportUuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exports/getexportdownload"}],"panels":[]}]},"httpPath":"/v3/exports/{exportUuid}"}],"content":{"contentType":"group","meta":{"name":"exports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exports Center","showPageActions":true},{"nodeType":"markdoc","content":"Access requested exports status/information"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/exports","summary":"Get export center exports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exports/getexportcenterexports","deprecated":false},{"title":"/v3/exports/{exportUuid}","summary":"Download export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exports/getexportdownload","deprecated":false}]}]}]}]}},{"type":"group","label":"Manual Journey Run Export","link":"/openapi/combined.openapi/manual-journey-run-export","routeSlug":"/openapi/combined.openapi/manual-journey-run-export","items":[{"label":"Create export for manual journey run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/manual-journey-run-export/requestmanualjourneyrunexport","routeSlug":"/openapi/combined.openapi/manual-journey-run-export/requestmanualjourneyrunexport","metadata":{"seo":{"title":"Create export for manual journey run","description":"POST /v3/manual-journeys/{manualJourneyId}/runs/{runId}/exports/{exportType}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestManualJourneyRunExport","name":"Create export for manual journey run","isWebhook":false,"pointer":"/paths/~1v3~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1exports~1{exportType}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create export for manual journey run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/manual-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{manualJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/exports/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{exportType}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"manualJourneyId","in":"path","schemaId":"schema_683","description":"Unique identification number for manual journey","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"exportType","in":"path","schemaId":"schema_684","description":"Controls accepted values","required":true}],"pointer":"/paths/~1v3~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1exports~1{exportType}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManualJourneyRun_ExportRequestDTO"}},"schemaId":"components/schemas/ManualJourneyRun_ExportRequestDTO","pointer":"/paths/~1v3~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1exports~1{exportType}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/manual-journeys/{manualJourneyId}/runs/{runId}/exports/{exportType}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"exportType","in":"path","required":true,"schemaId":"components/schemas/ManualJourneyRun_ExportTypeEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ManualJourneyRun_ExportRequestDTO"}},"responseCodes":["201","400","401","404"],"pointer":"/v3/manual-journeys/{manualJourneyId}/runs/{runId}/exports/{exportType}","href":"manual-journey-run-export/requestmanualjourneyrunexport","openApiOperationId":"requestManualJourneyRunExport","summary":"Create export for manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/ManualJourneyRun_ExportRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManualJourneyRun_ExportRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Details of created export","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}},"schemaId":"components/schemas/ExportResultDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1exports~1{exportType}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ExportResultDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journey-run-export/requestmanualjourneyrunexport"}],"panels":[]}]},"httpPath":"/v3/manual-journeys/{manualJourneyId}/runs/{runId}/exports/{exportType}"}],"content":{"contentType":"group","meta":{"name":"manual-journey-run-export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual Journey Run Export","showPageActions":true},{"nodeType":"markdoc","content":"Export manual journey run data"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/manual-journeys/{manualJourneyId}/runs/{runId}/exports/{exportType}","summary":"Create export for manual journey run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-journey-run-export/requestmanualjourneyrunexport","deprecated":false}]}]}]}]}},{"type":"group","label":"Scheduled Exports","link":"/openapi/combined.openapi/scheduled-exports","routeSlug":"/openapi/combined.openapi/scheduled-exports","items":[{"label":"Get Scheduled Exports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/scheduled-exports/getscheduledexports","routeSlug":"/openapi/combined.openapi/scheduled-exports/getscheduledexports","metadata":{"seo":{"title":"Get Scheduled Exports","description":"GET /v3/exports/scheduled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getScheduledExports","name":"Get Scheduled Exports","isWebhook":false,"pointer":"/paths/~1v3~1exports~1scheduled/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Scheduled Exports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/exports/scheduled"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_627","description":"Return Scheduled Exports which contain the provided text in their name,\nschedule description, owner user name, or exported item name.\n"},{"name":"exportedItemType","in":"query","schemaId":"schema_685","description":"Return Scheduled Exports with specified exported item type."},{"name":"exportedItemId","in":"query","schemaId":"schema_686","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return Scheduled Exports for a specific exported item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportedItemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_687"},{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1exports~1scheduled/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/exports/scheduled","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_627"},{"name":"exportedItemType","in":"query","required":false,"schemaId":"components/schemas/ScheduledExports_ExportedItemType"},{"name":"exportedItemId","in":"query","required":false,"schemaId":"components/schemas/RuleSnapshotId"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/ScheduledExports_SortColumn"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v3/exports/scheduled","href":"scheduled-exports/getscheduledexports","openApiOperationId":"getScheduledExports","summary":"Get Scheduled Exports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of Scheduled Exports","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduledExportListDTO"}},"schemaId":"components/schemas/ScheduledExportListDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1exports~1scheduled/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ScheduledExportListDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduledExportListDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduled-exports/getscheduledexports"}],"panels":[]}]},"httpPath":"/v3/exports/scheduled"},{"label":"Create scheduled export","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/scheduled-exports/createscheduledexport","routeSlug":"/openapi/combined.openapi/scheduled-exports/createscheduledexport","metadata":{"seo":{"title":"Create scheduled export","description":"POST /v3/exports/scheduled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createScheduledExport","name":"Create scheduled export","isWebhook":false,"pointer":"/paths/~1v3~1exports~1scheduled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create scheduled export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/exports/scheduled"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateScheduledExportRequestDTO"}},"schemaId":"components/schemas/CreateScheduledExportRequestDTO","pointer":"/paths/~1v3~1exports~1scheduled/post/requestBody","description":"Scheduled Export definition"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/exports/scheduled","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateScheduledExportRequestDTO"}},"responseCodes":["201","400","401","403"],"pointer":"/v3/exports/scheduled","href":"scheduled-exports/createscheduledexport","openApiOperationId":"createScheduledExport","summary":"Create scheduled export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CreateScheduledExportRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateScheduledExportRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created Scheduled Export","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduledExportDTO"}},"schemaId":"components/schemas/ScheduledExportDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1exports~1scheduled/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ScheduledExportDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduledExportDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduled-exports/createscheduledexport"}],"panels":[]}]},"httpPath":"/v3/exports/scheduled"},{"label":"Get specific Scheduled Export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/scheduled-exports/getscheduledexportbyid","routeSlug":"/openapi/combined.openapi/scheduled-exports/getscheduledexportbyid","metadata":{"seo":{"title":"Get specific Scheduled Export","description":"GET /v3/exports/scheduled/{scheduledExportId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getScheduledExportById","name":"Get specific Scheduled Export","isWebhook":false,"pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specific Scheduled Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/exports/scheduled/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{scheduledExportId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduledExportId","in":"path","schemaId":"schema_688","required":true}],"pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/exports/scheduled/{scheduledExportId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"scheduledExportId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/exports/scheduled/{scheduledExportId}","href":"scheduled-exports/getscheduledexportbyid","openApiOperationId":"getScheduledExportById","summary":"Get specific Scheduled Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Scheduled Export definition","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduledExportDTO"}},"schemaId":"components/schemas/ScheduledExportDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ScheduledExportDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduledExportDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduled-exports/getscheduledexportbyid"}],"panels":[]}]},"httpPath":"/v3/exports/scheduled/{scheduledExportId}"},{"label":"Update specific Scheduled Export","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/scheduled-exports/updatescheduledexportbyid","routeSlug":"/openapi/combined.openapi/scheduled-exports/updatescheduledexportbyid","metadata":{"seo":{"title":"Update specific Scheduled Export","description":"PUT /v3/exports/scheduled/{scheduledExportId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateScheduledExportById","name":"Update specific Scheduled Export","isWebhook":false,"pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update specific Scheduled Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/exports/scheduled/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{scheduledExportId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduledExportId","in":"path","schemaId":"schema_688","required":true}],"pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateScheduledExportRequestDTO"}},"schemaId":"components/schemas/CreateScheduledExportRequestDTO","pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/put/requestBody","description":"Scheduled Export definition"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/exports/scheduled/{scheduledExportId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"scheduledExportId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateScheduledExportRequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/exports/scheduled/{scheduledExportId}","href":"scheduled-exports/updatescheduledexportbyid","openApiOperationId":"updateScheduledExportById","summary":"Update specific Scheduled Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CreateScheduledExportRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateScheduledExportRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Scheduled Export","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduledExportDTO"}},"schemaId":"components/schemas/ScheduledExportDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ScheduledExportDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduledExportDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduled-exports/updatescheduledexportbyid"}],"panels":[]}]},"httpPath":"/v3/exports/scheduled/{scheduledExportId}"},{"label":"Delete specific Scheduled Export","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/scheduled-exports/deletescheduledexportbyid","routeSlug":"/openapi/combined.openapi/scheduled-exports/deletescheduledexportbyid","metadata":{"seo":{"title":"Delete specific Scheduled Export","description":"DELETE /v3/exports/scheduled/{scheduledExportId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteScheduledExportById","name":"Delete specific Scheduled Export","isWebhook":false,"pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete specific Scheduled Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/exports/scheduled/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{scheduledExportId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduledExportId","in":"path","schemaId":"schema_688","required":true}],"pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/exports/scheduled/{scheduledExportId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"scheduledExportId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v3/exports/scheduled/{scheduledExportId}","href":"scheduled-exports/deletescheduledexportbyid","openApiOperationId":"deleteScheduledExportById","summary":"Delete specific Scheduled Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted successfully"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1exports~1scheduled~1{scheduledExportId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduled-exports/deletescheduledexportbyid"}],"panels":[]}]},"httpPath":"/v3/exports/scheduled/{scheduledExportId}"}],"content":{"contentType":"group","meta":{"name":"scheduled-exports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scheduled Exports","showPageActions":true},{"nodeType":"markdoc","content":"Manage scheduled grid report data exports"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/exports/scheduled","summary":"Get Scheduled Exports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scheduled-exports/getscheduledexports","deprecated":false},{"title":"/v3/exports/scheduled","summary":"Create scheduled export","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scheduled-exports/createscheduledexport","deprecated":false},{"title":"/v3/exports/scheduled/{scheduledExportId}","summary":"Get specific Scheduled Export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scheduled-exports/getscheduledexportbyid","deprecated":false},{"title":"/v3/exports/scheduled/{scheduledExportId}","summary":"Update specific Scheduled Export","prefix":{"name":"put","color":"put"},"badges":[],"link":"/scheduled-exports/updatescheduledexportbyid","deprecated":false},{"title":"/v3/exports/scheduled/{scheduledExportId}","summary":"Delete specific Scheduled Export","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/scheduled-exports/deletescheduledexportbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Web Journey Run Export","link":"/openapi/combined.openapi/web-journey-run-export","routeSlug":"/openapi/combined.openapi/web-journey-run-export","items":[{"label":"Create export for web journey run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journey-run-export/requestwebjourneyrunexport","routeSlug":"/openapi/combined.openapi/web-journey-run-export/requestwebjourneyrunexport","metadata":{"seo":{"title":"Create export for web journey run","description":"POST /v3/web-journeys/{webJourneyId}/runs/{runId}/exports/{exportType}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestWebJourneyRunExport","name":"Create export for web journey run","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1exports~1{exportType}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create export for web journey run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/exports/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{exportType}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true},{"name":"exportType","in":"path","schemaId":"schema_689","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1exports~1{exportType}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_690"}},"schemaId":"schema_690","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1exports~1{exportType}/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-journeys/{webJourneyId}/runs/{runId}/exports/{exportType}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"},{"name":"exportType","in":"path","required":true,"schemaId":"components/schemas/WebJourneyRun_ExportTypeEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_690"}},"responseCodes":["201","400","401","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/{runId}/exports/{exportType}","href":"web-journey-run-export/requestwebjourneyrunexport","openApiOperationId":"requestWebJourneyRunExport","summary":"Create export for web journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_690","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_690"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Details of created export","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}},"schemaId":"components/schemas/ExportResultDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1exports~1{exportType}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ExportResultDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportResultDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journey-run-export/requestwebjourneyrunexport"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/{runId}/exports/{exportType}"}],"content":{"contentType":"group","meta":{"name":"web-journey-run-export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Web Journey Run Export","showPageActions":true},{"nodeType":"markdoc","content":"Export web journey run data"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-journeys/{webJourneyId}/runs/{runId}/exports/{exportType}","summary":"Create export for web journey run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/web-journey-run-export/requestwebjourneyrunexport","deprecated":false}]}]}]}]}},{"type":"separator","label":"Alerts","content":null},{"type":"group","label":"Account's Triggered Alerts","link":"/openapi/combined.openapi/account-triggered-alerts","routeSlug":"/openapi/combined.openapi/account-triggered-alerts","items":[{"label":"Get summary for all triggered alerts for the account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-triggered-alerts/getaccounttriggeredalertssummary","routeSlug":"/openapi/combined.openapi/account-triggered-alerts/getaccounttriggeredalertssummary","metadata":{"seo":{"title":"Get summary for all triggered alerts for the account","description":"POST /v3/account-triggered-alerts/summary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountTriggeredAlertsSummary","name":"Get summary for all triggered alerts for the account","isWebhook":false,"pointer":"/paths/~1v3~1account-triggered-alerts~1summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get summary for all triggered alerts for the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/account-triggered-alerts/summary"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO"}},"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO","pointer":"/paths/~1v3~1account-triggered-alerts~1summary/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/account-triggered-alerts/summary","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/account-triggered-alerts/summary","href":"account-triggered-alerts/getaccounttriggeredalertssummary","openApiOperationId":"getAccountTriggeredAlertsSummary","summary":"Get summary for all triggered alerts for the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns account triggered alerts summary","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlerts_SummaryDTO"}},"schemaId":"components/schemas/AccountTriggeredAlerts_SummaryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1account-triggered-alerts~1summary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountTriggeredAlerts_SummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlerts_SummaryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-triggered-alerts/getaccounttriggeredalertssummary"}],"panels":[]}]},"httpPath":"/v3/account-triggered-alerts/summary"},{"label":"Get all triggered alerts for the account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-triggered-alerts/getaccounttriggeredalerts","routeSlug":"/openapi/combined.openapi/account-triggered-alerts/getaccounttriggeredalerts","metadata":{"seo":{"title":"Get all triggered alerts for the account","description":"POST /v3/account-triggered-alerts/alerts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountTriggeredAlerts","name":"Get all triggered alerts for the account","isWebhook":false,"pointer":"/paths/~1v3~1account-triggered-alerts~1alerts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all triggered alerts for the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/account-triggered-alerts/alerts"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_691"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1account-triggered-alerts~1alerts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO"}},"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO","pointer":"/paths/~1v3~1account-triggered-alerts~1alerts/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/account-triggered-alerts/alerts","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/GetAccountTriggeredAlertsSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/account-triggered-alerts/alerts","href":"account-triggered-alerts/getaccounttriggeredalerts","openApiOperationId":"getAccountTriggeredAlerts","summary":"Get all triggered alerts for the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlertsRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns account triggered alerts list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlerts_AlertsDTO"}},"schemaId":"components/schemas/AccountTriggeredAlerts_AlertsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1account-triggered-alerts~1alerts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountTriggeredAlerts_AlertsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlerts_AlertsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-triggered-alerts/getaccounttriggeredalerts"}],"panels":[]}]},"httpPath":"/v3/account-triggered-alerts/alerts"},{"label":"Get information about specific alert from all triggered alerts for the account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-triggered-alerts/getaccounttriggeredspecificalert","routeSlug":"/openapi/combined.openapi/account-triggered-alerts/getaccounttriggeredspecificalert","metadata":{"seo":{"title":"Get information about specific alert from all triggered alerts for the account","description":"POST /v3/account-triggered-alerts/alerts/{alertId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountTriggeredSpecificAlert","name":"Get information about specific alert from all triggered alerts for the account","isWebhook":false,"pointer":"/paths/~1v3~1account-triggered-alerts~1alerts~1{alertId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get information about specific alert from all triggered alerts for the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/account-triggered-alerts/alerts/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{alertId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"alertId","in":"path","schemaId":"schema_600","required":true}],"pointer":"/paths/~1v3~1account-triggered-alerts~1alerts~1{alertId}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_692"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1account-triggered-alerts~1alerts~1{alertId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlertsSpecificAlertRequestDTO"}},"schemaId":"components/schemas/AccountTriggeredAlertsSpecificAlertRequestDTO","pointer":"/paths/~1v3~1account-triggered-alerts~1alerts~1{alertId}/post/requestBody","description":"Filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/account-triggered-alerts/alerts/{alertId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"alertId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/GetAccountTriggeredAlertSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlertsSpecificAlertRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/account-triggered-alerts/alerts/{alertId}","href":"account-triggered-alerts/getaccounttriggeredspecificalert","openApiOperationId":"getAccountTriggeredSpecificAlert","summary":"Get information about specific alert from all triggered alerts for the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AccountTriggeredAlertsSpecificAlertRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlertsSpecificAlertRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns account triggered alerts specific alert details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlerts_DataSourcesDTO"}},"schemaId":"components/schemas/AccountTriggeredAlerts_DataSourcesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1account-triggered-alerts~1alerts~1{alertId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountTriggeredAlerts_DataSourcesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTriggeredAlerts_DataSourcesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-triggered-alerts/getaccounttriggeredspecificalert"}],"panels":[]}]},"httpPath":"/v3/account-triggered-alerts/alerts/{alertId}"}],"content":{"contentType":"group","meta":{"name":"account-triggered-alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account's Triggered Alerts","showPageActions":true},{"nodeType":"markdoc","content":"Account-level triggered alerts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/account-triggered-alerts/summary","summary":"Get summary for all triggered alerts for the account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-triggered-alerts/getaccounttriggeredalertssummary","deprecated":false},{"title":"/v3/account-triggered-alerts/alerts","summary":"Get all triggered alerts for the account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-triggered-alerts/getaccounttriggeredalerts","deprecated":false},{"title":"/v3/account-triggered-alerts/alerts/{alertId}","summary":"Get information about specific alert from all triggered alerts for the account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-triggered-alerts/getaccounttriggeredspecificalert","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Usage Alerts","link":"/openapi/combined.openapi/account-usage-alerts","routeSlug":"/openapi/combined.openapi/account-usage-alerts","items":[{"label":"Get Alert Summary alerts data for account usage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-usage-alerts/getaccountusagealertsummaryalerts","routeSlug":"/openapi/combined.openapi/account-usage-alerts/getaccountusagealertsummaryalerts","metadata":{"seo":{"title":"Get Alert Summary alerts data for account usage","description":"GET /v3/usage/alert-summary/alerts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountUsageAlertSummaryAlerts","name":"Get Alert Summary alerts data for account usage","isWebhook":false,"pointer":"/paths/~1v3~1usage~1alert-summary~1alerts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Alert Summary alerts data for account usage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/usage/alert-summary/alerts"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Alert Summary alerts data for account usage"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/usage/alert-summary/alerts","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/usage/alert-summary/alerts","href":"account-usage-alerts/getaccountusagealertsummaryalerts","openApiOperationId":"getAccountUsageAlertSummaryAlerts","summary":"Get Alert Summary alerts data for account usage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Alert Summary alerts data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsage_AlertSummary_AlertsResponseDTO"}},"schemaId":"components/schemas/AccountUsage_AlertSummary_AlertsResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1usage~1alert-summary~1alerts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountUsage_AlertSummary_AlertsResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsage_AlertSummary_AlertsResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-usage-alerts/getaccountusagealertsummaryalerts"}],"panels":[]}]},"httpPath":"/v3/usage/alert-summary/alerts"}],"content":{"contentType":"group","meta":{"name":"account-usage-alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Usage Alerts","showPageActions":true},{"nodeType":"markdoc","content":"Alerts related to account usage"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/usage/alert-summary/alerts","summary":"Get Alert Summary alerts data for account usage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-usage-alerts/getaccountusagealertsummaryalerts","deprecated":false}]}]}]}]}},{"type":"group","label":"Alerts","link":"/openapi/combined.openapi/alerts","routeSlug":"/openapi/combined.openapi/alerts","items":[{"label":"Create Alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/createalert","routeSlug":"/openapi/combined.openapi/alerts/createalert","metadata":{"seo":{"title":"Create Alert","description":"POST /v3/alerts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAlert","name":"Create Alert","isWebhook":false,"pointer":"/paths/~1v3~1alerts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAlertRequestDTO"}},"schemaId":"components/schemas/CreateAlertRequestDTO","pointer":"/paths/~1v3~1alerts/post/requestBody","description":"Alert definition"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/alerts","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAlertRequestDTO"}},"responseCodes":["201","400","401","403"],"pointer":"/v3/alerts","href":"alerts/createalert","openApiOperationId":"createAlert","summary":"Create Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CreateAlertRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAlertRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAlertResponseDTO"}},"schemaId":"components/schemas/CreateAlertResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateAlertResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAlertResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/createalert"}],"panels":[]}]},"httpPath":"/v3/alerts"},{"label":"Get specific Alert by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/getalertbyid","routeSlug":"/openapi/combined.openapi/alerts/getalertbyid","metadata":{"seo":{"title":"Get specific Alert by ID","description":"GET /v3/alerts/{alertId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlertById","name":"Get specific Alert by ID","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1{alertId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specific Alert by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{alertId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"alertId","in":"path","schemaId":"schema_600","required":true}],"pointer":"/paths/~1v3~1alerts~1{alertId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/alerts/{alertId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"alertId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/alerts/{alertId}","href":"alerts/getalertbyid","openApiOperationId":"getAlertById","summary":"Get specific Alert by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"alert definition","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAlertDefinitionResponseDTO"}},"schemaId":"components/schemas/GetAlertDefinitionResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1{alertId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAlertDefinitionResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAlertDefinitionResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/getalertbyid"}],"panels":[]}]},"httpPath":"/v3/alerts/{alertId}"},{"label":"Update specific Alert","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/updatealertbyid","routeSlug":"/openapi/combined.openapi/alerts/updatealertbyid","metadata":{"seo":{"title":"Update specific Alert","description":"PUT /v3/alerts/{alertId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAlertById","name":"Update specific Alert","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1{alertId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update specific Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{alertId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"alertId","in":"path","schemaId":"schema_600","required":true}],"pointer":"/paths/~1v3~1alerts~1{alertId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAlertRequestDTO"}},"schemaId":"components/schemas/CreateAlertRequestDTO","pointer":"/paths/~1v3~1alerts~1{alertId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/alerts/{alertId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"alertId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAlertRequestDTO"}},"responseCodes":["204","400","401","403","404"],"pointer":"/v3/alerts/{alertId}","href":"alerts/updatealertbyid","openApiOperationId":"updateAlertById","summary":"Update specific Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CreateAlertRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAlertRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"updated successfully"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1{alertId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/updatealertbyid"}],"panels":[]}]},"httpPath":"/v3/alerts/{alertId}"},{"label":"Delete specific Alert","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/deletealertbyid","routeSlug":"/openapi/combined.openapi/alerts/deletealertbyid","metadata":{"seo":{"title":"Delete specific Alert","description":"DELETE /v3/alerts/{alertId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAlertById","name":"Delete specific Alert","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1{alertId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete specific Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{alertId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"alertId","in":"path","schemaId":"schema_600","required":true}],"pointer":"/paths/~1v3~1alerts~1{alertId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/alerts/{alertId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"alertId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/v3/alerts/{alertId}","href":"alerts/deletealertbyid","openApiOperationId":"deleteAlertById","summary":"Delete specific Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"deleted successfully"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1{alertId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/deletealertbyid"}],"panels":[]}]},"httpPath":"/v3/alerts/{alertId}"},{"label":"Update labels for an Alert","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/updatealertlabels","routeSlug":"/openapi/combined.openapi/alerts/updatealertlabels","metadata":{"seo":{"title":"Update labels for an Alert","description":"PUT /v3/alerts/{alertId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAlertLabels","name":"Update labels for an Alert","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1{alertId}~1labels/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update labels for an Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{alertId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/labels"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"alertId","in":"path","schemaId":"schema_600","required":true}],"pointer":"/paths/~1v3~1alerts~1{alertId}~1labels/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_693"}},"schemaId":"schema_693","pointer":"/paths/~1v3~1alerts~1{alertId}~1labels/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/alerts/{alertId}/labels","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"alertId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_693"}},"responseCodes":["204","400","401","403","404"],"pointer":"/v3/alerts/{alertId}/labels","href":"alerts/updatealertlabels","openApiOperationId":"updateAlertLabels","summary":"Update labels for an Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_693","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_693"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"alert labels updated successfully"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1{alertId}~1labels/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/updatealertlabels"}],"panels":[]}]},"httpPath":"/v3/alerts/{alertId}/labels"},{"label":"Get Alerts Library items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/getalertsforlibrary","routeSlug":"/openapi/combined.openapi/alerts/getalertsforlibrary","metadata":{"seo":{"title":"Get Alerts Library items","description":"POST /v3/alerts/library"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlertsForLibrary","name":"Get Alerts Library items","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1library/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Alerts Library items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/library"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_597"},{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"sortBy","in":"query","schemaId":"schema_694"}],"pointer":"/paths/~1v3~1alerts~1library/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetAlertsLibraryRequestDTO"}},"schemaId":"components/schemas/GetAlertsLibraryRequestDTO","pointer":"/paths/~1v3~1alerts~1library/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/alerts/library","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/GetAlertsLibrarySortColumn"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetAlertsLibraryRequestDTO"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/alerts/library","href":"alerts/getalertsforlibrary","openApiOperationId":"getAlertsForLibrary","summary":"Get Alerts Library items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/GetAlertsLibraryRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetAlertsLibraryRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Alerts Library items","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAlertsLibraryResponseDTO"}},"schemaId":"components/schemas/GetAlertsLibraryResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1library/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAlertsLibraryResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAlertsLibraryResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/getalertsforlibrary"}],"panels":[]}]},"httpPath":"/v3/alerts/library"},{"label":"Get Alerts by metric","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/getalertsbymetric","routeSlug":"/openapi/combined.openapi/alerts/getalertsbymetric","metadata":{"seo":{"title":"Get Alerts by metric","description":"GET /v3/alerts/metrics/{metricType}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlertsByMetric","name":"Get Alerts by metric","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1metrics~1{metricType}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Alerts by metric","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/metrics/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{metricType}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"metricType","in":"path","schemaId":"schema_695","required":true}],"pointer":"/paths/~1v3~1alerts~1metrics~1{metricType}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_597"},{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"sortBy","in":"query","schemaId":"schema_696"}],"pointer":"/paths/~1v3~1alerts~1metrics~1{metricType}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/alerts/metrics/{metricType}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"metricType","in":"path","required":true,"schemaId":"components/schemas/AlertMetricTypeEnum"}],"query":[{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/GetAlertsByMetricSortColumn"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/alerts/metrics/{metricType}","href":"alerts/getalertsbymetric","openApiOperationId":"getAlertsByMetric","summary":"Get Alerts by metric"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All alerts in an account with the same metric","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAlertsByMetricResponseDTO"}},"schemaId":"components/schemas/GetAlertsByMetricResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1metrics~1{metricType}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAlertsByMetricResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAlertsByMetricResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/getalertsbymetric"}],"panels":[]}]},"httpPath":"/v3/alerts/metrics/{metricType}"},{"label":"Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/searchtargetitemsforalert","routeSlug":"/openapi/combined.openapi/alerts/searchtargetitemsforalert","metadata":{"seo":{"title":"Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned","description":"POST /v3/alerts/target-items/{itemType}/search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchTargetItemsForAlert","name":"Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1target-items~1{itemType}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/target-items/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{itemType}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/search"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemType","in":"path","schemaId":"schema_697","required":true}],"pointer":"/paths/~1v3~1alerts~1target-items~1{itemType}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_597"},{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"sortBy","in":"query","schemaId":"schema_698"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1alerts~1target-items~1{itemType}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchAlertAssignmentsRequestDTO"}},"schemaId":"components/schemas/SearchAlertAssignmentsRequestDTO","pointer":"/paths/~1v3~1alerts~1target-items~1{itemType}~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/alerts/target-items/{itemType}/search","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"itemType","in":"path","required":true,"schemaId":"components/schemas/AlertAssignmentItemTypeEnum"}],"query":[{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AlertAssignmentsSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchAlertAssignmentsRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/alerts/target-items/{itemType}/search","href":"alerts/searchtargetitemsforalert","openApiOperationId":"searchTargetItemsForAlert","summary":"Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/SearchAlertAssignmentsRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchAlertAssignmentsRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Items (data sources) that may have specified Alert assigned or not assigned","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchAlertAssignmentsResponseDTO"}},"schemaId":"components/schemas/SearchAlertAssignmentsResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1target-items~1{itemType}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchAlertAssignmentsResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchAlertAssignmentsResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/searchtargetitemsforalert"}],"panels":[]}]},"httpPath":"/v3/alerts/target-items/{itemType}/search"},{"label":"Update target items (data sources) that have specified Alert assigned","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/updatetargetitemsofalert","routeSlug":"/openapi/combined.openapi/alerts/updatetargetitemsofalert","metadata":{"seo":{"title":"Update target items (data sources) that have specified Alert assigned","description":"PATCH /v3/alerts/{alertId}/target-items"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTargetItemsOfAlert","name":"Update target items (data sources) that have specified Alert assigned","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1{alertId}~1target-items/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update target items (data sources) that have specified Alert assigned","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{alertId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/target-items"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"alertId","in":"path","schemaId":"schema_600","required":true}],"pointer":"/paths/~1v3~1alerts~1{alertId}~1target-items/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSpecificAlertAssignmentsRequestDTO"}},"schemaId":"components/schemas/UpdateSpecificAlertAssignmentsRequestDTO","pointer":"/paths/~1v3~1alerts~1{alertId}~1target-items/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/alerts/{alertId}/target-items","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"alertId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSpecificAlertAssignmentsRequestDTO"}},"responseCodes":["204","400","401","403","404"],"pointer":"/v3/alerts/{alertId}/target-items","href":"alerts/updatetargetitemsofalert","openApiOperationId":"updateTargetItemsOfAlert","summary":"Update target items (data sources) that have specified Alert assigned"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/UpdateSpecificAlertAssignmentsRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSpecificAlertAssignmentsRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Updated successfully"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1{alertId}~1target-items/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/updatetargetitemsofalert"}],"panels":[]}]},"httpPath":"/v3/alerts/{alertId}/target-items"},{"label":"Search Alerts for assigning them to other items (audits, WJs etc)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/searchalertsforassignment","routeSlug":"/openapi/combined.openapi/alerts/searchalertsforassignment","metadata":{"seo":{"title":"Search Alerts for assigning them to other items (audits, WJs etc)","description":"POST /v3/alerts/search/assignments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchAlertsForAssignment","name":"Search Alerts for assigning them to other items (audits, WJs etc)","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1search~1assignments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Alerts for assigning them to other items (audits, WJs etc)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/search/assignments"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_597"},{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"sortBy","in":"query","schemaId":"schema_699"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1alerts~1search~1assignments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchAlertsForAssignmentRequestDTO"}},"schemaId":"components/schemas/SearchAlertsForAssignmentRequestDTO","pointer":"/paths/~1v3~1alerts~1search~1assignments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/alerts/search/assignments","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/SearchAlertsForAssignmentSortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchAlertsForAssignmentRequestDTO"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/alerts/search/assignments","href":"alerts/searchalertsforassignment","openApiOperationId":"searchAlertsForAssignment","summary":"Search Alerts for assigning them to other items (audits, WJs etc)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/SearchAlertsForAssignmentRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchAlertsForAssignmentRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assignments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchAlertsForAssignmentResponseDTO"}},"schemaId":"components/schemas/SearchAlertsForAssignmentResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1search~1assignments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchAlertsForAssignmentResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchAlertsForAssignmentResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/searchalertsforassignment"}],"panels":[]}]},"httpPath":"/v3/alerts/search/assignments"},{"label":"Update Alerts assigned to specified item (audit, journey etc)","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/alerts/updatealertsassignedtoitem","routeSlug":"/openapi/combined.openapi/alerts/updatealertsassignedtoitem","metadata":{"seo":{"title":"Update Alerts assigned to specified item (audit, journey etc)","description":"PATCH /v3/alerts/assignments/{itemType}/{itemId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAlertsAssignedToItem","name":"Update Alerts assigned to specified item (audit, journey etc)","isWebhook":false,"pointer":"/paths/~1v3~1alerts~1assignments~1{itemType}~1{itemId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Alerts assigned to specified item (audit, journey etc)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/alerts/assignments/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{itemType}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{itemId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemType","in":"path","schemaId":"schema_697","required":true},{"name":"itemId","in":"path","schemaId":"schema_700","required":true}],"pointer":"/paths/~1v3~1alerts~1assignments~1{itemType}~1{itemId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSpecificItemAlertsRequestDTO"}},"schemaId":"components/schemas/UpdateSpecificItemAlertsRequestDTO","pointer":"/paths/~1v3~1alerts~1assignments~1{itemType}~1{itemId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/alerts/assignments/{itemType}/{itemId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"itemType","in":"path","required":true,"schemaId":"components/schemas/AlertAssignmentItemTypeEnum"},{"name":"itemId","in":"path","required":true,"schemaId":"components/schemas/AlertAssignmentItemId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSpecificItemAlertsRequestDTO"}},"responseCodes":["204","400","401","403","404"],"pointer":"/v3/alerts/assignments/{itemType}/{itemId}","href":"alerts/updatealertsassignedtoitem","openApiOperationId":"updateAlertsAssignedToItem","summary":"Update Alerts assigned to specified item (audit, journey etc)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/UpdateSpecificItemAlertsRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSpecificItemAlertsRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"updated successfully"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1alerts~1assignments~1{itemType}~1{itemId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/updatealertsassignedtoitem"}],"panels":[]}]},"httpPath":"/v3/alerts/assignments/{itemType}/{itemId}"}],"content":{"contentType":"group","meta":{"name":"alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alerts","showPageActions":true},{"nodeType":"markdoc","content":"Alert management and configuration"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/alerts","summary":"Create Alert","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/createalert","deprecated":false},{"title":"/v3/alerts/{alertId}","summary":"Get specific Alert by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/getalertbyid","deprecated":false},{"title":"/v3/alerts/{alertId}","summary":"Update specific Alert","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alerts/updatealertbyid","deprecated":false},{"title":"/v3/alerts/{alertId}","summary":"Delete specific Alert","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alerts/deletealertbyid","deprecated":false},{"title":"/v3/alerts/{alertId}/labels","summary":"Update labels for an Alert","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alerts/updatealertlabels","deprecated":false},{"title":"/v3/alerts/library","summary":"Get Alerts Library items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/getalertsforlibrary","deprecated":false},{"title":"/v3/alerts/metrics/{metricType}","summary":"Get Alerts by metric","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/getalertsbymetric","deprecated":false},{"title":"/v3/alerts/target-items/{itemType}/search","summary":"Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/searchtargetitemsforalert","deprecated":false},{"title":"/v3/alerts/{alertId}/target-items","summary":"Update target items (data sources) that have specified Alert assigned","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/alerts/updatetargetitemsofalert","deprecated":false},{"title":"/v3/alerts/search/assignments","summary":"Search Alerts for assigning them to other items (audits, WJs etc)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/searchalertsforassignment","deprecated":false},{"title":"/v3/alerts/assignments/{itemType}/{itemId}","summary":"Update Alerts assigned to specified item (audit, journey etc)","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/alerts/updatealertsassignedtoitem","deprecated":false}]}]}]}]}},{"type":"group","label":"Email Inbox Message Alerts","link":"/openapi/combined.openapi/email-inbox-message-alerts","routeSlug":"/openapi/combined.openapi/email-inbox-message-alerts","items":[{"label":"Get all alerts for selected for email inbox message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-message-alerts/getemailinboxmessagealerts","routeSlug":"/openapi/combined.openapi/email-inbox-message-alerts/getemailinboxmessagealerts","metadata":{"seo":{"title":"Get all alerts for selected for email inbox message","description":"POST /v3/email-inbox-message-alerts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailInboxMessageAlerts","name":"Get all alerts for selected for email inbox message","isWebhook":false,"pointer":"/paths/~1v3~1email-inbox-message-alerts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all alerts for selected for email inbox message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inbox-message-alerts"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailInboxMessageAlertsRequestDTO"}},"schemaId":"components/schemas/EmailInboxMessageAlertsRequestDTO","pointer":"/paths/~1v3~1email-inbox-message-alerts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/email-inbox-message-alerts","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmailInboxMessageAlertsRequestDTO"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/email-inbox-message-alerts","href":"email-inbox-message-alerts/getemailinboxmessagealerts","openApiOperationId":"getEmailInboxMessageAlerts","summary":"Get all alerts for selected for email inbox message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/EmailInboxMessageAlertsRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailInboxMessageAlertsRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All alerts for selected email inbox messages","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxMessageAlertsResponseDTO"}},"schemaId":"components/schemas/EmailInboxMessageAlertsResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inbox-message-alerts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmailInboxMessageAlertsResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxMessageAlertsResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-message-alerts/getemailinboxmessagealerts"}],"panels":[]}]},"httpPath":"/v3/email-inbox-message-alerts"}],"content":{"contentType":"group","meta":{"name":"email-inbox-message-alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Inbox Message Alerts","showPageActions":true},{"nodeType":"markdoc","content":"Email inbox message alerts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/email-inbox-message-alerts","summary":"Get all alerts for selected for email inbox message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-inbox-message-alerts/getemailinboxmessagealerts","deprecated":false}]}]}]}]}},{"type":"separator","label":"Account Usage","content":null},{"type":"group","label":"Account Usage","link":"/openapi/combined.openapi/account-usage-v2","routeSlug":"/openapi/combined.openapi/account-usage-v2","items":[{"label":"Get brief usage overview for account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2overview","routeSlug":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2overview","metadata":{"seo":{"title":"Get brief usage overview for account","description":"GET /v3/usage/overview"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountUsageV2Overview","name":"Get brief usage overview for account","isWebhook":false,"pointer":"/paths/~1v3~1usage~1overview/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get brief usage overview for account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/usage/overview"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/usage/overview","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/usage/overview","href":"account-usage-v2/getaccountusagev2overview","openApiOperationId":"getAccountUsageV2Overview","summary":"Get brief usage overview for account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Usage overview","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_Overview_ResponseDTO"}},"schemaId":"components/schemas/AccountUsageV2_Overview_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1usage~1overview/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountUsageV2_Overview_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_Overview_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-usage-v2/getaccountusagev2overview"}],"panels":[]}]},"httpPath":"/v3/usage/overview"},{"label":"Get not filterable usage summary for account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2notfilterablesummary","routeSlug":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2notfilterablesummary","metadata":{"seo":{"title":"Get not filterable usage summary for account","description":"GET /v3/usage/summary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountUsageV2NotFilterableSummary","name":"Get not filterable usage summary for account","isWebhook":false,"pointer":"/paths/~1v3~1usage~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get not filterable usage summary for account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/usage/summary"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/usage/summary","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/usage/summary","href":"account-usage-v2/getaccountusagev2notfilterablesummary","openApiOperationId":"getAccountUsageV2NotFilterableSummary","summary":"Get not filterable usage summary for account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Basic usage summary","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_Summary_ResponseDTO"}},"schemaId":"components/schemas/AccountUsageV2_Summary_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1usage~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountUsageV2_Summary_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_Summary_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-usage-v2/getaccountusagev2notfilterablesummary"}],"panels":[]}]},"httpPath":"/v3/usage/summary"},{"label":"Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2specificitemtypesummary","routeSlug":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2specificitemtypesummary","metadata":{"seo":{"title":"Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned","description":"POST /v3/usage/{itemType}/summary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountUsageV2SpecificItemTypeSummary","name":"Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned","isWebhook":false,"pointer":"/paths/~1v3~1usage~1{itemType}~1summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/usage/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{itemType}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/summary"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemType","in":"path","schemaId":"schema_701","required":true}],"pointer":"/paths/~1v3~1usage~1{itemType}~1summary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_RequestDTO"}},"schemaId":"components/schemas/AccountUsageV2_RequestDTO","pointer":"/paths/~1v3~1usage~1{itemType}~1summary/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/usage/{itemType}/summary","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"itemType","in":"path","required":true,"schemaId":"components/schemas/AlertAssignmentItemTypeEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_RequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/usage/{itemType}/summary","href":"account-usage-v2/getaccountusagev2specificitemtypesummary","openApiOperationId":"getAccountUsageV2SpecificItemTypeSummary","summary":"Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AccountUsageV2_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specific item type usage summary","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_SpecificItemTypeSummary_ResponseDTO"}},"schemaId":"components/schemas/AccountUsageV2_SpecificItemTypeSummary_ResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1usage~1{itemType}~1summary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountUsageV2_SpecificItemTypeSummary_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_SpecificItemTypeSummary_ResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-usage-v2/getaccountusagev2specificitemtypesummary"}],"panels":[]}]},"httpPath":"/v3/usage/{itemType}/summary"},{"label":"Get usage trends for specified item type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2trends","routeSlug":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2trends","metadata":{"seo":{"title":"Get usage trends for specified item type","description":"POST /v3/usage/{itemType}/trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountUsageV2Trends","name":"Get usage trends for specified item type","isWebhook":false,"pointer":"/paths/~1v3~1usage~1{itemType}~1trends/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get usage trends for specified item type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/usage/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{itemType}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemType","in":"path","schemaId":"schema_701","required":true}],"pointer":"/paths/~1v3~1usage~1{itemType}~1trends/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_RequestDTO"}},"schemaId":"components/schemas/AccountUsageV2_RequestDTO","pointer":"/paths/~1v3~1usage~1{itemType}~1trends/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/usage/{itemType}/trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"itemType","in":"path","required":true,"schemaId":"components/schemas/AlertAssignmentItemTypeEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_RequestDTO"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/usage/{itemType}/trends","href":"account-usage-v2/getaccountusagev2trends","openApiOperationId":"getAccountUsageV2Trends","summary":"Get usage trends for specified item type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AccountUsageV2_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Usage trends","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_Trends_ResponseDTO"}},"schemaId":"components/schemas/AccountUsageV2_Trends_ResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1usage~1{itemType}~1trends/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountUsageV2_Trends_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_Trends_ResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-usage-v2/getaccountusagev2trends"}],"panels":[]}]},"httpPath":"/v3/usage/{itemType}/trends"},{"label":"Get usage trends for rolling week, for specified item type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2dailytrends","routeSlug":"/openapi/combined.openapi/account-usage-v2/getaccountusagev2dailytrends","metadata":{"seo":{"title":"Get usage trends for rolling week, for specified item type","description":"GET /v3/usage/{itemType}/daily-trends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountUsageV2DailyTrends","name":"Get usage trends for rolling week, for specified item type","isWebhook":false,"pointer":"/paths/~1v3~1usage~1{itemType}~1daily-trends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get usage trends for rolling week, for specified item type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/usage/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{itemType}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/daily-trends"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemType","in":"path","schemaId":"schema_701","required":true}],"pointer":"/paths/~1v3~1usage~1{itemType}~1daily-trends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/usage/{itemType}/daily-trends","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"itemType","in":"path","required":true,"schemaId":"components/schemas/AlertAssignmentItemTypeEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/usage/{itemType}/daily-trends","href":"account-usage-v2/getaccountusagev2dailytrends","openApiOperationId":"getAccountUsageV2DailyTrends","summary":"Get usage trends for rolling week, for specified item type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Usage trends","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_DailyTrends_ResponseDTO"}},"schemaId":"components/schemas/AccountUsageV2_DailyTrends_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1usage~1{itemType}~1daily-trends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountUsageV2_DailyTrends_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUsageV2_DailyTrends_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-usage-v2/getaccountusagev2dailytrends"}],"panels":[]}]},"httpPath":"/v3/usage/{itemType}/daily-trends"}],"content":{"contentType":"group","meta":{"name":"account-usage-v2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Usage","showPageActions":true},{"nodeType":"markdoc","content":"Account usage data"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/usage/overview","summary":"Get brief usage overview for account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-usage-v2/getaccountusagev2overview","deprecated":false},{"title":"/v3/usage/summary","summary":"Get not filterable usage summary for account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-usage-v2/getaccountusagev2notfilterablesummary","deprecated":false},{"title":"/v3/usage/{itemType}/summary","summary":"Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-usage-v2/getaccountusagev2specificitemtypesummary","deprecated":false},{"title":"/v3/usage/{itemType}/trends","summary":"Get usage trends for specified item type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-usage-v2/getaccountusagev2trends","deprecated":false},{"title":"/v3/usage/{itemType}/daily-trends","summary":"Get usage trends for rolling week, for specified item type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-usage-v2/getaccountusagev2dailytrends","deprecated":false}]}]}]}]}},{"type":"separator","label":"Email","content":null},{"type":"group","label":"Email Inbox Configuration","link":"/openapi/combined.openapi/email-inbox-configuration","routeSlug":"/openapi/combined.openapi/email-inbox-configuration","items":[{"label":"Add a new Email Inbox","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-configuration/addemailinbox","routeSlug":"/openapi/combined.openapi/email-inbox-configuration/addemailinbox","metadata":{"seo":{"title":"Add a new Email Inbox","description":"POST /v3/email-inboxes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addEmailInbox","name":"Add a new Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a new Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a new Email Inbox"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailInboxRequestDTO"}},"schemaId":"components/schemas/EmailInboxRequestDTO","pointer":"/paths/~1v3~1email-inboxes/post/requestBody","description":"Create a new Email Inbox"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/email-inboxes","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmailInboxRequestDTO"}},"responseCodes":["201","400","401","403"],"pointer":"/v3/email-inboxes","href":"email-inbox-configuration/addemailinbox","openApiOperationId":"addEmailInbox","summary":"Add a new Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/EmailInboxRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailInboxRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxResponseDTO"}},"schemaId":"components/schemas/EmailInboxResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/EmailInboxResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-configuration/addemailinbox"}],"panels":[]}]},"httpPath":"/v3/email-inboxes"},{"label":"Update an existing Email Inbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-configuration/updateemailinbox","routeSlug":"/openapi/combined.openapi/email-inbox-configuration/updateemailinbox","metadata":{"seo":{"title":"Update an existing Email Inbox","description":"PUT /v3/email-inboxes/{emailInboxId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEmailInbox","name":"Update an existing Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing Email Inbox by Id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailInboxRequestDTO"}},"schemaId":"components/schemas/EmailInboxRequestDTO","pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/put/requestBody","description":"Update an existent Email Inbox"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/email-inboxes/{emailInboxId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmailInboxRequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/email-inboxes/{emailInboxId}","href":"email-inbox-configuration/updateemailinbox","openApiOperationId":"updateEmailInbox","summary":"Update an existing Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/EmailInboxRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailInboxRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxResponseDTO"}},"schemaId":"components/schemas/EmailInboxResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmailInboxResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-configuration/updateemailinbox"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}"},{"label":"Delete an Email Inbox","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-configuration/deleteemailinbox","routeSlug":"/openapi/combined.openapi/email-inbox-configuration/deleteemailinbox","metadata":{"seo":{"title":"Delete an Email Inbox","description":"DELETE /v3/email-inboxes/{emailInboxId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmailInbox","name":"Delete an Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete an Email Inbox by Id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/email-inboxes/{emailInboxId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v3/email-inboxes/{emailInboxId}","href":"email-inbox-configuration/deleteemailinbox","openApiOperationId":"deleteEmailInbox","summary":"Delete an Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-configuration/deleteemailinbox"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}"},{"label":"Associate audit configurations with an existing Email Inbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-configuration/addemailinboxconfigurations","routeSlug":"/openapi/combined.openapi/email-inbox-configuration/addemailinboxconfigurations","metadata":{"seo":{"title":"Associate audit configurations with an existing Email Inbox","description":"PUT /v3/email-inboxes/{emailInboxId}/audit-configurations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addEmailInboxConfigurations","name":"Associate audit configurations with an existing Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Associate audit configurations with an existing Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/audit-configurations"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_703"}},"schemaId":"schema_703","pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations/put/requestBody","description":"Update configurations of an existent Email Inbox"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/email-inboxes/{emailInboxId}/audit-configurations","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_703"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/email-inboxes/{emailInboxId}/audit-configurations","href":"email-inbox-configuration/addemailinboxconfigurations","openApiOperationId":"addEmailInboxConfigurations","summary":"Associate audit configurations with an existing Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_703","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_703"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-configuration/addemailinboxconfigurations"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}/audit-configurations"},{"label":"Associate an audit configuration with an existing Email Inbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-configuration/addemailinboxconfiguration","routeSlug":"/openapi/combined.openapi/email-inbox-configuration/addemailinboxconfiguration","metadata":{"seo":{"title":"Associate an audit configuration with an existing Email Inbox","description":"PUT /v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addEmailInboxConfiguration","name":"Associate an audit configuration with an existing Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations~1{auditId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Associate an audit configuration with an existing Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/audit-configurations/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true},{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations~1{auditId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"},{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}","href":"email-inbox-configuration/addemailinboxconfiguration","openApiOperationId":"addEmailInboxConfiguration","summary":"Associate an audit configuration with an existing Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations~1{auditId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-configuration/addemailinboxconfiguration"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}"},{"label":"Delete an audit configuration from an Email Inbox","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-configuration/deleteemailinboxconfiguration","routeSlug":"/openapi/combined.openapi/email-inbox-configuration/deleteemailinboxconfiguration","metadata":{"seo":{"title":"Delete an audit configuration from an Email Inbox","description":"DELETE /v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmailInboxConfiguration","name":"Delete an audit configuration from an Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations~1{auditId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an audit configuration from an Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/audit-configurations/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true},{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations~1{auditId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"},{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}","href":"email-inbox-configuration/deleteemailinboxconfiguration","openApiOperationId":"deleteEmailInboxConfiguration","summary":"Delete an audit configuration from an Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations~1{auditId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-configuration/deleteemailinboxconfiguration"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}"},{"label":"Upsert labels for an existing Email Inbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-configuration/upsertinboxlabels","routeSlug":"/openapi/combined.openapi/email-inbox-configuration/upsertinboxlabels","metadata":{"seo":{"title":"Upsert labels for an existing Email Inbox","description":"PUT /v3/email-inboxes/{emailInboxId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertInboxLabels","name":"Upsert labels for an existing Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1labels/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert labels for an existing Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/labels"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1labels/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_704"}},"schemaId":"schema_704","pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1labels/put/requestBody","description":"Update an existent Email Inbox labels"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/email-inboxes/{emailInboxId}/labels","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_704"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/email-inboxes/{emailInboxId}/labels","href":"email-inbox-configuration/upsertinboxlabels","openApiOperationId":"upsertInboxLabels","summary":"Upsert labels for an existing Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_704","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_704"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}},"schemaId":"schema_705"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1labels/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_705","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-configuration/upsertinboxlabels"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}/labels"},{"label":"Upsert notes for the given Email Inbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-configuration/updateemailinboxnotes","routeSlug":"/openapi/combined.openapi/email-inbox-configuration/updateemailinboxnotes","metadata":{"seo":{"title":"Upsert notes for the given Email Inbox","description":"PUT /v3/email-inboxes/{emailInboxId}/notes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEmailInboxNotes","name":"Upsert notes for the given Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1notes/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert notes for the given Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/notes"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1notes/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_627"}},"schemaId":"schema_627","pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1notes/put/requestBody","description":"Update notes for a given Email Inbox"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/email-inboxes/{emailInboxId}/notes","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"text/plain":{"schemaId":"schema_627"}},"responseCodes":["204","400","401","403","404"],"pointer":"/v3/email-inboxes/{emailInboxId}/notes","href":"email-inbox-configuration/updateemailinboxnotes","openApiOperationId":"updateEmailInboxNotes","summary":"Upsert notes for the given Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_627","mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_627"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_706"}},"schemaId":"schema_706"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1notes/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_706","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_706"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-configuration/updateemailinboxnotes"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}/notes"},{"label":"Cancel all audit runs associated with a given Email Message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-configuration/cancelemailinboxmessageruns","routeSlug":"/openapi/combined.openapi/email-inbox-configuration/cancelemailinboxmessageruns","metadata":{"seo":{"title":"Cancel all audit runs associated with a given Email Message","description":"DELETE /v3/email-inboxes/{emailInboxId}/messages/{receivedEmailMessageId}/runs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelEmailInboxMessageRuns","name":"Cancel all audit runs associated with a given Email Message","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages~1{receivedEmailMessageId}~1runs/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel all audit runs associated with a given Email Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/messages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{receivedEmailMessageId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true},{"name":"receivedEmailMessageId","in":"path","schemaId":"components/schemas/ReceivedEmailMessageId","description":"Unique identification number for received email message record","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages~1{receivedEmailMessageId}~1runs/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/email-inboxes/{emailInboxId}/messages/{receivedEmailMessageId}/runs","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"},{"name":"receivedEmailMessageId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["202","400","401","404"],"pointer":"/v3/email-inboxes/{emailInboxId}/messages/{receivedEmailMessageId}/runs","href":"email-inbox-configuration/cancelemailinboxmessageruns","openApiOperationId":"cancelEmailInboxMessageRuns","summary":"Cancel all audit runs associated with a given Email Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful operation"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages~1{receivedEmailMessageId}~1runs/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-configuration/cancelemailinboxmessageruns"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}/messages/{receivedEmailMessageId}/runs"}],"content":{"contentType":"group","meta":{"name":"email-inbox-configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Inbox Configuration","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing email inbox configurations and setting"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/email-inboxes","summary":"Add a new Email Inbox","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-inbox-configuration/addemailinbox","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}","summary":"Update an existing Email Inbox","prefix":{"name":"put","color":"put"},"badges":[],"link":"/email-inbox-configuration/updateemailinbox","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}","summary":"Delete an Email Inbox","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/email-inbox-configuration/deleteemailinbox","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}/audit-configurations","summary":"Associate audit configurations with an existing Email Inbox","prefix":{"name":"put","color":"put"},"badges":[],"link":"/email-inbox-configuration/addemailinboxconfigurations","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}","summary":"Associate an audit configuration with an existing Email Inbox","prefix":{"name":"put","color":"put"},"badges":[],"link":"/email-inbox-configuration/addemailinboxconfiguration","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}/audit-configurations/{auditId}","summary":"Delete an audit configuration from an Email Inbox","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/email-inbox-configuration/deleteemailinboxconfiguration","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}/labels","summary":"Upsert labels for an existing Email Inbox","prefix":{"name":"put","color":"put"},"badges":[],"link":"/email-inbox-configuration/upsertinboxlabels","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}/notes","summary":"Upsert notes for the given Email Inbox","prefix":{"name":"put","color":"put"},"badges":[],"link":"/email-inbox-configuration/updateemailinboxnotes","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}/messages/{receivedEmailMessageId}/runs","summary":"Cancel all audit runs associated with a given Email Message","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/email-inbox-configuration/cancelemailinboxmessageruns","deprecated":false}]}]}]}]}},{"type":"group","label":"Email Inbox Messages","link":"/openapi/combined.openapi/email-inbox-messages","routeSlug":"/openapi/combined.openapi/email-inbox-messages","items":[{"label":"Get all the details of an email inbox message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inbox-messages/getemailinboxmessagedetails","routeSlug":"/openapi/combined.openapi/email-inbox-messages/getemailinboxmessagedetails","metadata":{"seo":{"title":"Get all the details of an email inbox message","description":"GET /v3/email-inbox-messages/{messageId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailInboxMessageDetails","name":"Get all the details of an email inbox message","isWebhook":false,"pointer":"/paths/~1v3~1email-inbox-messages~1{messageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all the details of an email inbox message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inbox-messages/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{messageId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"messageId","in":"path","schemaId":"schema_707","required":true}],"pointer":"/paths/~1v3~1email-inbox-messages~1{messageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/email-inbox-messages/{messageId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"messageId","in":"path","required":true,"schemaId":"schema_707"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/email-inbox-messages/{messageId}","href":"email-inbox-messages/getemailinboxmessagedetails","openApiOperationId":"getEmailInboxMessageDetails","summary":"Get all the details of an email inbox message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The details of the email inbox message","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxMessageDetailsResponseDTO"}},"schemaId":"components/schemas/EmailInboxMessageDetailsResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inbox-messages~1{messageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmailInboxMessageDetailsResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxMessageDetailsResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inbox-messages/getemailinboxmessagedetails"}],"panels":[]}]},"httpPath":"/v3/email-inbox-messages/{messageId}"}],"content":{"contentType":"group","meta":{"name":"email-inbox-messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Inbox Messages","showPageActions":true},{"nodeType":"markdoc","content":"Get Email Inbox message details"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/email-inbox-messages/{messageId}","summary":"Get all the details of an email inbox message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-inbox-messages/getemailinboxmessagedetails","deprecated":false}]}]}]}]}},{"type":"group","label":"Email Inboxes","link":"/openapi/combined.openapi/email-inboxes","routeSlug":"/openapi/combined.openapi/email-inboxes","items":[{"label":"Return filtered email inboxes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inboxes/getemailinboxes","routeSlug":"/openapi/combined.openapi/email-inboxes/getemailinboxes","metadata":{"seo":{"title":"Return filtered email inboxes","description":"POST /v3/email-inboxes/library"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailInboxes","name":"Return filtered email inboxes","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1library/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return filtered email inboxes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/library"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all email inboxes that meet the filtering criteria"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_708"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1email-inboxes~1library/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailInboxLibraryRequestDTO"}},"schemaId":"components/schemas/EmailInboxLibraryRequestDTO","pointer":"/paths/~1v3~1email-inboxes~1library/post/requestBody","description":"Filter params"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/email-inboxes/library","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/EmailInboxLibrarySortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmailInboxLibraryRequestDTO"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/email-inboxes/library","href":"email-inboxes/getemailinboxes","openApiOperationId":"getEmailInboxes","summary":"Return filtered email inboxes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/EmailInboxLibraryRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailInboxLibraryRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxLibraryResponseDTO"}},"schemaId":"components/schemas/EmailInboxLibraryResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1library/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmailInboxLibraryResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxLibraryResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inboxes/getemailinboxes"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/library"},{"label":"Get Email Inbox by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inboxes/getemailinbox","routeSlug":"/openapi/combined.openapi/email-inboxes/getemailinbox","metadata":{"seo":{"title":"Get Email Inbox by id","description":"GET /v3/email-inboxes/{emailInboxId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailInbox","name":"Get Email Inbox by id","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Email Inbox by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a Email Inbox by id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/email-inboxes/{emailInboxId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/email-inboxes/{emailInboxId}","href":"email-inboxes/getemailinbox","openApiOperationId":"getEmailInbox","summary":"Get Email Inbox by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation, resource found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxResponseDTO"}},"schemaId":"components/schemas/EmailInboxResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmailInboxResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailInboxResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inboxes/getemailinbox"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}"},{"label":"Read the configurations for an Email Inbox by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inboxes/getemailinboxconfigurations","routeSlug":"/openapi/combined.openapi/email-inboxes/getemailinboxconfigurations","metadata":{"seo":{"title":"Read the configurations for an Email Inbox by id","description":"GET /v3/email-inboxes/{emailInboxId}/audit-configurations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailInboxConfigurations","name":"Read the configurations for an Email Inbox by id","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read the configurations for an Email Inbox by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/audit-configurations"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/email-inboxes/{emailInboxId}/audit-configurations","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v3/email-inboxes/{emailInboxId}/audit-configurations","href":"email-inboxes/getemailinboxconfigurations","openApiOperationId":"getEmailInboxConfigurations","summary":"Read the configurations for an Email Inbox by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation, resource found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_709"}},"schemaId":"schema_709"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1audit-configurations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_709","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_709"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inboxes/getemailinboxconfigurations"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}/audit-configurations"},{"label":"Get all email messages associated with a given Email Inbox","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inboxes/getemailinboxmessages","routeSlug":"/openapi/combined.openapi/email-inboxes/getemailinboxmessages","metadata":{"seo":{"title":"Get all email messages associated with a given Email Inbox","description":"GET /v3/email-inboxes/{emailInboxId}/messages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailInboxMessages","name":"Get all email messages associated with a given Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all email messages associated with a given Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/messages"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"emailSubject","in":"query","schemaId":"schema_627","description":"filter Email Messages by email subject"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/email-inboxes/{emailInboxId}/messages","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"emailSubject","in":"query","required":false,"schemaId":"schema_627"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/email-inboxes/{emailInboxId}/messages","href":"email-inboxes/getemailinboxmessages","openApiOperationId":"getEmailInboxMessages","summary":"Get all email messages associated with a given Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReceivedEmailMessageDTO"}},"schemaId":"components/schemas/ReceivedEmailMessageDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReceivedEmailMessageDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReceivedEmailMessageDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inboxes/getemailinboxmessages"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}/messages"},{"label":"Get all email messages statuses associated with a given Email Inbox","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/email-inboxes/getemailinboxmessagesstatuses","routeSlug":"/openapi/combined.openapi/email-inboxes/getemailinboxmessagesstatuses","metadata":{"seo":{"title":"Get all email messages statuses associated with a given Email Inbox","description":"POST /v3/email-inboxes/{emailInboxId}/messages/statuses"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailInboxMessagesStatuses","name":"Get all email messages statuses associated with a given Email Inbox","isWebhook":false,"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages~1statuses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all email messages statuses associated with a given Email Inbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/email-inboxes/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{emailInboxId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/messages/statuses"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"emailInboxId","in":"path","schemaId":"schema_702","description":"Unique identification number for email inbox","required":true}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages~1statuses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_710"}},"schemaId":"schema_710","pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages~1statuses/post/requestBody","description":"List of email received message ids"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/email-inboxes/{emailInboxId}/messages/statuses","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"emailInboxId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_710"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/email-inboxes/{emailInboxId}/messages/statuses","href":"email-inboxes/getemailinboxmessagesstatuses","openApiOperationId":"getEmailInboxMessagesStatuses","summary":"Get all email messages statuses associated with a given Email Inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_710","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_710"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_711"}},"schemaId":"schema_711"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1email-inboxes~1{emailInboxId}~1messages~1statuses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_711","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_711"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-inboxes/getemailinboxmessagesstatuses"}],"panels":[]}]},"httpPath":"/v3/email-inboxes/{emailInboxId}/messages/statuses"}],"content":{"contentType":"group","meta":{"name":"email-inboxes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Inboxes","showPageActions":true},{"nodeType":"markdoc","content":"APIs for getting email messages and results from email inboxes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/email-inboxes/library","summary":"Return filtered email inboxes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-inboxes/getemailinboxes","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}","summary":"Get Email Inbox by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-inboxes/getemailinbox","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}/audit-configurations","summary":"Read the configurations for an Email Inbox by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-inboxes/getemailinboxconfigurations","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}/messages","summary":"Get all email messages associated with a given Email Inbox","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-inboxes/getemailinboxmessages","deprecated":false},{"title":"/v3/email-inboxes/{emailInboxId}/messages/statuses","summary":"Get all email messages statuses associated with a given Email Inbox","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-inboxes/getemailinboxmessagesstatuses","deprecated":false}]}]}]}]}},{"type":"separator","label":"Configuration","content":null},{"type":"group","label":"Action Set Action Rules","link":"/openapi/combined.openapi/action-set-action-rules","routeSlug":"/openapi/combined.openapi/action-set-action-rules","items":[{"label":"Get action set action rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/action-set-action-rules/getactionsetactionrules","routeSlug":"/openapi/combined.openapi/action-set-action-rules/getactionsetactionrules","metadata":{"seo":{"title":"Get action set action rules","description":"GET /v3/action-sets/{actionSetId}/actions/{actionId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActionSetActionRules","name":"Get action set action rules","isWebhook":false,"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get action set action rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/action-sets/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSetId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/rules"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all rules for a specific action set and action"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"actionSetId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"Action set ID","required":true},{"name":"actionId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"Action ID","required":true}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}~1rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/action-sets/{actionSetId}/actions/{actionId}/rules","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"actionSetId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"},{"name":"actionId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/action-sets/{actionSetId}/actions/{actionId}/rules","href":"action-set-action-rules/getactionsetactionrules","openApiOperationId":"getActionSetActionRules","summary":"Get action set action rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved rules","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_712"}},"schemaId":"schema_712"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}~1rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_712","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_712"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/action-set-action-rules/getactionsetactionrules"}],"panels":[]}]},"httpPath":"/v3/action-sets/{actionSetId}/actions/{actionId}/rules"},{"label":"Update action set action rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/action-set-action-rules/updateactionsetactionrules","routeSlug":"/openapi/combined.openapi/action-set-action-rules/updateactionsetactionrules","metadata":{"seo":{"title":"Update action set action rules","description":"PUT /v3/action-sets/{actionSetId}/actions/{actionId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActionSetActionRules","name":"Update action set action rules","isWebhook":false,"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}~1rules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update action set action rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/action-sets/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSetId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/rules"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the rules for a specific action set and action with a new set of rule IDs"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"actionSetId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"Action set ID","required":true},{"name":"actionId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"Action ID","required":true}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}~1rules/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_713"}},"schemaId":"schema_713","pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}~1rules/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/action-sets/{actionSetId}/actions/{actionId}/rules","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"actionSetId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"},{"name":"actionId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_713"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/action-sets/{actionSetId}/actions/{actionId}/rules","href":"action-set-action-rules/updateactionsetactionrules","openApiOperationId":"updateActionSetActionRules","summary":"Update action set action rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_713","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_713"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated rules","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_712"}},"schemaId":"schema_712"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}~1rules/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_712","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_712"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/action-set-action-rules/updateactionsetactionrules"}],"panels":[]}]},"httpPath":"/v3/action-sets/{actionSetId}/actions/{actionId}/rules"}],"content":{"contentType":"group","meta":{"name":"action-set-action-rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Action Set Action Rules","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing Action Set Action Rules"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/action-sets/{actionSetId}/actions/{actionId}/rules","summary":"Get action set action rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/action-set-action-rules/getactionsetactionrules","deprecated":false},{"title":"/v3/action-sets/{actionSetId}/actions/{actionId}/rules","summary":"Update action set action rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/action-set-action-rules/updateactionsetactionrules","deprecated":false}]}]}]}]}},{"type":"group","label":"Action Set Actions","link":"/openapi/combined.openapi/action-set-actions","routeSlug":"/openapi/combined.openapi/action-set-actions","items":[{"label":"Get action set action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/action-set-actions/getactionsetaction","routeSlug":"/openapi/combined.openapi/action-set-actions/getactionsetaction","metadata":{"seo":{"title":"Get action set action","description":"GET /v3/action-sets/{actionSetId}/actions/{actionId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActionSetAction","name":"Get action set action","isWebhook":false,"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get action set action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/action-sets/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSetId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a specific action from an action set"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"actionSetId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"ID of the action set","required":true},{"name":"actionId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"ID of the action to retrieve","required":true}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/action-sets/{actionSetId}/actions/{actionId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"actionSetId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"},{"name":"actionId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/action-sets/{actionSetId}/actions/{actionId}","href":"action-set-actions/getactionsetaction","openApiOperationId":"getActionSetAction","summary":"Get action set action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"schemaId":"components/schemas/ActionSetActionDto"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActionSetActionDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/action-set-actions/getactionsetaction"}],"panels":[]}]},"httpPath":"/v3/action-sets/{actionSetId}/actions/{actionId}"},{"label":"Update action set action","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/action-set-actions/updateactionsetaction","routeSlug":"/openapi/combined.openapi/action-set-actions/updateactionsetaction","metadata":{"seo":{"title":"Update action set action","description":"PUT /v3/action-sets/{actionSetId}/actions/{actionId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActionSetAction","name":"Update action set action","isWebhook":false,"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update action set action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/action-sets/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSetId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a specific action in an action set"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"actionSetId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"ID of the action set","required":true},{"name":"actionId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"ID of the action to update","required":true}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"schemaId":"components/schemas/ActionSetActionDto","pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/action-sets/{actionSetId}/actions/{actionId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"actionSetId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"},{"name":"actionId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/action-sets/{actionSetId}/actions/{actionId}","href":"action-set-actions/updateactionsetaction","openApiOperationId":"updateActionSetAction","summary":"Update action set action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/ActionSetActionDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"schemaId":"components/schemas/ActionSetActionDto"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}~1actions~1{actionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActionSetActionDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/action-set-actions/updateactionsetaction"}],"panels":[]}]},"httpPath":"/v3/action-sets/{actionSetId}/actions/{actionId}"}],"content":{"contentType":"group","meta":{"name":"action-set-actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Action Set Actions","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing Action Set Actions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/action-sets/{actionSetId}/actions/{actionId}","summary":"Get action set action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/action-set-actions/getactionsetaction","deprecated":false},{"title":"/v3/action-sets/{actionSetId}/actions/{actionId}","summary":"Update action set action","prefix":{"name":"put","color":"put"},"badges":[],"link":"/action-set-actions/updateactionsetaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Action Sets","link":"/openapi/combined.openapi/action-sets","routeSlug":"/openapi/combined.openapi/action-sets","items":[{"label":"Get action sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/action-sets/getactionsets","routeSlug":"/openapi/combined.openapi/action-sets/getactionsets","metadata":{"seo":{"title":"Get action sets","description":"GET /v3/action-sets"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActionSets","name":"Get action sets","isWebhook":false,"pointer":"/paths/~1v3~1action-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get action sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/action-sets"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all action sets in the account"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountId","in":"query","schemaId":"components/schemas/ReceivedEmailMessageId","description":"Filter action sets by account ID"}],"pointer":"/paths/~1v3~1action-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/action-sets","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"accountId","in":"query","required":false,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v3/action-sets","href":"action-sets/getactionsets","openApiOperationId":"getActionSets","summary":"Get action sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action sets retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_714"}},"schemaId":"schema_714"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1action-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_714","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_714"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/action-sets/getactionsets"}],"panels":[]}]},"httpPath":"/v3/action-sets"},{"label":"Create action set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/action-sets/createactionset","routeSlug":"/openapi/combined.openapi/action-sets/createactionset","metadata":{"seo":{"title":"Create action set","description":"POST /v3/action-sets"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createActionSet","name":"Create action set","isWebhook":false,"pointer":"/paths/~1v3~1action-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create action set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/action-sets"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new action set"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountId","in":"query","schemaId":"components/schemas/ReceivedEmailMessageId","description":"Account ID to create action set in"}],"pointer":"/paths/~1v3~1action-sets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}},"schemaId":"components/schemas/ActionSetDto","pointer":"/paths/~1v3~1action-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/action-sets","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"accountId","in":"query","required":false,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/action-sets","href":"action-sets/createactionset","openApiOperationId":"createActionSet","summary":"Create action set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/ActionSetDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action set created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}},"schemaId":"components/schemas/ActionSetDto"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1action-sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActionSetDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/action-sets/createactionset"}],"panels":[]}]},"httpPath":"/v3/action-sets"},{"label":"Get action set by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/action-sets/getactionset","routeSlug":"/openapi/combined.openapi/action-sets/getactionset","metadata":{"seo":{"title":"Get action set by ID","description":"GET /v3/action-sets/{actionSetId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActionSet","name":"Get action set by ID","isWebhook":false,"pointer":"/paths/~1v3~1action-sets~1{actionSetId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get action set by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/action-sets/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSetId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a specific action set by its ID"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"actionSetId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"ID of the action set to retrieve","required":true}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/action-sets/{actionSetId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"actionSetId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/action-sets/{actionSetId}","href":"action-sets/getactionset","openApiOperationId":"getActionSet","summary":"Get action set by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action set retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}},"schemaId":"components/schemas/ActionSetDto"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActionSetDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/action-sets/getactionset"}],"panels":[]}]},"httpPath":"/v3/action-sets/{actionSetId}"},{"label":"Update action set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/action-sets/updateactionset","routeSlug":"/openapi/combined.openapi/action-sets/updateactionset","metadata":{"seo":{"title":"Update action set","description":"PUT /v3/action-sets/{actionSetId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActionSet","name":"Update action set","isWebhook":false,"pointer":"/paths/~1v3~1action-sets~1{actionSetId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update action set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/action-sets/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSetId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing action set"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"actionSetId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"ID of the action set to update","required":true}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}},"schemaId":"components/schemas/ActionSetDto","pointer":"/paths/~1v3~1action-sets~1{actionSetId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/action-sets/{actionSetId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"actionSetId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/action-sets/{actionSetId}","href":"action-sets/updateactionset","openApiOperationId":"updateActionSet","summary":"Update action set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/ActionSetDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action set updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}},"schemaId":"components/schemas/ActionSetDto"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActionSetDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetDto"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/action-sets/updateactionset"}],"panels":[]}]},"httpPath":"/v3/action-sets/{actionSetId}"},{"label":"Delete action set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/action-sets/deleteactionset","routeSlug":"/openapi/combined.openapi/action-sets/deleteactionset","metadata":{"seo":{"title":"Delete action set","description":"DELETE /v3/action-sets/{actionSetId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteActionSet","name":"Delete action set","isWebhook":false,"pointer":"/paths/~1v3~1action-sets~1{actionSetId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete action set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/action-sets/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSetId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete an existing action set"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"actionSetId","in":"path","schemaId":"components/schemas/RuleSnapshotId","description":"ID of the action set to delete","required":true}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/action-sets/{actionSetId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"actionSetId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/v3/action-sets/{actionSetId}","href":"action-sets/deleteactionset","openApiOperationId":"deleteActionSet","summary":"Delete action set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Action set deleted successfully"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1action-sets~1{actionSetId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/action-sets/deleteactionset"}],"panels":[]}]},"httpPath":"/v3/action-sets/{actionSetId}"}],"content":{"contentType":"group","meta":{"name":"action-sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Action Sets","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing Action Sets"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/action-sets","summary":"Get action sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/action-sets/getactionsets","deprecated":false},{"title":"/v3/action-sets","summary":"Create action set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/action-sets/createactionset","deprecated":false},{"title":"/v3/action-sets/{actionSetId}","summary":"Get action set by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/action-sets/getactionset","deprecated":false},{"title":"/v3/action-sets/{actionSetId}","summary":"Update action set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/action-sets/updateactionset","deprecated":false},{"title":"/v3/action-sets/{actionSetId}","summary":"Delete action set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/action-sets/deleteactionset","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit Actions","link":"/openapi/combined.openapi/audit-actions","routeSlug":"/openapi/combined.openapi/audit-actions","items":[{"label":"Get actions for an audit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-actions/getauditactions","routeSlug":"/openapi/combined.openapi/audit-actions/getauditactions","metadata":{"seo":{"title":"Get actions for an audit","description":"GET /v3/web-audits/{auditId}/actions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditActions","name":"Get actions for an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1actions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get actions for an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all actions configured for the specified audit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1actions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/actions","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/actions","href":"audit-actions/getauditactions","openApiOperationId":"getAuditActions","summary":"Get actions for an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of audit actions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}},"schemaId":"schema_715"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1actions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_715","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-actions/getauditactions"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/actions"},{"label":"Update actions for an audit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-actions/updateauditactions","routeSlug":"/openapi/combined.openapi/audit-actions/updateauditactions","metadata":{"seo":{"title":"Update actions for an audit","description":"PUT /v3/web-audits/{auditId}/actions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAuditActions","name":"Update actions for an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1actions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update actions for an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the actions configured for the specified audit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1actions/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_715"}},"schemaId":"schema_715","pointer":"/paths/~1v3~1web-audits~1{auditId}~1actions/put/requestBody","description":"List of audit actions to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-audits/{auditId}/actions","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_715"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-audits/{auditId}/actions","href":"audit-actions/updateauditactions","openApiOperationId":"updateAuditActions","summary":"Update actions for an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_715","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_715"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated audit actions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}},"schemaId":"schema_715"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1actions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_715","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-actions/updateauditactions"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/actions"}],"content":{"contentType":"group","meta":{"name":"audit-actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit Actions","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing audit actions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/actions","summary":"Get actions for an audit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-actions/getauditactions","deprecated":false},{"title":"/v3/web-audits/{auditId}/actions","summary":"Update actions for an audit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/audit-actions/updateauditactions","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit Blocking Config","link":"/openapi/combined.openapi/audit-blocking-config","routeSlug":"/openapi/combined.openapi/audit-blocking-config","items":[{"label":"Get blocking configuration for an Audit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-blocking-config/getauditblockingconfig","routeSlug":"/openapi/combined.openapi/audit-blocking-config/getauditblockingconfig","metadata":{"seo":{"title":"Get blocking configuration for an Audit","description":"GET /v3/web-audits/{auditId}/blocking-configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditBlockingConfig","name":"Get blocking configuration for an Audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1blocking-configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get blocking configuration for an Audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/blocking-configuration"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1blocking-configuration/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/blocking-configuration","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/blocking-configuration","href":"audit-blocking-config/getauditblockingconfig","openApiOperationId":"getAuditBlockingConfig","summary":"Get blocking configuration for an Audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit request blocking configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"schemaId":"components/schemas/BlockingConfig_DTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1blocking-configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BlockingConfig_DTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-blocking-config/getauditblockingconfig"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/blocking-configuration"},{"label":"Create blocking configuration for an Audit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-blocking-config/createauditblockingconfig","routeSlug":"/openapi/combined.openapi/audit-blocking-config/createauditblockingconfig","metadata":{"seo":{"title":"Create blocking configuration for an Audit","description":"PUT /v3/web-audits/{auditId}/blocking-configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAuditBlockingConfig","name":"Create blocking configuration for an Audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1blocking-configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create blocking configuration for an Audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/blocking-configuration"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1blocking-configuration/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"schemaId":"components/schemas/BlockingConfig_DTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1blocking-configuration/put/requestBody","description":"The Audit Blocking configuration to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-audits/{auditId}/blocking-configuration","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/blocking-configuration","href":"audit-blocking-config/createauditblockingconfig","openApiOperationId":"createAuditBlockingConfig","summary":"Create blocking configuration for an Audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/BlockingConfig_DTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned the created Audit Blocking Configuration.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"schemaId":"components/schemas/BlockingConfig_DTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1blocking-configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BlockingConfig_DTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-blocking-config/createauditblockingconfig"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/blocking-configuration"}],"content":{"contentType":"group","meta":{"name":"audit-blocking-config"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit Blocking Config","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing audit request blocking configuration"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/blocking-configuration","summary":"Get blocking configuration for an Audit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-blocking-config/getauditblockingconfig","deprecated":false},{"title":"/v3/web-audits/{auditId}/blocking-configuration","summary":"Create blocking configuration for an Audit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/audit-blocking-config/createauditblockingconfig","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit Login Actions","link":"/openapi/combined.openapi/audit-login-actions","routeSlug":"/openapi/combined.openapi/audit-login-actions","items":[{"label":"Get login actions for an audit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-login-actions/getauditloginactions","routeSlug":"/openapi/combined.openapi/audit-login-actions/getauditloginactions","metadata":{"seo":{"title":"Get login actions for an audit","description":"GET /v3/web-audits/{auditId}/login-actions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditLoginActions","name":"Get login actions for an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1login-actions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get login actions for an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/login-actions"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all login actions configured for the specified audit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1login-actions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/login-actions","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/login-actions","href":"audit-login-actions/getauditloginactions","openApiOperationId":"getAuditLoginActions","summary":"Get login actions for an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of audit login actions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_716"}},"schemaId":"schema_716"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1login-actions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_716","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_716"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-login-actions/getauditloginactions"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/login-actions"},{"label":"Update login actions for an audit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audit-login-actions/updateauditloginactions","routeSlug":"/openapi/combined.openapi/audit-login-actions/updateauditloginactions","metadata":{"seo":{"title":"Update login actions for an audit","description":"PUT /v3/web-audits/{auditId}/login-actions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAuditLoginActions","name":"Update login actions for an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1login-actions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update login actions for an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/login-actions"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the login actions configured for the specified audit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1login-actions/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_716"}},"schemaId":"schema_716","pointer":"/paths/~1v3~1web-audits~1{auditId}~1login-actions/put/requestBody","description":"List of audit login actions to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-audits/{auditId}/login-actions","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_716"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-audits/{auditId}/login-actions","href":"audit-login-actions/updateauditloginactions","openApiOperationId":"updateAuditLoginActions","summary":"Update login actions for an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_716","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_716"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated audit login actions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_716"}},"schemaId":"schema_716"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1login-actions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_716","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_716"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-login-actions/updateauditloginactions"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/login-actions"}],"content":{"contentType":"group","meta":{"name":"audit-login-actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit Login Actions","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing audit login actions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/login-actions","summary":"Get login actions for an audit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-login-actions/getauditloginactions","deprecated":false},{"title":"/v3/web-audits/{auditId}/login-actions","summary":"Update login actions for an audit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/audit-login-actions/updateauditloginactions","deprecated":false}]}]}]}]}},{"type":"group","label":"Audits Consent Category","link":"/openapi/combined.openapi/audits-consent-category","routeSlug":"/openapi/combined.openapi/audits-consent-category","items":[{"label":"Get all the consent categories assigned to an audit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-consent-category/getauditconsentcategories","routeSlug":"/openapi/combined.openapi/audits-consent-category/getauditconsentcategories","metadata":{"seo":{"title":"Get all the consent categories assigned to an audit","description":"GET /v3/web-audits/{auditId}/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditConsentCategories","name":"Get all the consent categories assigned to an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all the consent categories assigned to an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/consent-categories","href":"audits-consent-category/getauditconsentcategories","openApiOperationId":"getAuditConsentCategories","summary":"Get all the consent categories assigned to an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of consent-categories assigned to an audit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}},"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-consent-category/getauditconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/consent-categories"},{"label":"Update the consent categories assigned to an audit","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-consent-category/patchauditconsentcategories","routeSlug":"/openapi/combined.openapi/audits-consent-category/patchauditconsentcategories","metadata":{"seo":{"title":"Update the consent categories assigned to an audit","description":"PATCH /v3/web-audits/{auditId}/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAuditConsentCategories","name":"Update the consent categories assigned to an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the consent categories assigned to an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/web-audits/{auditId}/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/consent-categories","href":"audits-consent-category/patchauditconsentcategories","openApiOperationId":"patchAuditConsentCategories","summary":"Update the consent categories assigned to an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return the modified consent category assignments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}},"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-consent-category/patchauditconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/consent-categories"},{"label":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-consent-category/getauditrunconsentcategories","routeSlug":"/openapi/combined.openapi/audits-consent-category/getauditrunconsentcategories","metadata":{"seo":{"title":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","description":"GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunConsentCategories","name":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories","href":"audits-consent-category/getauditrunconsentcategories","openApiOperationId":"getAuditRunConsentCategories","summary":"Retrieve all consent categories snapshots that are applied to a specific audit run. "},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of consent category snapshots assigned to this run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO"}},"schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-consent-category/getauditrunconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories"},{"label":"Reprocess consent-category for the selected auditId and runIds","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-consent-category/reprocessconsentcategories","routeSlug":"/openapi/combined.openapi/audits-consent-category/reprocessconsentcategories","metadata":{"seo":{"title":"Reprocess consent-category for the selected auditId and runIds","description":"POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reprocessConsentCategories","name":"Reprocess consent-category for the selected auditId and runIds","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories~1reprocess/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reprocess consent-category for the selected auditId and runIds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories/reprocess"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories~1reprocess/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess","href":"audits-consent-category/reprocessconsentcategories","openApiOperationId":"reprocessConsentCategories","summary":"Reprocess consent-category for the selected auditId and runIds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, start reprocessing specified audit with specified consent category"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories~1reprocess/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-consent-category/reprocessconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess"}],"content":{"contentType":"group","meta":{"name":"audits-consent-category"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audits Consent Category","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing audit consent categories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/consent-categories","summary":"Get all the consent categories assigned to an audit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits-consent-category/getauditconsentcategories","deprecated":false},{"title":"/v3/web-audits/{auditId}/consent-categories","summary":"Update the consent categories assigned to an audit","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/audits-consent-category/patchauditconsentcategories","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories","summary":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits-consent-category/getauditrunconsentcategories","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess","summary":"Reprocess consent-category for the selected auditId and runIds","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audits-consent-category/reprocessconsentcategories","deprecated":false}]}]}]}]}},{"type":"group","label":"Audits Management","link":"/openapi/combined.openapi/audits-management","routeSlug":"/openapi/combined.openapi/audits-management","items":[{"label":"Get list of web audits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/getwebaudits","routeSlug":"/openapi/combined.openapi/audits-management/getwebaudits","metadata":{"seo":{"title":"Get list of web audits","description":"GET /v3/web-audits"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAudits","name":"Get list of web audits","isWebhook":false,"pointer":"/paths/~1v3~1web-audits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of web audits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all web audits accessible to the authenticated user based on their permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/web-audits","href":"audits-management/getwebaudits","openApiOperationId":"getWebAudits","summary":"Get list of web audits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of web audits","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_717"}},"schemaId":"schema_717"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_717","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_717"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/getwebaudits"}],"panels":[]}]},"httpPath":"/v3/web-audits"},{"label":"Undelete a web audit","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/undeletewebaudit","routeSlug":"/openapi/combined.openapi/audits-management/undeletewebaudit","metadata":{"seo":{"title":"Undelete a web audit","description":"PATCH /v3/web-audits/undelete"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"undeleteWebAudit","name":"Undelete a web audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1undelete/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Undelete a web audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/undelete"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restore a single archived audit into a chosen destination Folder and Sub-folder. The original parents are not reinstated. Historical run data is not restored. Per-item outcomes (including destination_gone and already_restored) are returned in the 200 response body; only authentication and authorization failures use 401/403."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UndeleteWebAuditRequest"}},"schemaId":"components/schemas/UndeleteWebAuditRequest","pointer":"/paths/~1v3~1web-audits~1undelete/patch/requestBody","description":"Audit id and restore destination"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/web-audits/undelete","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UndeleteWebAuditRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/web-audits/undelete","href":"audits-management/undeletewebaudit","openApiOperationId":"undeleteWebAudit","summary":"Undelete a web audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/UndeleteWebAuditRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UndeleteWebAuditRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Restore outcome for the requested audit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UndeleteWebAuditResponse"}},"schemaId":"components/schemas/UndeleteWebAuditResponse"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1undelete/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UndeleteWebAuditResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UndeleteWebAuditResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/undeletewebaudit"}],"panels":[]}]},"httpPath":"/v3/web-audits/undelete"},{"label":"Get audit notes by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/getwebauditnotes","routeSlug":"/openapi/combined.openapi/audits-management/getwebauditnotes","metadata":{"seo":{"title":"Get audit notes by ID","description":"GET /v3/web-audits/{auditId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAuditNotes","name":"Get audit notes by ID","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get audit notes by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve notes for a specific audit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}","href":"audits-management/getwebauditnotes","openApiOperationId":"getWebAuditNotes","summary":"Get audit notes by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit notes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditNotesDTO"}},"schemaId":"components/schemas/AuditNotesDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditNotesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditNotesDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/getwebauditnotes"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}"},{"label":"Update audit notes","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/updatewebauditnotes","routeSlug":"/openapi/combined.openapi/audits-management/updatewebauditnotes","metadata":{"seo":{"title":"Update audit notes","description":"PUT /v3/web-audits/{auditId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebAuditNotes","name":"Update audit notes","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update audit notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update notes for a specific audit"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditNotesDTO"}},"schemaId":"components/schemas/AuditNotesDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}/put/requestBody","description":"Updated audit notes"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-audits/{auditId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditNotesDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-audits/{auditId}","href":"audits-management/updatewebauditnotes","openApiOperationId":"updateWebAuditNotes","summary":"Update audit notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditNotesDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditNotesDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated audit notes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditNotesDTO"}},"schemaId":"components/schemas/AuditNotesDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditNotesDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditNotesDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/updatewebauditnotes"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}"},{"label":"run audit now","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/runauditnow","routeSlug":"/openapi/combined.openapi/audits-management/runauditnow","metadata":{"seo":{"title":"run audit now","description":"POST /v3/web-audits/{auditId}/runs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runAuditNow","name":"run audit now","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"run audit now","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RunNowRequestDTO"}},"schemaId":"components/schemas/AuditRun_RunNowRequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs/post/requestBody","description":"Run the audit now. The request must contain the web-audit ID.\nUnlike v2 \"run now\" API, this API does not reject run requests if there is an active run.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditRun_RunNowRequestDTO"}},"responseCodes":["201","400","401","403"],"pointer":"/v3/web-audits/{auditId}/runs","href":"audits-management/runauditnow","openApiOperationId":"runAuditNow","summary":"run audit now"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AuditRun_RunNowRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditRun_RunNowRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Run started successfully"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/runauditnow"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs"},{"label":"Get audit configuration info for specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/getauditruninfo","routeSlug":"/openapi/combined.openapi/audits-management/getauditruninfo","metadata":{"seo":{"title":"Get audit configuration info for specified audit run","description":"GET /v3/web-audits/{auditId}/runs/{runId}/info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunInfo","name":"Get audit configuration info for specified audit run","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get audit configuration info for specified audit run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/info"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1info/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeFilters","in":"query","schemaId":"schema_599","description":"Include filters in the response"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/info","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[{"name":"includeFilters","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/info","href":"audits-management/getauditruninfo","openApiOperationId":"getAuditRunInfo","summary":"Get audit configuration info for specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit run configuration info","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_ConfigurationInfoResponseDTO"}},"schemaId":"components/schemas/AuditRun_ConfigurationInfoResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1info/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRun_ConfigurationInfoResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRun_ConfigurationInfoResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/getauditruninfo"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/info"},{"label":"Get all the consent categories assigned to an audit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/getauditconsentcategories","routeSlug":"/openapi/combined.openapi/audits-management/getauditconsentcategories","metadata":{"seo":{"title":"Get all the consent categories assigned to an audit","description":"GET /v3/web-audits/{auditId}/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditConsentCategories","name":"Get all the consent categories assigned to an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all the consent categories assigned to an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/consent-categories","href":"audits-management/getauditconsentcategories","openApiOperationId":"getAuditConsentCategories","summary":"Get all the consent categories assigned to an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of consent-categories assigned to an audit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}},"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/getauditconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/consent-categories"},{"label":"Update the consent categories assigned to an audit","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/patchauditconsentcategories","routeSlug":"/openapi/combined.openapi/audits-management/patchauditconsentcategories","metadata":{"seo":{"title":"Update the consent categories assigned to an audit","description":"PATCH /v3/web-audits/{auditId}/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAuditConsentCategories","name":"Update the consent categories assigned to an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the consent categories assigned to an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/web-audits/{auditId}/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/consent-categories","href":"audits-management/patchauditconsentcategories","openApiOperationId":"patchAuditConsentCategories","summary":"Update the consent categories assigned to an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return the modified consent category assignments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}},"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/patchauditconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/consent-categories"},{"label":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/getauditrunconsentcategories","routeSlug":"/openapi/combined.openapi/audits-management/getauditrunconsentcategories","metadata":{"seo":{"title":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","description":"GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunConsentCategories","name":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories","href":"audits-management/getauditrunconsentcategories","openApiOperationId":"getAuditRunConsentCategories","summary":"Retrieve all consent categories snapshots that are applied to a specific audit run. "},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of consent category snapshots assigned to this run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO"}},"schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/getauditrunconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories"},{"label":"Reprocess consent-category for the selected auditId and runIds","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/reprocessconsentcategories","routeSlug":"/openapi/combined.openapi/audits-management/reprocessconsentcategories","metadata":{"seo":{"title":"Reprocess consent-category for the selected auditId and runIds","description":"POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reprocessConsentCategories","name":"Reprocess consent-category for the selected auditId and runIds","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories~1reprocess/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reprocess consent-category for the selected auditId and runIds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories/reprocess"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories~1reprocess/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess","href":"audits-management/reprocessconsentcategories","openApiOperationId":"reprocessConsentCategories","summary":"Reprocess consent-category for the selected auditId and runIds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, start reprocessing specified audit with specified consent category"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories~1reprocess/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/reprocessconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess"},{"label":"Get latest runs for web audits","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/audits-management/getwebauditlatestruns","routeSlug":"/openapi/combined.openapi/audits-management/getwebauditlatestruns","metadata":{"seo":{"title":"Get latest runs for web audits","description":"GET /v3/web-audits/latest-runs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAuditLatestRuns","name":"Get latest runs for web audits","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1latest-runs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get latest runs for web audits","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/latest-runs"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve latest run information for web audits with optional account filtering. Deprecated: use the grid API instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountId","in":"query","schemaId":"components/schemas/ReceivedEmailMessageId","description":"Optional account ID to filter results"}],"pointer":"/paths/~1v3~1web-audits~1latest-runs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/latest-runs","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"accountId","in":"query","required":false,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v3/web-audits/latest-runs","href":"audits-management/getwebauditlatestruns","openApiOperationId":"getWebAuditLatestRuns","summary":"Get latest runs for web audits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of latest run items","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_718"}},"schemaId":"schema_718"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1latest-runs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_718","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_718"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits-management/getwebauditlatestruns"}],"panels":[]}]},"httpPath":"/v3/web-audits/latest-runs"}],"content":{"contentType":"group","meta":{"name":"audits-management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audits Management","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing audits"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits","summary":"Get list of web audits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits-management/getwebaudits","deprecated":false},{"title":"/v3/web-audits/undelete","summary":"Undelete a web audit","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/audits-management/undeletewebaudit","deprecated":false},{"title":"/v3/web-audits/{auditId}","summary":"Get audit notes by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits-management/getwebauditnotes","deprecated":false},{"title":"/v3/web-audits/{auditId}","summary":"Update audit notes","prefix":{"name":"put","color":"put"},"badges":[],"link":"/audits-management/updatewebauditnotes","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs","summary":"run audit now","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audits-management/runauditnow","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/info","summary":"Get audit configuration info for specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits-management/getauditruninfo","deprecated":false},{"title":"/v3/web-audits/{auditId}/consent-categories","summary":"Get all the consent categories assigned to an audit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits-management/getauditconsentcategories","deprecated":false},{"title":"/v3/web-audits/{auditId}/consent-categories","summary":"Update the consent categories assigned to an audit","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/audits-management/patchauditconsentcategories","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories","summary":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits-management/getauditrunconsentcategories","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess","summary":"Reprocess consent-category for the selected auditId and runIds","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audits-management/reprocessconsentcategories","deprecated":false},{"title":"/v3/web-audits/latest-runs","summary":"Get latest runs for web audits","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/audits-management/getwebauditlatestruns","deprecated":true}]}]}]}]}},{"type":"group","label":"Consent Categories","link":"/openapi/combined.openapi/consent-categories","routeSlug":"/openapi/combined.openapi/consent-categories","items":[{"label":"Get all the consent categories assigned to an audit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/getauditconsentcategories","routeSlug":"/openapi/combined.openapi/consent-categories/getauditconsentcategories","metadata":{"seo":{"title":"Get all the consent categories assigned to an audit","description":"GET /v3/web-audits/{auditId}/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditConsentCategories","name":"Get all the consent categories assigned to an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all the consent categories assigned to an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/consent-categories","href":"consent-categories/getauditconsentcategories","openApiOperationId":"getAuditConsentCategories","summary":"Get all the consent categories assigned to an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of consent-categories assigned to an audit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}},"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/getauditconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/consent-categories"},{"label":"Update the consent categories assigned to an audit","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/patchauditconsentcategories","routeSlug":"/openapi/combined.openapi/consent-categories/patchauditconsentcategories","metadata":{"seo":{"title":"Update the consent categories assigned to an audit","description":"PATCH /v3/web-audits/{auditId}/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAuditConsentCategories","name":"Update the consent categories assigned to an audit","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the consent categories assigned to an audit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/web-audits/{auditId}/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/consent-categories","href":"consent-categories/patchauditconsentcategories","openApiOperationId":"patchAuditConsentCategories","summary":"Update the consent categories assigned to an audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return the modified consent category assignments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}},"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1consent-categories/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategories_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/patchauditconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/consent-categories"},{"label":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/getauditrunconsentcategories","routeSlug":"/openapi/combined.openapi/consent-categories/getauditrunconsentcategories","metadata":{"seo":{"title":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","description":"GET /v3/web-audits/{auditId}/runs/{runId}/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditRunConsentCategories","name":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories","href":"consent-categories/getauditrunconsentcategories","openApiOperationId":"getAuditRunConsentCategories","summary":"Retrieve all consent categories snapshots that are applied to a specific audit run. "},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of consent category snapshots assigned to this run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO"}},"schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/getauditrunconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories"},{"label":"Create or update consent categories found in the file uploaded previously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/uploadconsentcategories","routeSlug":"/openapi/combined.openapi/consent-categories/uploadconsentcategories","metadata":{"seo":{"title":"Create or update consent categories found in the file uploaded previously","description":"POST /v3/consent-categories/upload"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadConsentCategories","name":"Create or update consent categories found in the file uploaded previously","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update consent categories found in the file uploaded previously","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/upload"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsentCategoriesUploadRequest"}},"schemaId":"components/schemas/ConsentCategoriesUploadRequest","pointer":"/paths/~1v3~1consent-categories~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/consent-categories/upload","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsentCategoriesUploadRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/consent-categories/upload","href":"consent-categories/uploadconsentcategories","openApiOperationId":"uploadConsentCategories","summary":"Create or update consent categories found in the file uploaded previously"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/ConsentCategoriesUploadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsentCategoriesUploadRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, return a list of updated consent categories","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/uploadconsentcategories"}],"panels":[]}]},"httpPath":"/v3/consent-categories/upload"},{"label":"Upload a file with consent category configurations and preview the changes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/uploadconsentcategoriespreview","routeSlug":"/openapi/combined.openapi/consent-categories/uploadconsentcategoriespreview","metadata":{"seo":{"title":"Upload a file with consent category configurations and preview the changes","description":"POST /v3/consent-categories/upload/preview"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadConsentCategoriesPreview","name":"Upload a file with consent category configurations and preview the changes","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1upload~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a file with consent category configurations and preview the changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/upload/preview"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File uploaded must be a xlsx or csv file and cannot be larger than 1MB"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_720"}},"schemaId":"schema_720","pointer":"/paths/~1v3~1consent-categories~1upload~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/consent-categories/upload/preview","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_720"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/consent-categories/upload/preview","href":"consent-categories/uploadconsentcategoriespreview","openApiOperationId":"uploadConsentCategoriesPreview","summary":"Upload a file with consent category configurations and preview the changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_720","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_720"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Processed Results from File","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategoryUploadPreviewResult"}},"schemaId":"components/schemas/ConsentCategoryUploadPreviewResult"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1upload~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategoryUploadPreviewResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategoryUploadPreviewResult"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/uploadconsentcategoriespreview"}],"panels":[]}]},"httpPath":"/v3/consent-categories/upload/preview"},{"label":"Get all consent categories in the account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/getconsentcategorylibrary","routeSlug":"/openapi/combined.openapi/consent-categories/getconsentcategorylibrary","metadata":{"seo":{"title":"Get all consent categories in the account","description":"GET /v3/consent-categories/library"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConsentCategoryLibrary","name":"Get all consent categories in the account","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1library/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all consent categories in the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/library"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_608"},{"name":"name","in":"query","schemaId":"schema_627","description":"filter the consent categories by name"},{"name":"labels","in":"query","schemaId":"schema_721","description":"filter the items by labels"},{"name":"type","in":"query","schemaId":"schema_722","description":"filter the items by a given item type"},{"name":"cmpVendor","in":"query","schemaId":"schema_723","description":"filter the items by a given CMP vendor"},{"name":"sortBy","in":"query","schemaId":"schema_724"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1consent-categories~1library/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/consent-categories/library","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"},{"name":"name","in":"query","required":false,"schemaId":"schema_627"},{"name":"labels","in":"query","required":false,"schemaId":"schema_721","style":"form","explode":false},{"name":"type","in":"query","required":false,"schemaId":"components/schemas/ConsentCategoryComplianceStatus"},{"name":"cmpVendor","in":"query","required":false,"schemaId":"components/schemas/ConsentCategory_VendorTypeEnum"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/ConsentCategoryLibrarySortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/consent-categories/library","href":"consent-categories/getconsentcategorylibrary","openApiOperationId":"getConsentCategoryLibrary","summary":"Get all consent categories in the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a list of consent categories","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_LibraryResponseDTO"}},"schemaId":"components/schemas/ConsentCategory_LibraryResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1library/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategory_LibraryResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_LibraryResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/getconsentcategorylibrary"}],"panels":[]}]},"httpPath":"/v3/consent-categories/library"},{"label":"Create a consent category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/createconsentcategories","routeSlug":"/openapi/combined.openapi/consent-categories/createconsentcategories","metadata":{"seo":{"title":"Create a consent category","description":"POST /v3/consent-categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConsentCategories","name":"Create a consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsentCategory_CreateRequestDTO"}},"schemaId":"components/schemas/ConsentCategory_CreateRequestDTO","pointer":"/paths/~1v3~1consent-categories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/consent-categories","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsentCategory_CreateRequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/consent-categories","href":"consent-categories/createconsentcategories","openApiOperationId":"createConsentCategories","summary":"Create a consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/ConsentCategory_CreateRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsentCategory_CreateRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created a consent category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategoryDTO"}},"schemaId":"components/schemas/ConsentCategoryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategoryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategoryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/createconsentcategories"}],"panels":[]}]},"httpPath":"/v3/consent-categories"},{"label":"Get a consent category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/getconsentcategory","routeSlug":"/openapi/combined.openapi/consent-categories/getconsentcategory","metadata":{"seo":{"title":"Get a consent category","description":"GET /v3/consent-categories/{consentCategoryId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConsentCategory","name":"Get a consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/consent-categories/{consentCategoryId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}","href":"consent-categories/getconsentcategory","openApiOperationId":"getConsentCategory","summary":"Get a consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved a consent category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategoryDTO"}},"schemaId":"components/schemas/ConsentCategoryDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategoryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategoryDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/getconsentcategory"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}"},{"label":"Update a consent category","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/updateconsentcategory","routeSlug":"/openapi/combined.openapi/consent-categories/updateconsentcategory","metadata":{"seo":{"title":"Update a consent category","description":"PUT /v3/consent-categories/{consentCategoryId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateConsentCategory","name":"Update a consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsentCategory_UpdateRequestDTO"}},"schemaId":"components/schemas/ConsentCategory_UpdateRequestDTO","pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/consent-categories/{consentCategoryId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConsentCategory_UpdateRequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}","href":"consent-categories/updateconsentcategory","openApiOperationId":"updateConsentCategory","summary":"Update a consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/ConsentCategory_UpdateRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConsentCategory_UpdateRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated a consent category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategoryDTO"}},"schemaId":"components/schemas/ConsentCategoryDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategoryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategoryDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/updateconsentcategory"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}"},{"label":"Delete a consent category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/deleteconsentcategory","routeSlug":"/openapi/combined.openapi/consent-categories/deleteconsentcategory","metadata":{"seo":{"title":"Delete a consent category","description":"DELETE /v3/consent-categories/{consentCategoryId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConsentCategory","name":"Delete a consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/consent-categories/{consentCategoryId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403"],"pointer":"/v3/consent-categories/{consentCategoryId}","href":"consent-categories/deleteconsentcategory","openApiOperationId":"deleteConsentCategory","summary":"Delete a consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted a consent category"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/deleteconsentcategory"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}"},{"label":"Upsert notes for the given Consent Category","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/updateconsentcategoriesnotes","routeSlug":"/openapi/combined.openapi/consent-categories/updateconsentcategoriesnotes","metadata":{"seo":{"title":"Upsert notes for the given Consent Category","description":"PUT /v3/consent-categories/{consentCategoryId}/notes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateConsentCategoriesNotes","name":"Upsert notes for the given Consent Category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1notes/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert notes for the given Consent Category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/notes"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1notes/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_627"}},"schemaId":"schema_627","pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1notes/put/requestBody","description":"Update notes for a given Consent Categories"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/consent-categories/{consentCategoryId}/notes","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"text/plain":{"schemaId":"schema_627"}},"responseCodes":["204","400","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/notes","href":"consent-categories/updateconsentcategoriesnotes","openApiOperationId":"updateConsentCategoriesNotes","summary":"Upsert notes for the given Consent Category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_627","mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_627"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_726"}},"schemaId":"schema_726"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1notes/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_726","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_726"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/updateconsentcategoriesnotes"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/notes"},{"label":"Get all tag entries of a consent category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/getconsentcategorytags","routeSlug":"/openapi/combined.openapi/consent-categories/getconsentcategorytags","metadata":{"seo":{"title":"Get all tag entries of a consent category","description":"GET /v3/consent-categories/{consentCategoryId}/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConsentCategoryTags","name":"Get all tag entries of a consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all tag entries of a consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/tags"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/consent-categories/{consentCategoryId}/tags","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/tags","href":"consent-categories/getconsentcategorytags","openApiOperationId":"getConsentCategoryTags","summary":"Get all tag entries of a consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a list of consent category tag entries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_TagEntryResponseDTO"}},"schemaId":"components/schemas/ConsentCategory_TagEntryResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategory_TagEntryResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_TagEntryResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/getconsentcategorytags"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/tags"},{"label":"Patch consent category tag entries","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/patchconsentcategorytagentries","routeSlug":"/openapi/combined.openapi/consent-categories/patchconsentcategorytagentries","metadata":{"seo":{"title":"Patch consent category tag entries","description":"PATCH /v3/consent-categories/{consentCategoryId}/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConsentCategoryTagEntries","name":"Patch consent category tag entries","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1tags/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch consent category tag entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/tags"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1tags/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/PatchDocument_RequestDTO"}},"schemaId":"components/schemas/PatchDocument_RequestDTO","pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1tags/patch/requestBody","description":"Patch Document"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/consent-categories/{consentCategoryId}/tags","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/PatchDocument_RequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/tags","href":"consent-categories/patchconsentcategorytagentries","openApiOperationId":"patchConsentCategoryTagEntries","summary":"Patch consent category tag entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/PatchDocument_RequestDTO","mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/PatchDocument_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully patched consent category tag entries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_TagEntryResponseDTO"}},"schemaId":"components/schemas/ConsentCategory_TagEntryResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1tags/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategory_TagEntryResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_TagEntryResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/patchconsentcategorytagentries"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/tags"},{"label":"Get all request domains of a consent category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/getconsentcategoryrequestdomains","routeSlug":"/openapi/combined.openapi/consent-categories/getconsentcategoryrequestdomains","metadata":{"seo":{"title":"Get all request domains of a consent category","description":"GET /v3/consent-categories/{consentCategoryId}/request-domains"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConsentCategoryRequestDomains","name":"Get all request domains of a consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1request-domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all request domains of a consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/request-domains"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1request-domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/consent-categories/{consentCategoryId}/request-domains","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/request-domains","href":"consent-categories/getconsentcategoryrequestdomains","openApiOperationId":"getConsentCategoryRequestDomains","summary":"Get all request domains of a consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a list of consent category request domains","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_RequestDomainResponseDTO"}},"schemaId":"components/schemas/ConsentCategory_RequestDomainResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1request-domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategory_RequestDomainResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_RequestDomainResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/getconsentcategoryrequestdomains"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/request-domains"},{"label":"Patch consent category request domains","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/patchconsentcategoryrequestdomains","routeSlug":"/openapi/combined.openapi/consent-categories/patchconsentcategoryrequestdomains","metadata":{"seo":{"title":"Patch consent category request domains","description":"PATCH /v3/consent-categories/{consentCategoryId}/request-domains"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConsentCategoryRequestDomains","name":"Patch consent category request domains","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1request-domains/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch consent category request domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/request-domains"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1request-domains/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/PatchDocument_RequestDTO"}},"schemaId":"components/schemas/PatchDocument_RequestDTO","pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1request-domains/patch/requestBody","description":"Patch Document"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/consent-categories/{consentCategoryId}/request-domains","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/PatchDocument_RequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/request-domains","href":"consent-categories/patchconsentcategoryrequestdomains","openApiOperationId":"patchConsentCategoryRequestDomains","summary":"Patch consent category request domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/PatchDocument_RequestDTO","mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/PatchDocument_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully patched consent category tag entries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_RequestDomainResponseDTO"}},"schemaId":"components/schemas/ConsentCategory_RequestDomainResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1request-domains/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategory_RequestDomainResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_RequestDomainResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/patchconsentcategoryrequestdomains"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/request-domains"},{"label":"Reprocess consent-category for the selected auditId and runIds","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/reprocessconsentcategories","routeSlug":"/openapi/combined.openapi/consent-categories/reprocessconsentcategories","metadata":{"seo":{"title":"Reprocess consent-category for the selected auditId and runIds","description":"POST /v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reprocessConsentCategories","name":"Reprocess consent-category for the selected auditId and runIds","isWebhook":false,"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories~1reprocess/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reprocess consent-category for the selected auditId and runIds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{auditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/consent-categories/reprocess"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auditId","in":"path","schemaId":"schema_594","description":"Unique identification number for web audit","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories~1reprocess/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess","href":"consent-categories/reprocessconsentcategories","openApiOperationId":"reprocessConsentCategories","summary":"Reprocess consent-category for the selected auditId and runIds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK, start reprocessing specified audit with specified consent category"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-audits~1{auditId}~1runs~1{runId}~1consent-categories~1reprocess/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/reprocessconsentcategories"}],"panels":[]}]},"httpPath":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess"},{"label":"Get all cookies of a consent category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/getconsentcategorycookieentries","routeSlug":"/openapi/combined.openapi/consent-categories/getconsentcategorycookieentries","metadata":{"seo":{"title":"Get all cookies of a consent category","description":"GET /v3/consent-categories/{consentCategoryId}/cookies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConsentCategoryCookieEntries","name":"Get all cookies of a consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1cookies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all cookies of a consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/cookies"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all cookies of a consent category"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1cookies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/consent-categories/{consentCategoryId}/cookies","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/consent-categories/{consentCategoryId}/cookies","href":"consent-categories/getconsentcategorycookieentries","openApiOperationId":"getConsentCategoryCookieEntries","summary":"Get all cookies of a consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cookies setup in a consent category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_CookieEntryResponseDTO"}},"schemaId":"components/schemas/ConsentCategory_CookieEntryResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1cookies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategory_CookieEntryResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_CookieEntryResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/getconsentcategorycookieentries"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/cookies"},{"label":"Patch consent category cookie entries","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/patchconsentcategorycookieentries","routeSlug":"/openapi/combined.openapi/consent-categories/patchconsentcategorycookieentries","metadata":{"seo":{"title":"Patch consent category cookie entries","description":"PATCH /v3/consent-categories/{consentCategoryId}/cookies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConsentCategoryCookieEntries","name":"Patch consent category cookie entries","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1cookies/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch consent category cookie entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/cookies"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"patch a consent category cookie entry"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1cookies/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/PatchDocument_RequestDTO"}},"schemaId":"components/schemas/PatchDocument_RequestDTO","pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1cookies/patch/requestBody","description":"JSON Object of Consent Category"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/consent-categories/{consentCategoryId}/cookies","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/PatchDocument_RequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/cookies","href":"consent-categories/patchconsentcategorycookieentries","openApiOperationId":"patchConsentCategoryCookieEntries","summary":"Patch consent category cookie entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/PatchDocument_RequestDTO","mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/PatchDocument_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully patched a Consent Preference Cookie Entry","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_CookieEntryResponseDTO"}},"schemaId":"components/schemas/ConsentCategory_CookieEntryResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1cookies/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategory_CookieEntryResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_CookieEntryResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/patchconsentcategorycookieentries"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/cookies"},{"label":"Get audits assigned to the consent category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/getconsentcategoryaudits","routeSlug":"/openapi/combined.openapi/consent-categories/getconsentcategoryaudits","metadata":{"seo":{"title":"Get audits assigned to the consent category","description":"GET /v3/consent-categories/{consentCategoryId}/web-audits"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConsentCategoryAudits","name":"Get audits assigned to the consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1web-audits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get audits assigned to the consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/web-audits"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get audits assigned to the consent category"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1web-audits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/consent-categories/{consentCategoryId}/web-audits","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/web-audits","href":"consent-categories/getconsentcategoryaudits","openApiOperationId":"getConsentCategoryAudits","summary":"Get audits assigned to the consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web audits assigned to the consent category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_WebAudits_ResponseDTO"}},"schemaId":"components/schemas/ConsentCategory_WebAudits_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1web-audits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategory_WebAudits_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_WebAudits_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/getconsentcategoryaudits"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/web-audits"},{"label":"Modify audit attachments","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/patchconsentcategoryaudits","routeSlug":"/openapi/combined.openapi/consent-categories/patchconsentcategoryaudits","metadata":{"seo":{"title":"Modify audit attachments","description":"PATCH /v3/consent-categories/{consentCategoryId}/web-audits"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConsentCategoryAudits","name":"Modify audit attachments","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1web-audits/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify audit attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/web-audits"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modify audit attachments"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1web-audits/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1web-audits/patch/requestBody","description":"Patch Document"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/consent-categories/{consentCategoryId}/web-audits","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/web-audits","href":"consent-categories/patchconsentcategoryaudits","openApiOperationId":"patchConsentCategoryAudits","summary":"Modify audit attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web audits assigned to the consent category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_WebAudits_ResponseDTO"}},"schemaId":"components/schemas/ConsentCategory_WebAudits_ResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1web-audits/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentCategory_WebAudits_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentCategory_WebAudits_ResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/patchconsentcategoryaudits"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/web-audits"},{"label":"Get all labels attached to specified consent category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/getconsentcategoryassignedlabels","routeSlug":"/openapi/combined.openapi/consent-categories/getconsentcategoryassignedlabels","metadata":{"seo":{"title":"Get all labels attached to specified consent category","description":"GET /v3/consent-categories/{consentCategoryId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConsentCategoryAssignedLabels","name":"Get all labels attached to specified consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all labels attached to specified consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/labels"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1labels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/consent-categories/{consentCategoryId}/labels","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/labels","href":"consent-categories/getconsentcategoryassignedlabels","openApiOperationId":"getConsentCategoryAssignedLabels","summary":"Get all labels attached to specified consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a list of consent category assigned labels.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelResponseDTO"}},"schemaId":"components/schemas/LabelResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1labels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LabelResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/getconsentcategoryassignedlabels"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/labels"},{"label":"Patch labels attached to specified consent category","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/patchconsentcategoryassignedlabels","routeSlug":"/openapi/combined.openapi/consent-categories/patchconsentcategoryassignedlabels","metadata":{"seo":{"title":"Patch labels attached to specified consent category","description":"PATCH /v3/consent-categories/{consentCategoryId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConsentCategoryAssignedLabels","name":"Patch labels attached to specified consent category","isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1labels/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch labels attached to specified consent category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{consentCategoryId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/labels"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"consentCategoryId","in":"path","schemaId":"schema_725","description":"Unique identification number for consent category item","required":true}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1labels/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1labels/patch/requestBody","description":"Patch Document"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/consent-categories/{consentCategoryId}/labels","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"consentCategoryId","in":"path","required":true,"example":3301,"schemaId":"components/schemas/ConsentCategoryId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/consent-categories/{consentCategoryId}/labels","href":"consent-categories/patchconsentcategoryassignedlabels","openApiOperationId":"patchConsentCategoryAssignedLabels","summary":"Patch labels attached to specified consent category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully patched consent category assigned labels.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelResponseDTO"}},"schemaId":"components/schemas/LabelResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1{consentCategoryId}~1labels/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LabelResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/patchconsentcategoryassignedlabels"}],"panels":[]}]},"httpPath":"/v3/consent-categories/{consentCategoryId}/labels"},{"label":"request an export of all consent categories in the account","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/consent-categories/exportconsentcategories","routeSlug":"/openapi/combined.openapi/consent-categories/exportconsentcategories","metadata":{"seo":{"title":"request an export of all consent categories in the account","description":"POST /v3/consent-categories/export"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportConsentCategories","name":"request an export of all consent categories in the account","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1consent-categories~1export/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"request an export of all consent categories in the account","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/consent-categories/export"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please, use /v3/consent-categories/exports/ACCOUNT_CONSENT_CATEGORY_CONFIGS_EXPORT instead"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/consent-categories/export","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/v3/consent-categories/export","href":"consent-categories/exportconsentcategories","openApiOperationId":"exportConsentCategories","summary":"request an export of all consent categories in the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully requested an export of consent categories"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1consent-categories~1export/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent-categories/exportconsentcategories"}],"panels":[]}]},"httpPath":"/v3/consent-categories/export"}],"content":{"contentType":"group","meta":{"name":"consent-categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consent Categories","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing Consent Categories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-audits/{auditId}/consent-categories","summary":"Get all the consent categories assigned to an audit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent-categories/getauditconsentcategories","deprecated":false},{"title":"/v3/web-audits/{auditId}/consent-categories","summary":"Update the consent categories assigned to an audit","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/consent-categories/patchauditconsentcategories","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories","summary":"Retrieve all consent categories snapshots that are applied to a specific audit run. ","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent-categories/getauditrunconsentcategories","deprecated":false},{"title":"/v3/consent-categories/upload","summary":"Create or update consent categories found in the file uploaded previously","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consent-categories/uploadconsentcategories","deprecated":false},{"title":"/v3/consent-categories/upload/preview","summary":"Upload a file with consent category configurations and preview the changes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consent-categories/uploadconsentcategoriespreview","deprecated":false},{"title":"/v3/consent-categories/library","summary":"Get all consent categories in the account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent-categories/getconsentcategorylibrary","deprecated":false},{"title":"/v3/consent-categories","summary":"Create a consent category","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consent-categories/createconsentcategories","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}","summary":"Get a consent category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent-categories/getconsentcategory","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}","summary":"Update a consent category","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consent-categories/updateconsentcategory","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}","summary":"Delete a consent category","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/consent-categories/deleteconsentcategory","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/notes","summary":"Upsert notes for the given Consent Category","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consent-categories/updateconsentcategoriesnotes","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/tags","summary":"Get all tag entries of a consent category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent-categories/getconsentcategorytags","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/tags","summary":"Patch consent category tag entries","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/consent-categories/patchconsentcategorytagentries","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/request-domains","summary":"Get all request domains of a consent category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent-categories/getconsentcategoryrequestdomains","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/request-domains","summary":"Patch consent category request domains","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/consent-categories/patchconsentcategoryrequestdomains","deprecated":false},{"title":"/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess","summary":"Reprocess consent-category for the selected auditId and runIds","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consent-categories/reprocessconsentcategories","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/cookies","summary":"Get all cookies of a consent category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent-categories/getconsentcategorycookieentries","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/cookies","summary":"Patch consent category cookie entries","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/consent-categories/patchconsentcategorycookieentries","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/web-audits","summary":"Get audits assigned to the consent category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent-categories/getconsentcategoryaudits","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/web-audits","summary":"Modify audit attachments","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/consent-categories/patchconsentcategoryaudits","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/labels","summary":"Get all labels attached to specified consent category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent-categories/getconsentcategoryassignedlabels","deprecated":false},{"title":"/v3/consent-categories/{consentCategoryId}/labels","summary":"Patch labels attached to specified consent category","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/consent-categories/patchconsentcategoryassignedlabels","deprecated":false},{"title":"/v3/consent-categories/export","summary":"request an export of all consent categories in the account","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/consent-categories/exportconsentcategories","deprecated":true}]}]}]}]}},{"type":"group","label":"Custom Headers","link":"/openapi/combined.openapi/custom-headers","routeSlug":"/openapi/combined.openapi/custom-headers","items":[{"label":"Get all custom header groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/custom-headers/getcustomheadergroupsummary","routeSlug":"/openapi/combined.openapi/custom-headers/getcustomheadergroupsummary","metadata":{"seo":{"title":"Get all custom header groups","description":"GET /v3/custom-headers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomHeaderGroupSummary","name":"Get all custom header groups","isWebhook":false,"pointer":"/paths/~1v3~1custom-headers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all custom header groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/custom-headers"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/custom-headers","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/custom-headers","href":"custom-headers/getcustomheadergroupsummary","openApiOperationId":"getCustomHeaderGroupSummary","summary":"Get all custom header groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderGroupSummaryResponse"}},"schemaId":"components/schemas/CustomHeaderGroupSummaryResponse"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1custom-headers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomHeaderGroupSummaryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderGroupSummaryResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-headers/getcustomheadergroupsummary"}],"panels":[]}]},"httpPath":"/v3/custom-headers"},{"label":"Create a custom header group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/custom-headers/createcustomheadergroup","routeSlug":"/openapi/combined.openapi/custom-headers/createcustomheadergroup","metadata":{"seo":{"title":"Create a custom header group","description":"POST /v3/custom-headers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomHeaderGroup","name":"Create a custom header group","isWebhook":false,"pointer":"/paths/~1v3~1custom-headers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a custom header group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/custom-headers"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}},"schemaId":"components/schemas/CustomHeaderBody","pointer":"/paths/~1v3~1custom-headers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/custom-headers","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}},"responseCodes":["200","401","403"],"pointer":"/v3/custom-headers","href":"custom-headers/createcustomheadergroup","openApiOperationId":"createCustomHeaderGroup","summary":"Create a custom header group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CustomHeaderBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}},"schemaId":"components/schemas/CustomHeaderBody"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1custom-headers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomHeaderBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-headers/createcustomheadergroup"}],"panels":[]}]},"httpPath":"/v3/custom-headers"},{"label":"Get a custom header group by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/custom-headers/getcustomheadergroupbyid","routeSlug":"/openapi/combined.openapi/custom-headers/getcustomheadergroupbyid","metadata":{"seo":{"title":"Get a custom header group by ID","description":"GET /v3/custom-headers/{customHeaderGroupId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomHeaderGroupById","name":"Get a custom header group by ID","isWebhook":false,"pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a custom header group by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/custom-headers/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{customHeaderGroupId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customHeaderGroupId","in":"path","schemaId":"components/schemas/ReceivedEmailMessageId","description":"Unique identification number for custom header group","required":true}],"pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/custom-headers/{customHeaderGroupId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"customHeaderGroupId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/custom-headers/{customHeaderGroupId}","href":"custom-headers/getcustomheadergroupbyid","openApiOperationId":"getCustomHeaderGroupById","summary":"Get a custom header group by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}},"schemaId":"components/schemas/CustomHeaderBody"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomHeaderBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-headers/getcustomheadergroupbyid"}],"panels":[]}]},"httpPath":"/v3/custom-headers/{customHeaderGroupId}"},{"label":"Update a custom header group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/custom-headers/updatecustomheadergroup","routeSlug":"/openapi/combined.openapi/custom-headers/updatecustomheadergroup","metadata":{"seo":{"title":"Update a custom header group","description":"PUT /v3/custom-headers/{customHeaderGroupId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomHeaderGroup","name":"Update a custom header group","isWebhook":false,"pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a custom header group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/custom-headers/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{customHeaderGroupId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customHeaderGroupId","in":"path","schemaId":"components/schemas/ReceivedEmailMessageId","description":"Unique identification number for custom header group","required":true}],"pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}},"schemaId":"components/schemas/CustomHeaderBody","pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/custom-headers/{customHeaderGroupId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"customHeaderGroupId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/custom-headers/{customHeaderGroupId}","href":"custom-headers/updatecustomheadergroup","openApiOperationId":"updateCustomHeaderGroup","summary":"Update a custom header group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CustomHeaderBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}},"schemaId":"components/schemas/CustomHeaderBody"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomHeaderBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderBody"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-headers/updatecustomheadergroup"}],"panels":[]}]},"httpPath":"/v3/custom-headers/{customHeaderGroupId}"},{"label":"Delete a custom header group by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/custom-headers/deletecustomheadergroupbyid","routeSlug":"/openapi/combined.openapi/custom-headers/deletecustomheadergroupbyid","metadata":{"seo":{"title":"Delete a custom header group by ID","description":"DELETE /v3/custom-headers/{customHeaderGroupId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomHeaderGroupById","name":"Delete a custom header group by ID","isWebhook":false,"pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom header group by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/custom-headers/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{customHeaderGroupId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customHeaderGroupId","in":"path","schemaId":"components/schemas/ReceivedEmailMessageId","description":"Unique identification number for custom header group","required":true}],"pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/custom-headers/{customHeaderGroupId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"customHeaderGroupId","in":"path","required":true,"schemaId":"components/schemas/ReceivedEmailMessageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/v3/custom-headers/{customHeaderGroupId}","href":"custom-headers/deletecustomheadergroupbyid","openApiOperationId":"deleteCustomHeaderGroupById","summary":"Delete a custom header group by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1custom-headers~1{customHeaderGroupId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-headers/deletecustomheadergroupbyid"}],"panels":[]}]},"httpPath":"/v3/custom-headers/{customHeaderGroupId}"},{"label":"Search for target items (audits or web journeys) for custom header assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/custom-headers/searchcustomheadertargetitems","routeSlug":"/openapi/combined.openapi/custom-headers/searchcustomheadertargetitems","metadata":{"seo":{"title":"Search for target items (audits or web journeys) for custom header assignment","description":"POST /v3/custom-headers/target-items/{itemType}/search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchCustomHeaderTargetItems","name":"Search for target items (audits or web journeys) for custom header assignment","isWebhook":false,"pointer":"/paths/~1v3~1custom-headers~1target-items~1{itemType}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for target items (audits or web journeys) for custom header assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/custom-headers/target-items/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{itemType}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/search"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemType","in":"path","schemaId":"schema_727","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of items to search for (AUDIT or WEB_JOURNEY)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1custom-headers~1target-items~1{itemType}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_728"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"pageSize","in":"query","schemaId":"schema_608"},{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"}],"pointer":"/paths/~1v3~1custom-headers~1target-items~1{itemType}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomHeaderTargetItemsSearchRequest"}},"schemaId":"components/schemas/CustomHeaderTargetItemsSearchRequest","pointer":"/paths/~1v3~1custom-headers~1target-items~1{itemType}~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/custom-headers/target-items/{itemType}/search","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"itemType","in":"path","required":true,"schemaId":"components/schemas/DataSourceItemTypeCap"}],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/CustomHeaderSortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomHeaderTargetItemsSearchRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/custom-headers/target-items/{itemType}/search","href":"custom-headers/searchcustomheadertargetitems","openApiOperationId":"searchCustomHeaderTargetItems","summary":"Search for target items (audits or web journeys) for custom header assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CustomHeaderTargetItemsSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomHeaderTargetItemsSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderTargetItemsSearchResponse"}},"schemaId":"components/schemas/CustomHeaderTargetItemsSearchResponse"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1custom-headers~1target-items~1{itemType}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomHeaderTargetItemsSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomHeaderTargetItemsSearchResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-headers/searchcustomheadertargetitems"}],"panels":[]}]},"httpPath":"/v3/custom-headers/target-items/{itemType}/search"}],"content":{"contentType":"group","meta":{"name":"custom-headers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Headers","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing custom HTTP header groups"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/custom-headers","summary":"Get all custom header groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-headers/getcustomheadergroupsummary","deprecated":false},{"title":"/v3/custom-headers","summary":"Create a custom header group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-headers/createcustomheadergroup","deprecated":false},{"title":"/v3/custom-headers/{customHeaderGroupId}","summary":"Get a custom header group by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-headers/getcustomheadergroupbyid","deprecated":false},{"title":"/v3/custom-headers/{customHeaderGroupId}","summary":"Update a custom header group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-headers/updatecustomheadergroup","deprecated":false},{"title":"/v3/custom-headers/{customHeaderGroupId}","summary":"Delete a custom header group by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-headers/deletecustomheadergroupbyid","deprecated":false},{"title":"/v3/custom-headers/target-items/{itemType}/search","summary":"Search for target items (audits or web journeys) for custom header assignment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-headers/searchcustomheadertargetitems","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Sources","link":"/openapi/combined.openapi/data-sources","routeSlug":"/openapi/combined.openapi/data-sources","items":[{"label":"Get all data sources in the account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/data-sources/getdatasources","routeSlug":"/openapi/combined.openapi/data-sources/getdatasources","metadata":{"seo":{"title":"Get all data sources in the account","description":"GET /v3/data-sources"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataSources","name":"Get all data sources in the account","isWebhook":false,"pointer":"/paths/~1v3~1data-sources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all data sources in the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/data-sources"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this endpoint is get all the data sources in the account with their labels"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_729"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"itemName","in":"query","schemaId":"schema_627","description":"filter the items by a given name"},{"name":"labelIds","in":"query","schemaId":"schema_721","description":"filter the items by label ids"},{"name":"itemType","in":"query","schemaId":"schema_730","description":"filter the items by a given item type"},{"name":"withRuns","in":"query","schemaId":"schema_625","description":"if true - response will only include data sources that have at least one run, if false - only data sources that have no runs. All data sources if not set."},{"name":"withLabels","in":"query","schemaId":"schema_731","description":"if true - response will include labels for each data source, if false - only the data source id. All data sources if not set. Disabling labels will improve performance."},{"name":"withConsentCategories","in":"query","schemaId":"schema_731","description":"if true - response will include consent categories. Disabling this will improve performance."}],"pointer":"/paths/~1v3~1data-sources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/data-sources","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/DataSourceSortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"itemName","in":"query","required":false,"schemaId":"schema_627"},{"name":"labelIds","in":"query","required":false,"schemaId":"schema_721"},{"name":"itemType","in":"query","required":false,"schemaId":"components/schemas/DataSourceItemType"},{"name":"withRuns","in":"query","required":false,"schemaId":"schema_625"},{"name":"withLabels","in":"query","required":false,"schemaId":"schema_731"},{"name":"withConsentCategories","in":"query","required":false,"schemaId":"schema_731"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v3/data-sources","href":"data-sources/getdatasources","openApiOperationId":"getDataSources","summary":"Get all data sources in the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieve user events in the account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourcesResult"}},"schemaId":"components/schemas/DataSourcesResult"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1data-sources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourcesResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourcesResult"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-sources/getdatasources"}],"panels":[]}]},"httpPath":"/v3/data-sources"},{"label":"Search data sources with specific item IDs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/data-sources/getdatasourceswithitemids","routeSlug":"/openapi/combined.openapi/data-sources/getdatasourceswithitemids","metadata":{"seo":{"title":"Search data sources with specific item IDs","description":"POST /v3/data-sources/search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataSourcesWithItemIds","name":"Search data sources with specific item IDs","isWebhook":false,"pointer":"/paths/~1v3~1data-sources~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search data sources with specific item IDs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/data-sources/search"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves all the data sources in the account with their labels."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_729"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1data-sources~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_732"}},"schemaId":"schema_732","pointer":"/paths/~1v3~1data-sources~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/data-sources/search","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/DataSourceSortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_732"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/data-sources/search","href":"data-sources/getdatasourceswithitemids","openApiOperationId":"getDataSourcesWithItemIds","summary":"Search data sources with specific item IDs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_732","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_732"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieve user events in the account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourcesResult"}},"schemaId":"components/schemas/DataSourcesResult"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1data-sources~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourcesResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourcesResult"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-sources/getdatasourceswithitemids"}],"panels":[]}]},"httpPath":"/v3/data-sources/search"},{"label":"Search for target items (audits or web journeys) for data source assignment based on searched item type (ALERT, CUSTOM_HEADER, EMAIL_INBOX, RULE)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/data-sources/searchdatasourcestargetitems","routeSlug":"/openapi/combined.openapi/data-sources/searchdatasourcestargetitems","metadata":{"seo":{"title":"Search for target items (audits or web journeys) for data source assignment based on searched item type (ALERT, CUSTOM_HEADER, EMAIL_INBOX, RULE)","description":"POST /v3/data-sources/target-items/{itemType}/search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchDataSourcesTargetItems","name":"Search for target items (audits or web journeys) for data source assignment based on searched item type (ALERT, CUSTOM_HEADER, EMAIL_INBOX, RULE)","isWebhook":false,"pointer":"/paths/~1v3~1data-sources~1target-items~1{itemType}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for target items (audits or web journeys) for data source assignment based on searched item type (ALERT, CUSTOM_HEADER, EMAIL_INBOX, RULE)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/data-sources/target-items/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{itemType}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/search"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemType","in":"path","schemaId":"schema_727","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of items to search for (AUDIT or WEB_JOURNEY)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1data-sources~1target-items~1{itemType}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_733"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"pageSize","in":"query","schemaId":"schema_608"},{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"}],"pointer":"/paths/~1v3~1data-sources~1target-items~1{itemType}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataSourcesTargetItemsSearchRequest"}},"schemaId":"components/schemas/DataSourcesTargetItemsSearchRequest","pointer":"/paths/~1v3~1data-sources~1target-items~1{itemType}~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/data-sources/target-items/{itemType}/search","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"itemType","in":"path","required":true,"schemaId":"components/schemas/DataSourceItemTypeCap"}],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/DataSourceTargetItemSortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataSourcesTargetItemsSearchRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/data-sources/target-items/{itemType}/search","href":"data-sources/searchdatasourcestargetitems","openApiOperationId":"searchDataSourcesTargetItems","summary":"Search for target items (audits or web journeys) for data source assignment based on searched item type (ALERT, CUSTOM_HEADER, EMAIL_INBOX, RULE)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/DataSourcesTargetItemsSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataSourcesTargetItemsSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourcesTargetItemsSearchResponse"}},"schemaId":"components/schemas/DataSourcesTargetItemsSearchResponse"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1data-sources~1target-items~1{itemType}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourcesTargetItemsSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourcesTargetItemsSearchResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-sources/searchdatasourcestargetitems"}],"panels":[]}]},"httpPath":"/v3/data-sources/target-items/{itemType}/search"}],"content":{"contentType":"group","meta":{"name":"data-sources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Sources","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing Data Sources"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/data-sources","summary":"Get all data sources in the account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-sources/getdatasources","deprecated":false},{"title":"/v3/data-sources/search","summary":"Search data sources with specific item IDs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-sources/getdatasourceswithitemids","deprecated":false},{"title":"/v3/data-sources/target-items/{itemType}/search","summary":"Search for target items (audits or web journeys) for data source assignment based on searched item type (ALERT, CUSTOM_HEADER, EMAIL_INBOX, RULE)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-sources/searchdatasourcestargetitems","deprecated":false}]}]}]}]}},{"type":"group","label":"Geo Locations","link":"/openapi/combined.openapi/geo-locations","routeSlug":"/openapi/combined.openapi/geo-locations","items":[{"label":"Get all available countries for geo-location filtering","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/geo-locations/getgeolocationcountries","routeSlug":"/openapi/combined.openapi/geo-locations/getgeolocationcountries","metadata":{"seo":{"title":"Get all available countries for geo-location filtering","description":"GET /v3/geo-locations/countries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGeoLocationCountries","name":"Get all available countries for geo-location filtering","isWebhook":false,"pointer":"/paths/~1v3~1geo-locations~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all available countries for geo-location filtering","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/geo-locations/countries"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a list of all available countries with their associated continent information for use in geo-location based filtering"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/geo-locations/countries","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/geo-locations/countries","href":"geo-locations/getgeolocationcountries","openApiOperationId":"getGeoLocationCountries","summary":"Get all available countries for geo-location filtering"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of countries with geo-location information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_734"}},"schemaId":"schema_734"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1geo-locations~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_734","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_734"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/geo-locations/getgeolocationcountries"}],"panels":[]}]},"httpPath":"/v3/geo-locations/countries"}],"content":{"contentType":"group","meta":{"name":"geo-locations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Geo Locations","showPageActions":true},{"nodeType":"markdoc","content":"APIs for geo locations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/geo-locations/countries","summary":"Get all available countries for geo-location filtering","prefix":{"name":"get","color":"get"},"badges":[],"link":"/geo-locations/getgeolocationcountries","deprecated":false}]}]}]}]}},{"type":"group","label":"Notification Center","link":"/openapi/combined.openapi/notification-center","routeSlug":"/openapi/combined.openapi/notification-center","items":[{"label":"Get all emails in an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/notification-center/getnotificationcenteremails","routeSlug":"/openapi/combined.openapi/notification-center/getnotificationcenteremails","metadata":{"seo":{"title":"Get all emails in an account","description":"GET /v3/notification-center/emails"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNotificationCenterEmails","name":"Get all emails in an account","isWebhook":false,"pointer":"/paths/~1v3~1notification-center~1emails/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all emails in an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/notification-center/emails"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/notification-center/emails","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/notification-center/emails","href":"notification-center/getnotificationcenteremails","openApiOperationId":"getNotificationCenterEmails","summary":"Get all emails in an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All emails in account, their usage and corresponding users","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationCenter_GetEmails_ResponseDTO"}},"schemaId":"components/schemas/NotificationCenter_GetEmails_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1notification-center~1emails/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationCenter_GetEmails_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationCenter_GetEmails_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-center/getnotificationcenteremails"}],"panels":[]}]},"httpPath":"/v3/notification-center/emails"},{"label":"Get emails subscribed to given items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/notification-center/getnotificationcenteremailssubscribedtoitems","routeSlug":"/openapi/combined.openapi/notification-center/getnotificationcenteremailssubscribedtoitems","metadata":{"seo":{"title":"Get emails subscribed to given items","description":"POST /v3/notification-center/emails"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNotificationCenterEmailsSubscribedToItems","name":"Get emails subscribed to given items","isWebhook":false,"pointer":"/paths/~1v3~1notification-center~1emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get emails subscribed to given items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/notification-center/emails"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationCenter_GetEmails_RequestDTO"}},"schemaId":"components/schemas/NotificationCenter_GetEmails_RequestDTO","pointer":"/paths/~1v3~1notification-center~1emails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/notification-center/emails","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NotificationCenter_GetEmails_RequestDTO"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/notification-center/emails","href":"notification-center/getnotificationcenteremailssubscribedtoitems","openApiOperationId":"getNotificationCenterEmailsSubscribedToItems","summary":"Get emails subscribed to given items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/NotificationCenter_GetEmails_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationCenter_GetEmails_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of emails subscribed to given items that accessible by user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationCenter_GetEmails_ResponseDTO"}},"schemaId":"components/schemas/NotificationCenter_GetEmails_ResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1notification-center~1emails/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationCenter_GetEmails_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationCenter_GetEmails_ResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-center/getnotificationcenteremailssubscribedtoitems"}],"panels":[]}]},"httpPath":"/v3/notification-center/emails"},{"label":"Search assignable items (audits, journeys, rules etc) for specified email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/notification-center/searchtargetitemsforemails","routeSlug":"/openapi/combined.openapi/notification-center/searchtargetitemsforemails","metadata":{"seo":{"title":"Search assignable items (audits, journeys, rules etc) for specified email","description":"POST /v3/notification-center/target-items/{itemType}/search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchTargetItemsForEmails","name":"Search assignable items (audits, journeys, rules etc) for specified email","isWebhook":false,"pointer":"/paths/~1v3~1notification-center~1target-items~1{itemType}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search assignable items (audits, journeys, rules etc) for specified email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/notification-center/target-items/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{itemType}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/search"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemType","in":"path","schemaId":"schema_735","required":true}],"pointer":"/paths/~1v3~1notification-center~1target-items~1{itemType}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_736"},{"name":"page","in":"query","schemaId":"schema_596","description":"Page number, starts with 0"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1notification-center~1target-items~1{itemType}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationCenter_SearchForAssignments_RequestDTO"}},"schemaId":"components/schemas/NotificationCenter_SearchForAssignments_RequestDTO","pointer":"/paths/~1v3~1notification-center~1target-items~1{itemType}~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/notification-center/target-items/{itemType}/search","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"itemType","in":"path","required":true,"schemaId":"components/schemas/NotificationCenter_AssignmentItemTypeEnum"}],"query":[{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/AlertAssignmentsSortColumn"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NotificationCenter_SearchForAssignments_RequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/notification-center/target-items/{itemType}/search","href":"notification-center/searchtargetitemsforemails","openApiOperationId":"searchTargetItemsForEmails","summary":"Search assignable items (audits, journeys, rules etc) for specified email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/NotificationCenter_SearchForAssignments_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationCenter_SearchForAssignments_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Items that have specified email both assigned and not assigned","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationCenter_SearchForAssignments_ResponseDTO"}},"schemaId":"components/schemas/NotificationCenter_SearchForAssignments_ResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1notification-center~1target-items~1{itemType}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationCenter_SearchForAssignments_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationCenter_SearchForAssignments_ResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-center/searchtargetitemsforemails"}],"panels":[]}]},"httpPath":"/v3/notification-center/target-items/{itemType}/search"}],"content":{"contentType":"group","meta":{"name":"notification-center"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Center","showPageActions":true},{"nodeType":"markdoc","content":"Find and manage email subscriptions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/notification-center/emails","summary":"Get all emails in an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notification-center/getnotificationcenteremails","deprecated":false},{"title":"/v3/notification-center/emails","summary":"Get emails subscribed to given items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notification-center/getnotificationcenteremailssubscribedtoitems","deprecated":false},{"title":"/v3/notification-center/target-items/{itemType}/search","summary":"Search assignable items (audits, journeys, rules etc) for specified email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notification-center/searchtargetitemsforemails","deprecated":false}]}]}]}]}},{"type":"group","label":"Remote File Mappings","link":"/openapi/combined.openapi/remote-file-mappings","routeSlug":"/openapi/combined.openapi/remote-file-mappings","items":[{"label":"Get remote file mappings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/remote-file-mappings/getremotefilemappings","routeSlug":"/openapi/combined.openapi/remote-file-mappings/getremotefilemappings","metadata":{"seo":{"title":"Get remote file mappings","description":"GET /v3/remote-file-mappings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRemoteFileMappings","name":"Get remote file mappings","isWebhook":false,"pointer":"/paths/~1v3~1remote-file-mappings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get remote file mappings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/remote-file-mappings"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all remote file mappings with optional account filtering"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountId","in":"query","schemaId":"schema_737","description":"Filter by account ID"}],"pointer":"/paths/~1v3~1remote-file-mappings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/remote-file-mappings","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"accountId","in":"query","required":false,"example":123,"schemaId":"schema_737"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/remote-file-mappings","href":"remote-file-mappings/getremotefilemappings","openApiOperationId":"getRemoteFileMappings","summary":"Get remote file mappings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of remote file mappings retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_738"}},"schemaId":"schema_738"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1remote-file-mappings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_738","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_738"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remote-file-mappings/getremotefilemappings"}],"panels":[]}]},"httpPath":"/v3/remote-file-mappings"},{"label":"Create remote file mapping","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/remote-file-mappings/createremotefilemapping","routeSlug":"/openapi/combined.openapi/remote-file-mappings/createremotefilemapping","metadata":{"seo":{"title":"Create remote file mapping","description":"POST /v3/remote-file-mappings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRemoteFileMapping","name":"Create remote file mapping","isWebhook":false,"pointer":"/paths/~1v3~1remote-file-mappings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create remote file mapping","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/remote-file-mappings"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new remote file mapping configuration"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountId","in":"query","schemaId":"schema_737","description":"Account ID to create the mapping for"}],"pointer":"/paths/~1v3~1remote-file-mappings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoteFileMappingRequest"}},"schemaId":"components/schemas/RemoteFileMappingRequest","pointer":"/paths/~1v3~1remote-file-mappings/post/requestBody","description":"Remote file mapping data for creation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/remote-file-mappings","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"accountId","in":"query","required":false,"example":123,"schemaId":"schema_737"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RemoteFileMappingRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/remote-file-mappings","href":"remote-file-mappings/createremotefilemapping","openApiOperationId":"createRemoteFileMapping","summary":"Create remote file mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/RemoteFileMappingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoteFileMappingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Remote file mapping created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoteFileMapping"}},"schemaId":"components/schemas/RemoteFileMapping"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1remote-file-mappings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RemoteFileMapping","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoteFileMapping"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remote-file-mappings/createremotefilemapping"}],"panels":[]}]},"httpPath":"/v3/remote-file-mappings"},{"label":"Get remote file mapping by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/remote-file-mappings/getremotefilemapping","routeSlug":"/openapi/combined.openapi/remote-file-mappings/getremotefilemapping","metadata":{"seo":{"title":"Get remote file mapping by ID","description":"GET /v3/remote-file-mappings/{rfmId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRemoteFileMapping","name":"Get remote file mapping by ID","isWebhook":false,"pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get remote file mapping by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/remote-file-mappings/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{rfmId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a specific remote file mapping by its ID"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rfmId","in":"path","schemaId":"schema_739","description":"The ID of the remote file mapping","required":true}],"pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/remote-file-mappings/{rfmId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"rfmId","in":"path","required":true,"example":123,"schemaId":"schema_739"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/remote-file-mappings/{rfmId}","href":"remote-file-mappings/getremotefilemapping","openApiOperationId":"getRemoteFileMapping","summary":"Get remote file mapping by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Remote file mapping retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoteFileMapping"}},"schemaId":"components/schemas/RemoteFileMapping"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RemoteFileMapping","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoteFileMapping"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remote-file-mappings/getremotefilemapping"}],"panels":[]}]},"httpPath":"/v3/remote-file-mappings/{rfmId}"},{"label":"Update remote file mapping","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/remote-file-mappings/updateremotefilemapping","routeSlug":"/openapi/combined.openapi/remote-file-mappings/updateremotefilemapping","metadata":{"seo":{"title":"Update remote file mapping","description":"PUT /v3/remote-file-mappings/{rfmId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRemoteFileMapping","name":"Update remote file mapping","isWebhook":false,"pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update remote file mapping","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/remote-file-mappings/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{rfmId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing remote file mapping"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rfmId","in":"path","schemaId":"schema_739","description":"The ID of the remote file mapping","required":true}],"pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoteFileMappingRequest"}},"schemaId":"components/schemas/RemoteFileMappingRequest","pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/put/requestBody","description":"Updated remote file mapping data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/remote-file-mappings/{rfmId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"rfmId","in":"path","required":true,"example":123,"schemaId":"schema_739"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RemoteFileMappingRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/remote-file-mappings/{rfmId}","href":"remote-file-mappings/updateremotefilemapping","openApiOperationId":"updateRemoteFileMapping","summary":"Update remote file mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/RemoteFileMappingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoteFileMappingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Remote file mapping updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoteFileMapping"}},"schemaId":"components/schemas/RemoteFileMapping"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RemoteFileMapping","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoteFileMapping"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remote-file-mappings/updateremotefilemapping"}],"panels":[]}]},"httpPath":"/v3/remote-file-mappings/{rfmId}"},{"label":"Delete remote file mapping","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/remote-file-mappings/deleteremotefilemapping","routeSlug":"/openapi/combined.openapi/remote-file-mappings/deleteremotefilemapping","metadata":{"seo":{"title":"Delete remote file mapping","description":"DELETE /v3/remote-file-mappings/{rfmId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRemoteFileMapping","name":"Delete remote file mapping","isWebhook":false,"pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete remote file mapping","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/remote-file-mappings/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{rfmId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a specific remote file mapping by its ID"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rfmId","in":"path","schemaId":"schema_739","description":"The ID of the remote file mapping","required":true}],"pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/remote-file-mappings/{rfmId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"rfmId","in":"path","required":true,"example":123,"schemaId":"schema_739"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/v3/remote-file-mappings/{rfmId}","href":"remote-file-mappings/deleteremotefilemapping","openApiOperationId":"deleteRemoteFileMapping","summary":"Delete remote file mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Remote file mapping deleted successfully"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1remote-file-mappings~1{rfmId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remote-file-mappings/deleteremotefilemapping"}],"panels":[]}]},"httpPath":"/v3/remote-file-mappings/{rfmId}"}],"content":{"contentType":"group","meta":{"name":"remote-file-mappings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remote File Mappings","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing Remote File Mappings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/remote-file-mappings","summary":"Get remote file mappings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/remote-file-mappings/getremotefilemappings","deprecated":false},{"title":"/v3/remote-file-mappings","summary":"Create remote file mapping","prefix":{"name":"post","color":"post"},"badges":[],"link":"/remote-file-mappings/createremotefilemapping","deprecated":false},{"title":"/v3/remote-file-mappings/{rfmId}","summary":"Get remote file mapping by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/remote-file-mappings/getremotefilemapping","deprecated":false},{"title":"/v3/remote-file-mappings/{rfmId}","summary":"Update remote file mapping","prefix":{"name":"put","color":"put"},"badges":[],"link":"/remote-file-mappings/updateremotefilemapping","deprecated":false},{"title":"/v3/remote-file-mappings/{rfmId}","summary":"Delete remote file mapping","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/remote-file-mappings/deleteremotefilemapping","deprecated":false}]}]}]}]}},{"type":"group","label":"Rules","link":"/openapi/combined.openapi/rules","routeSlug":"/openapi/combined.openapi/rules","items":[{"label":"Get all rules in an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/rules/getrulelibraryrules","routeSlug":"/openapi/combined.openapi/rules/getrulelibraryrules","metadata":{"seo":{"title":"Get all rules in an account","description":"POST /v3/rule-library"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRuleLibraryRules","name":"Get all rules in an account","isWebhook":false,"pointer":"/paths/~1v3~1rule-library/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all rules in an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/rule-library"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"size","in":"query","schemaId":"schema_597"},{"name":"sortBy","in":"query","schemaId":"schema_740"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1rule-library/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RuleLibrary_RequestDTO"}},"schemaId":"components/schemas/RuleLibrary_RequestDTO","pointer":"/paths/~1v3~1rule-library/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/rule-library","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"size","in":"query","required":false,"schemaId":"schema_597"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/RuleLibrary_SortColumn"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RuleLibrary_RequestDTO"}},"responseCodes":["200","400","401"],"pointer":"/v3/rule-library","href":"rules/getrulelibraryrules","openApiOperationId":"getRuleLibraryRules","summary":"Get all rules in an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/RuleLibrary_RequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RuleLibrary_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rules","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RuleLibrary_ResponseDTO"}},"schemaId":"components/schemas/RuleLibrary_ResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1rule-library/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RuleLibrary_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RuleLibrary_ResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getrulelibraryrules"}],"panels":[]}]},"httpPath":"/v3/rule-library"}],"content":{"contentType":"group","meta":{"name":"rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rules","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing rules"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/rule-library","summary":"Get all rules in an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rules/getrulelibraryrules","deprecated":false}]}]}]}]}},{"type":"group","label":"Schedules","link":"/openapi/combined.openapi/schedules","routeSlug":"/openapi/combined.openapi/schedules","items":[{"label":"Get all schedule presets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/schedules/getschedulepresets","routeSlug":"/openapi/combined.openapi/schedules/getschedulepresets","metadata":{"seo":{"title":"Get all schedule presets","description":"GET /v3/schedules/presets"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchedulePresets","name":"Get all schedule presets","isWebhook":false,"pointer":"/paths/~1v3~1schedules~1presets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all schedule presets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/schedules/presets"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/schedules/presets","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/schedules/presets","href":"schedules/getschedulepresets","openApiOperationId":"getSchedulePresets","summary":"Get all schedule presets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_741"}},"schemaId":"schema_741"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1schedules~1presets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_741","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_741"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedules/getschedulepresets"}],"panels":[]}]},"httpPath":"/v3/schedules/presets"},{"label":"Generate a description of a schedule's recurrence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/schedules/createrecurrenceruledescription","routeSlug":"/openapi/combined.openapi/schedules/createrecurrenceruledescription","metadata":{"seo":{"title":"Generate a description of a schedule's recurrence","description":"POST /v3/schedules/rule-description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRecurrenceRuleDescription","name":"Generate a description of a schedule's recurrence","isWebhook":false,"pointer":"/paths/~1v3~1schedules~1rule-description/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a description of a schedule's recurrence","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/schedules/rule-description"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ScheduleRuleDescriptionRequest"}},"schemaId":"components/schemas/ScheduleRuleDescriptionRequest","pointer":"/paths/~1v3~1schedules~1rule-description/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/schedules/rule-description","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ScheduleRuleDescriptionRequest"}},"responseCodes":["200","401","403"],"pointer":"/v3/schedules/rule-description","href":"schedules/createrecurrenceruledescription","openApiOperationId":"createRecurrenceRuleDescription","summary":"Generate a description of a schedule's recurrence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/ScheduleRuleDescriptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ScheduleRuleDescriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduleRuleDescriptionResponse"}},"schemaId":"components/schemas/ScheduleRuleDescriptionResponse"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1schedules~1rule-description/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ScheduleRuleDescriptionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduleRuleDescriptionResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedules/createrecurrenceruledescription"}],"panels":[]}]},"httpPath":"/v3/schedules/rule-description"},{"label":"Calculate future occurrences based on the new schedules and the old frequencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/schedules/calendarget","routeSlug":"/openapi/combined.openapi/schedules/calendarget","metadata":{"seo":{"title":"Calculate future occurrences based on the new schedules and the old frequencies","description":"GET /v3/schedules/calendar"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"calendarGet","name":"Calculate future occurrences based on the new schedules and the old frequencies","isWebhook":false,"pointer":"/paths/~1v3~1schedules~1calendar/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calculate future occurrences based on the new schedules and the old frequencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/schedules/calendar"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"localStartDateTime","in":"query","schemaId":"schema_742"},{"name":"localEndDateTime","in":"query","schemaId":"schema_742"}],"pointer":"/paths/~1v3~1schedules~1calendar/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/schedules/calendar","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"localStartDateTime","in":"query","required":false,"schemaId":"components/schemas/ISO8601LocalDateTime"},{"name":"localEndDateTime","in":"query","required":false,"schemaId":"components/schemas/ISO8601LocalDateTime"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v3/schedules/calendar","href":"schedules/calendarget","openApiOperationId":"calendarGet","summary":"Calculate future occurrences based on the new schedules and the old frequencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Get all data sources scheduled and future occurrences for provided params.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}},"schemaId":"schema_743"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1schedules~1calendar/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_743","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedules/calendarget"}],"panels":[]}]},"httpPath":"/v3/schedules/calendar"},{"label":"Update calendar items' schedules using this endpoint.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/schedules/calendarput","routeSlug":"/openapi/combined.openapi/schedules/calendarput","metadata":{"seo":{"title":"Update calendar items' schedules using this endpoint.","description":"PUT /v3/schedules/calendar"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"calendarPut","name":"Update calendar items' schedules using this endpoint.","isWebhook":false,"pointer":"/paths/~1v3~1schedules~1calendar/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update calendar items' schedules using this endpoint.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/schedules/calendar"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CalendarUpdateRequestBody"}},"schemaId":"components/schemas/CalendarUpdateRequestBody","pointer":"/paths/~1v3~1schedules~1calendar/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/schedules/calendar","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CalendarUpdateRequestBody"}},"responseCodes":["204","400","401","403"],"pointer":"/v3/schedules/calendar","href":"schedules/calendarput","openApiOperationId":"calendarPut","summary":"Update calendar items' schedules using this endpoint."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/CalendarUpdateRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CalendarUpdateRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1schedules~1calendar/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedules/calendarput"}],"panels":[]}]},"httpPath":"/v3/schedules/calendar"}],"content":{"contentType":"group","meta":{"name":"schedules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedules","showPageActions":true},{"nodeType":"markdoc","content":"APIs for item schedules and calendars"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/schedules/presets","summary":"Get all schedule presets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedules/getschedulepresets","deprecated":false},{"title":"/v3/schedules/rule-description","summary":"Generate a description of a schedule's recurrence","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schedules/createrecurrenceruledescription","deprecated":false},{"title":"/v3/schedules/calendar","summary":"Calculate future occurrences based on the new schedules and the old frequencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedules/calendarget","deprecated":false},{"title":"/v3/schedules/calendar","summary":"Update calendar items' schedules using this endpoint.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/schedules/calendarput","deprecated":false}]}]}]}]}},{"type":"group","label":"Site Censuses","link":"/openapi/combined.openapi/site-censuses","routeSlug":"/openapi/combined.openapi/site-censuses","items":[{"label":"Get all censuses for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/getsitecensuses","routeSlug":"/openapi/combined.openapi/site-censuses/getsitecensuses","metadata":{"seo":{"title":"Get all censuses for an account","description":"GET /v3/site-censuses"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSiteCensuses","name":"Get all censuses for an account","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all censuses for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_744"},{"name":"sortBy","in":"query","schemaId":"schema_745"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"filterByName","in":"query","schemaId":"schema_627"}],"pointer":"/paths/~1v3~1site-censuses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/site-censuses","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_744"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/SiteCensusSortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"filterByName","in":"query","required":false,"schemaId":"schema_627"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/site-censuses","href":"site-censuses/getsitecensuses","openApiOperationId":"getSiteCensuses","summary":"Get all censuses for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusSummariesResponseDTO"}},"schemaId":"components/schemas/SiteCensusSummariesResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusSummariesResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusSummariesResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/getsitecensuses"}],"panels":[]}]},"httpPath":"/v3/site-censuses"},{"label":"Create a new site census","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/createsitecensus","routeSlug":"/openapi/combined.openapi/site-censuses/createsitecensus","metadata":{"seo":{"title":"Create a new site census","description":"POST /v3/site-censuses"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSiteCensus","name":"Create a new site census","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new site census","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteCensusBehaviorDTO"}},"schemaId":"components/schemas/SiteCensusBehaviorDTO","pointer":"/paths/~1v3~1site-censuses/post/requestBody","description":"Create a new site census"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/site-censuses","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SiteCensusBehaviorDTO"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/site-censuses","href":"site-censuses/createsitecensus","openApiOperationId":"createSiteCensus","summary":"Create a new site census"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/SiteCensusBehaviorDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteCensusBehaviorDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation, resource created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}},"schemaId":"components/schemas/SiteCensusCompleteDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusCompleteDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/createsitecensus"}],"panels":[]}]},"httpPath":"/v3/site-censuses"},{"label":"Get a site census by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/getsitecensusbyid","routeSlug":"/openapi/combined.openapi/site-censuses/getsitecensusbyid","metadata":{"seo":{"title":"Get a site census by ID","description":"GET /v3/site-censuses/{censusId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSiteCensusById","name":"Get a site census by ID","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a site census by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/site-censuses/{censusId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/site-censuses/{censusId}","href":"site-censuses/getsitecensusbyid","openApiOperationId":"getSiteCensusById","summary":"Get a site census by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation, resource found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}},"schemaId":"components/schemas/SiteCensusCompleteDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusCompleteDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/getsitecensusbyid"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}"},{"label":"Update an existing site census","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/updatesitecensusbyid","routeSlug":"/openapi/combined.openapi/site-censuses/updatesitecensusbyid","metadata":{"seo":{"title":"Update an existing site census","description":"PUT /v3/site-censuses/{censusId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSiteCensusById","name":"Update an existing site census","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing site census","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}},"schemaId":"components/schemas/SiteCensusCompleteDTO","pointer":"/paths/~1v3~1site-censuses~1{censusId}/put/requestBody","description":"Update an existing site census by ID"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/site-censuses/{censusId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/site-censuses/{censusId}","href":"site-censuses/updatesitecensusbyid","openApiOperationId":"updateSiteCensusById","summary":"Update an existing site census"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/SiteCensusCompleteDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation, resource updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}},"schemaId":"components/schemas/SiteCensusCompleteDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusCompleteDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/updatesitecensusbyid"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}"},{"label":"Delete a site census by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/deletesitecensusbyid","routeSlug":"/openapi/combined.openapi/site-censuses/deletesitecensusbyid","metadata":{"seo":{"title":"Delete a site census by ID","description":"DELETE /v3/site-censuses/{censusId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSiteCensusById","name":"Delete a site census by ID","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a site census by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/site-censuses/{censusId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v3/site-censuses/{censusId}","href":"site-censuses/deletesitecensusbyid","openApiOperationId":"deleteSiteCensusById","summary":"Delete a site census by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation, resource deleted"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/deletesitecensusbyid"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}"},{"label":"Returns a summary of the current census results data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/getsitecensuscurrentresults","routeSlug":"/openapi/combined.openapi/site-censuses/getsitecensuscurrentresults","metadata":{"seo":{"title":"Returns a summary of the current census results data","description":"GET /v3/site-censuses/{censusId}/current-results"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSiteCensusCurrentResults","name":"Returns a summary of the current census results data","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1current-results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a summary of the current census results data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/current-results"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1current-results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_747"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"},{"name":"searchPattern","in":"query","schemaId":"schema_627","description":"Search grouping pattern to filter results"},{"name":"returnExcludedOnly","in":"query","schemaId":"schema_625","description":"Indicates that the results will only contain patterns for excluded URLs. Excluded URLs include external URLs linked from included pages, and internal URLs matching an IGNORE filter pattern."}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1current-results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/site-censuses/{censusId}/current-results","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/SiteCensusResultsSortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"},{"name":"searchPattern","in":"query","required":false,"schemaId":"schema_627"},{"name":"returnExcludedOnly","in":"query","required":false,"schemaId":"schema_625"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/site-censuses/{censusId}/current-results","href":"site-censuses/getsitecensuscurrentresults","openApiOperationId":"getSiteCensusCurrentResults","summary":"Returns a summary of the current census results data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCurrentResultsDTO"}},"schemaId":"components/schemas/SiteCensusCurrentResultsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1current-results/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusCurrentResultsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCurrentResultsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/getsitecensuscurrentresults"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}/current-results"},{"label":"Browse a host's folder tree, list every host's root, or search folders and pages across the census -- each returned folder carrying a preview of its direct URLs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/getsitecensusurlfolders","routeSlug":"/openapi/combined.openapi/site-censuses/getsitecensusurlfolders","metadata":{"seo":{"title":"Browse a host's folder tree, list every host's root, or search folders and pages across the census -- each returned folder carrying a preview of its direct URLs","description":"GET /v3/site-censuses/{censusId}/url-folders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSiteCensusUrlFolders","name":"Browse a host's folder tree, list every host's root, or search folders and pages across the census -- each returned folder carrying a preview of its direct URLs","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1url-folders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Browse a host's folder tree, list every host's root, or search folders and pages across the census -- each returned folder carrying a preview of its direct URLs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/url-folders"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In both modes every counted folder row nests a preview of its own DIRECT child URLs in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (capped at urlsPerFolder, with the uncapped total in matchedUrlCount), so one request returns a fully renderable tree level -- folders and the pages inside them -- without a follow-up call to folders/urls. That endpoint remains the way to page through a folder whose preview was truncated; it lists in the same default (URL, id) order, so the preview's URLs reappear there in the same relative order. It lists every direct URL of the folder without this endpoint's view filtering, so its rows and totals can exceed the preview's matchedUrlCount (e.g. on censuses with IGNORE patterns or in excluded views)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Browse mode (no searchPattern): With host, one level of that host's folder tree; without host, the root folder of every host on the census. Every row is a counted row, so every row carries the preview: all of its in-view direct URLs, up to the cap. Counts always cover each folder's entire subtree, whether they are read from the persisted folder rollup or computed live, so a folder's totalUrls does not change when the census finalizes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search mode (searchPattern supplied): A folder is a hit when its OWN name (folderName; a host's root folder is named \"/\" and is instead findable by its hostname) contains the pattern, or when it DIRECTLY contains a URL whose own page name -- the last segment of its path, not the folders above it -- contains the pattern. Hits come back in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"folders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with matched=true, each nesting its matching direct URLs in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Neither kind of match inherits: searching \"shoes\" does not return every page under a /shoes/ folder (the folder is a name hit, but its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" preview lists only direct children whose own name matches), and a page named shoes.html puts its containing folder on the page without making that folder's name a match."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"folders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" additionally carries the unmatched ancestor folders needed to render a connected tree path, with matched=false and no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/matchedUrlCount. Every hit is connected back to the root (or to parentFolderPath when supplied). parentFolderPath still requires host, but host on its own is a whole-host search."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination counts matched folders only: totalCount is the number of matching folders, and one page is pageSize matched rows. Nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entries and ancestor context rows are additional and never counted. A matching URL appears exactly once across the whole pagination -- nested under its containing folder, on the page where that folder sorts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where the counts come from: the excluded view (returnExcludedOnly=true) is always computed live from URLs, and so is the included view whenever the census is running, has IGNORE patterns configured, or has not finished folder aggregation; otherwise the included view is served from the persisted folder rollup. A search result's folder counts always describe the folder's whole subtree on both paths -- they are never restricted to matching URLs -- so the same folder reports the same totalUrls whether it was reached by browsing or by searching. Persisted counts still bucket status codes slightly differently from live ones: live treats any status other than 0 as visited, while the persisted unknown-status bucket additionally absorbs missing, 1xx and 6xx+ codes and reports them under urlsToVisit. visitedUrls + urlsToVisit always equals totalUrls on both paths."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1url-folders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"host","in":"query","schemaId":"schema_627","description":"The URL hostname to scope folder results. Omit (or send blank) to list the root folder of every host on the census (initial browse view; parentFolderPath must then also be omitted, and each root row carries host-wide counts).\n"},{"name":"parentFolderPath","in":"query","schemaId":"schema_627","description":"The normalized parent folder path key; returns immediate child folders under this parent. Coupled to host: requires host (400 if supplied without it), and defaults to the root path \"/\" when host is supplied without it. Blank counts as omitted. Caller variations are normalized the same way ingestion normalizes stored keys (lowercased, repeated slashes collapsed, trailing slash dropped); a path deeper than 50 folders, with any single folder name longer than 512 characters, or longer than 2048 characters overall cannot name a real folder and is a 400 rather than being answered with a shallower folder's children.\n"},{"name":"searchPattern","in":"query","schemaId":"schema_627","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case-insensitive substring matched against a folder's own name (or, for a host's root folder, its hostname) and against a page's own name -- the last path segment. For page names, glob "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as the dynamic-segment symbol, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" finds dynamically-segmented pages; folder names are raw path text, so a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the pattern only matches a literal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the name. Blank counts as omitted (browse mode). May be combined with or without host."},"children":[]}]}]}]},{"name":"returnExcludedOnly","in":"query","schemaId":"schema_625","description":"Indicates that the results will only contain excluded folder results: external folders (a non-included baseDomain) reachable via a discovered link, or internal folders matching an IGNORE filter pattern."},{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_748","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page size, counted in folder rows (matched rows in search mode). Up to 10000 when searchPattern is supplied; requests without a searchPattern are limited to 1000 (400 above that). Nested urls and ancestor context rows are additional, so worst-case response size scales with pageSize * urlsPerFolder."},"children":[]}]}]}]},{"name":"urlsPerFolder","in":"query","schemaId":"schema_749","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of direct-child URLs nested in each counted folder row's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. The uncapped in-view total is always reported in matchedUrlCount, so a truncated folder can be paged onward through the folders/urls endpoint, which lists in the same default (URL, id) order (unfiltered by this endpoint's view, so it may interleave additional URLs). 0 disables previews entirely: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and matchedUrlCount are then absent from every row, matching the pre-preview response shape."},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_750","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are ordered by this column and then by (host, folderPath), so a page is stable even when the sort column ties. On the hostless root listing FOLDER_NAME orders by host: every row there is some host's \"/\" folder, so folderName is the same literal on every row and carries no ordering. Nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" previews are not governed by this sort; they always list in (URL, id) order, matching the folders/urls endpoint's default."},"children":[]}]}]}]},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1url-folders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/site-censuses/{censusId}/url-folders","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[{"name":"host","in":"query","required":false,"schemaId":"schema_627"},{"name":"parentFolderPath","in":"query","required":false,"schemaId":"schema_627"},{"name":"searchPattern","in":"query","required":false,"schemaId":"schema_627"},{"name":"returnExcludedOnly","in":"query","required":false,"schemaId":"schema_625"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_748"},{"name":"urlsPerFolder","in":"query","required":false,"schemaId":"schema_749"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/SiteCensusUrlFolderSortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/site-censuses/{censusId}/url-folders","href":"site-censuses/getsitecensusurlfolders","openApiOperationId":"getSiteCensusUrlFolders","summary":"Browse a host's folder tree, list every host's root, or search folders and pages across the census -- each returned folder carrying a preview of its direct URLs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusUrlFolderResultsDTO"}},"schemaId":"components/schemas/SiteCensusUrlFolderResultsDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1url-folders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusUrlFolderResultsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusUrlFolderResultsDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/getsitecensusurlfolders"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}/url-folders"},{"label":"Returns the rolled-up counts for a single site-census folder","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/getsitecensusfoldersummary","routeSlug":"/openapi/combined.openapi/site-censuses/getsitecensusfoldersummary","metadata":{"seo":{"title":"Returns the rolled-up counts for a single site-census folder","description":"GET /v3/site-censuses/{censusId}/folders/summary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSiteCensusFolderSummary","name":"Returns the rolled-up counts for a single site-census folder","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1folders~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the rolled-up counts for a single site-census folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/folders/summary"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reads the precomputed rollup counts for one folder from site_census_url_folders (trustworthy only when finalized is true), plus live included/ignored URL counts computed over the folder's subtree."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1folders~1summary/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"baseDomain","in":"query","schemaId":"schema_627","description":"The URL base domain the folder belongs to.","required":true},{"name":"host","in":"query","schemaId":"schema_627","description":"The URL hostname the folder belongs to.","required":true},{"name":"folderPath","in":"query","schemaId":"schema_627","description":"The normalized path key of the selected folder.","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1folders~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/site-censuses/{censusId}/folders/summary","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[{"name":"baseDomain","in":"query","required":true,"schemaId":"schema_627"},{"name":"host","in":"query","required":true,"schemaId":"schema_627"},{"name":"folderPath","in":"query","required":true,"schemaId":"schema_627"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/site-censuses/{censusId}/folders/summary","href":"site-censuses/getsitecensusfoldersummary","openApiOperationId":"getSiteCensusFolderSummary","summary":"Returns the rolled-up counts for a single site-census folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusFolderSummaryDTO"}},"schemaId":"components/schemas/SiteCensusFolderSummaryDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1folders~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusFolderSummaryDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusFolderSummaryDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/getsitecensusfoldersummary"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}/folders/summary"},{"label":"Returns the URLs sitting directly in a site-census folder","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/getsitecensusfolderurls","routeSlug":"/openapi/combined.openapi/site-censuses/getsitecensusfolderurls","metadata":{"seo":{"title":"Returns the URLs sitting directly in a site-census folder","description":"GET /v3/site-censuses/{censusId}/folders/urls"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSiteCensusFolderUrls","name":"Returns the URLs sitting directly in a site-census folder","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1folders~1urls/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the URLs sitting directly in a site-census folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/folders/urls"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the individual URLs whose containing folder is exactly folderPath (direct URLs only, not descendants), from site_census_urls, paginated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supply searchPattern to page through only the matching pages of one folder - the same pages the url-folders search nests in that folder's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" preview, using the identical page-name predicate and the same default (URL, id) order, so paging past a truncated preview continues the exact sequence the preview started and cannot surface pages the search itself would not have matched."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1folders~1urls/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"baseDomain","in":"query","schemaId":"schema_627","description":"The URL base domain the folder belongs to.","required":true},{"name":"host","in":"query","schemaId":"schema_627","description":"The URL hostname the folder belongs to.","required":true},{"name":"folderPath","in":"query","schemaId":"schema_627","description":"The normalized path key of the folder whose direct URLs to return.","required":true},{"name":"searchPattern","in":"query","schemaId":"schema_627","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restricts the listing to pages whose own name - the last path segment - contains this case-insensitive substring, matched exactly as the url-folders search matches page hits. Glob "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as the dynamic-segment symbol. Blank or omitted returns every direct URL in the folder."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_751"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1folders~1urls/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/site-censuses/{censusId}/folders/urls","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[{"name":"baseDomain","in":"query","required":true,"schemaId":"schema_627"},{"name":"host","in":"query","required":true,"schemaId":"schema_627"},{"name":"folderPath","in":"query","required":true,"schemaId":"schema_627"},{"name":"searchPattern","in":"query","required":false,"schemaId":"schema_627"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/SiteCensusFolderUrlSortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/site-censuses/{censusId}/folders/urls","href":"site-censuses/getsitecensusfolderurls","openApiOperationId":"getSiteCensusFolderUrls","summary":"Returns the URLs sitting directly in a site-census folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusFolderUrlsResultsDTO"}},"schemaId":"components/schemas/SiteCensusFolderUrlsResultsDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1folders~1urls/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusFolderUrlsResultsDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusFolderUrlsResultsDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/getsitecensusfolderurls"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}/folders/urls"},{"label":"Returns a preview of the current census results data given specific path patterns","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/getsitecensuspatternurlpreview","routeSlug":"/openapi/combined.openapi/site-censuses/getsitecensuspatternurlpreview","metadata":{"seo":{"title":"Returns a preview of the current census results data given specific path patterns","description":"POST /v3/site-censuses/{censusId}/current-results/url-preview"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSiteCensusPatternUrlPreview","name":"Returns a preview of the current census results data given specific path patterns","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1current-results~1url-preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a preview of the current census results data given specific path patterns","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/current-results/url-preview"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1current-results~1url-preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteCensusBaseUrlPattern"}},"schemaId":"components/schemas/SiteCensusBaseUrlPattern","pointer":"/paths/~1v3~1site-censuses~1{censusId}~1current-results~1url-preview/post/requestBody","description":"The URL pattern for which a preview is desired"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/site-censuses/{censusId}/current-results/url-preview","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SiteCensusBaseUrlPattern"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/site-censuses/{censusId}/current-results/url-preview","href":"site-censuses/getsitecensuspatternurlpreview","openApiOperationId":"getSiteCensusPatternUrlPreview","summary":"Returns a preview of the current census results data given specific path patterns"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/SiteCensusBaseUrlPattern","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteCensusBaseUrlPattern"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusPatternPreviewResponse"}},"schemaId":"components/schemas/SiteCensusPatternPreviewResponse"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1current-results~1url-preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusPatternPreviewResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusPatternPreviewResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/getsitecensuspatternurlpreview"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}/current-results/url-preview"},{"label":"Starts data-collection for a given census","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/startsitecensusdatacollection","routeSlug":"/openapi/combined.openapi/site-censuses/startsitecensusdatacollection","metadata":{"seo":{"title":"Starts data-collection for a given census","description":"POST /v3/site-censuses/{censusId}/start"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startSiteCensusDataCollection","name":"Starts data-collection for a given census","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1start/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Starts data-collection for a given census","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/start"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1start/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/site-censuses/{censusId}/start","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/site-censuses/{censusId}/start","href":"site-censuses/startsitecensusdatacollection","openApiOperationId":"startSiteCensusDataCollection","summary":"Starts data-collection for a given census"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation, census started","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}},"schemaId":"components/schemas/SiteCensusCompleteDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusCompleteDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/startsitecensusdatacollection"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}/start"},{"label":"Stops data-collection for a given census","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/stopsitecensusdatacollection","routeSlug":"/openapi/combined.openapi/site-censuses/stopsitecensusdatacollection","metadata":{"seo":{"title":"Stops data-collection for a given census","description":"POST /v3/site-censuses/{censusId}/stop"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stopSiteCensusDataCollection","name":"Stops data-collection for a given census","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1stop/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stops data-collection for a given census","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{censusId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/stop"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"censusId","in":"path","schemaId":"schema_746","description":"Unique identification number for a site census","required":true}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1stop/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/site-censuses/{censusId}/stop","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"censusId","in":"path","required":true,"schemaId":"components/schemas/RuleSnapshotId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/site-censuses/{censusId}/stop","href":"site-censuses/stopsitecensusdatacollection","openApiOperationId":"stopSiteCensusDataCollection","summary":"Stops data-collection for a given census"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation, census stopped","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}},"schemaId":"components/schemas/SiteCensusCompleteDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1{censusId}~1stop/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCensusCompleteDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCensusCompleteDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/stopsitecensusdatacollection"}],"panels":[]}]},"httpPath":"/v3/site-censuses/{censusId}/stop"},{"label":"Find site censuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/site-censuses/findsitecensuses","routeSlug":"/openapi/combined.openapi/site-censuses/findsitecensuses","metadata":{"seo":{"title":"Find site censuses","description":"GET /v3/site-censuses/finder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findSiteCensuses","name":"Find site censuses","isWebhook":false,"pointer":"/paths/~1v3~1site-censuses~1finder/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Find site censuses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/site-censuses/finder"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find site censuses. Available for ≥ OpAdmins only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_752","required":true},{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_608"}],"pointer":"/paths/~1v3~1site-censuses~1finder/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/site-censuses/finder","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":true,"schemaId":"components/schemas/SiteCensusSearchParam"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v3/site-censuses/finder","href":"site-censuses/findsitecensuses","openApiOperationId":"findSiteCensuses","summary":"Find site censuses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FoundSiteCensusesListResponseDTO"}},"schemaId":"components/schemas/FoundSiteCensusesListResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1site-censuses~1finder/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FoundSiteCensusesListResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FoundSiteCensusesListResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-censuses/findsitecensuses"}],"panels":[]}]},"httpPath":"/v3/site-censuses/finder"}],"content":{"contentType":"group","meta":{"name":"site-censuses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Site Censuses","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing Site Census"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/site-censuses","summary":"Get all censuses for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-censuses/getsitecensuses","deprecated":false},{"title":"/v3/site-censuses","summary":"Create a new site census","prefix":{"name":"post","color":"post"},"badges":[],"link":"/site-censuses/createsitecensus","deprecated":false},{"title":"/v3/site-censuses/{censusId}","summary":"Get a site census by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-censuses/getsitecensusbyid","deprecated":false},{"title":"/v3/site-censuses/{censusId}","summary":"Update an existing site census","prefix":{"name":"put","color":"put"},"badges":[],"link":"/site-censuses/updatesitecensusbyid","deprecated":false},{"title":"/v3/site-censuses/{censusId}","summary":"Delete a site census by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/site-censuses/deletesitecensusbyid","deprecated":false},{"title":"/v3/site-censuses/{censusId}/current-results","summary":"Returns a summary of the current census results data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-censuses/getsitecensuscurrentresults","deprecated":false},{"title":"/v3/site-censuses/{censusId}/url-folders","summary":"Browse a host's folder tree, list every host's root, or search folders and pages across the census -- each returned folder carrying a preview of its direct URLs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-censuses/getsitecensusurlfolders","deprecated":false},{"title":"/v3/site-censuses/{censusId}/folders/summary","summary":"Returns the rolled-up counts for a single site-census folder","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-censuses/getsitecensusfoldersummary","deprecated":false},{"title":"/v3/site-censuses/{censusId}/folders/urls","summary":"Returns the URLs sitting directly in a site-census folder","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-censuses/getsitecensusfolderurls","deprecated":false},{"title":"/v3/site-censuses/{censusId}/current-results/url-preview","summary":"Returns a preview of the current census results data given specific path patterns","prefix":{"name":"post","color":"post"},"badges":[],"link":"/site-censuses/getsitecensuspatternurlpreview","deprecated":false},{"title":"/v3/site-censuses/{censusId}/start","summary":"Starts data-collection for a given census","prefix":{"name":"post","color":"post"},"badges":[],"link":"/site-censuses/startsitecensusdatacollection","deprecated":false},{"title":"/v3/site-censuses/{censusId}/stop","summary":"Stops data-collection for a given census","prefix":{"name":"post","color":"post"},"badges":[],"link":"/site-censuses/stopsitecensusdatacollection","deprecated":false},{"title":"/v3/site-censuses/finder","summary":"Find site censuses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-censuses/findsitecensuses","deprecated":false}]}]}]}]}},{"type":"group","label":"User Events","link":"/openapi/combined.openapi/user-events","routeSlug":"/openapi/combined.openapi/user-events","items":[{"label":"Get user events in the account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/user-events/getuserevents","routeSlug":"/openapi/combined.openapi/user-events/getuserevents","metadata":{"seo":{"title":"Get user events in the account","description":"GET /v3/user-events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserEvents","name":"Get user events in the account","isWebhook":false,"pointer":"/paths/~1v3~1user-events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user events in the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/user-events"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint will get all the changes made by users in the account. This endpoint is only for Admins"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"userId","in":"query","schemaId":"schema_679","description":"filter events by UserId"},{"name":"eventType","in":"query","schemaId":"schema_753","description":"filter events by event type"},{"name":"itemType","in":"query","schemaId":"schema_754","description":"filter events by event item type","required":true},{"name":"itemName","in":"query","schemaId":"schema_627","description":"filter events that matches the itemName"},{"name":"itemId","in":"query","schemaId":"components/schemas/ReceivedEmailMessageId","description":"filter events by itemId"},{"name":"fromTimeStamp","in":"query","schemaId":"schema_755","description":"filter events from this timeStamp"},{"name":"toTimeStamp","in":"query","schemaId":"schema_755","description":"filter events up to this timeStamp"},{"name":"page","in":"query","schemaId":"schema_596","description":"Number of results page of an endpoint with paginated results"},{"name":"pageSize","in":"query","schemaId":"schema_608"},{"name":"sortBy","in":"query","schemaId":"schema_756"},{"name":"sortDesc","in":"query","schemaId":"schema_599","description":"Controls sorting order"}],"pointer":"/paths/~1v3~1user-events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/user-events","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"userId","in":"query","required":false,"example":123,"schemaId":"components/schemas/UserId"},{"name":"eventType","in":"query","required":false,"schemaId":"components/schemas/UserEventTypeApi"},{"name":"itemType","in":"query","required":true,"schemaId":"components/schemas/UserEventItemTypeApi"},{"name":"itemName","in":"query","required":false,"schemaId":"schema_627"},{"name":"itemId","in":"query","required":false,"schemaId":"components/schemas/ReceivedEmailMessageId"},{"name":"fromTimeStamp","in":"query","required":false,"example":"2021-06-01T01:30:00.000-05:00","schemaId":"schema_755"},{"name":"toTimeStamp","in":"query","required":false,"example":"2021-06-01T01:30:00.000-05:00","schemaId":"schema_755"},{"name":"page","in":"query","required":false,"schemaId":"schema_596"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_608"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/UserEventSortByEnum"},{"name":"sortDesc","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/user-events","href":"user-events/getuserevents","openApiOperationId":"getUserEvents","summary":"Get user events in the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieve user events in the account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserEvents_ResponseDTO"}},"schemaId":"components/schemas/UserEvents_ResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1user-events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserEvents_ResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserEvents_ResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-events/getuserevents"}],"panels":[]}]},"httpPath":"/v3/user-events"}],"content":{"contentType":"group","meta":{"name":"user-events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Events","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing User Events"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/user-events","summary":"Get user events in the account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-events/getuserevents","deprecated":false}]}]}]}]}},{"type":"group","label":"Web Journey Blocking Config","link":"/openapi/combined.openapi/web-journey-blocking-config","routeSlug":"/openapi/combined.openapi/web-journey-blocking-config","items":[{"label":"Get blocking configuration for a web journey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journey-blocking-config/getwebjourneyblockingconfig","routeSlug":"/openapi/combined.openapi/web-journey-blocking-config/getwebjourneyblockingconfig","metadata":{"seo":{"title":"Get blocking configuration for a web journey","description":"GET /v3/web-journeys/{webJourneyId}/blocking-configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyBlockingConfig","name":"Get blocking configuration for a web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1blocking-configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get blocking configuration for a web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/blocking-configuration"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1blocking-configuration/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/blocking-configuration","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/blocking-configuration","href":"web-journey-blocking-config/getwebjourneyblockingconfig","openApiOperationId":"getWebJourneyBlockingConfig","summary":"Get blocking configuration for a web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Web Journey request blocking configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"schemaId":"components/schemas/BlockingConfig_DTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1blocking-configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BlockingConfig_DTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journey-blocking-config/getwebjourneyblockingconfig"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/blocking-configuration"},{"label":"Create blocking configuration for a web journey","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journey-blocking-config/createwebjourneyblockingconfig","routeSlug":"/openapi/combined.openapi/web-journey-blocking-config/createwebjourneyblockingconfig","metadata":{"seo":{"title":"Create blocking configuration for a web journey","description":"PUT /v3/web-journeys/{webJourneyId}/blocking-configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebJourneyBlockingConfig","name":"Create blocking configuration for a web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1blocking-configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create blocking configuration for a web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/blocking-configuration"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1blocking-configuration/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"schemaId":"components/schemas/BlockingConfig_DTO","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1blocking-configuration/put/requestBody","description":"The Web Journey Blocking configuration to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-journeys/{webJourneyId}/blocking-configuration","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/blocking-configuration","href":"web-journey-blocking-config/createwebjourneyblockingconfig","openApiOperationId":"createWebJourneyBlockingConfig","summary":"Create blocking configuration for a web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/BlockingConfig_DTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned the created Web journey Blocking Configuration.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}},"schemaId":"components/schemas/BlockingConfig_DTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1blocking-configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BlockingConfig_DTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockingConfig_DTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journey-blocking-config/createwebjourneyblockingconfig"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/blocking-configuration"}],"content":{"contentType":"group","meta":{"name":"web-journey-blocking-config"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Web Journey Blocking Config","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing web journey request blocking configuration"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-journeys/{webJourneyId}/blocking-configuration","summary":"Get blocking configuration for a web journey","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journey-blocking-config/getwebjourneyblockingconfig","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/blocking-configuration","summary":"Create blocking configuration for a web journey","prefix":{"name":"put","color":"put"},"badges":[],"link":"/web-journey-blocking-config/createwebjourneyblockingconfig","deprecated":false}]}]}]}]}},{"type":"group","label":"Web Journey Custom Headers","link":"/openapi/combined.openapi/web-journey-custom-headers","routeSlug":"/openapi/combined.openapi/web-journey-custom-headers","items":[{"label":"Get custom headers for a web journey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journey-custom-headers/getwebjourneycustomheaders","routeSlug":"/openapi/combined.openapi/web-journey-custom-headers/getwebjourneycustomheaders","metadata":{"seo":{"title":"Get custom headers for a web journey","description":"GET /v3/web-journeys/{webJourneyId}/custom-headers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyCustomHeaders","name":"Get custom headers for a web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1custom-headers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get custom headers for a web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/custom-headers"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1custom-headers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/custom-headers","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/custom-headers","href":"web-journey-custom-headers/getwebjourneycustomheaders","openApiOperationId":"getWebJourneyCustomHeaders","summary":"Get custom headers for a web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a list of custom headers for the web journey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyCustomHeaderDTO"}},"schemaId":"components/schemas/WebJourneyCustomHeaderDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1custom-headers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyCustomHeaderDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyCustomHeaderDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journey-custom-headers/getwebjourneycustomheaders"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/custom-headers"},{"label":"Update custom headers for a web journey","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journey-custom-headers/updatewebjourneycustomheaders","routeSlug":"/openapi/combined.openapi/web-journey-custom-headers/updatewebjourneycustomheaders","metadata":{"seo":{"title":"Update custom headers for a web journey","description":"PUT /v3/web-journeys/{webJourneyId}/custom-headers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebJourneyCustomHeaders","name":"Update custom headers for a web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1custom-headers/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update custom headers for a web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/custom-headers"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1custom-headers/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyCustomHeaderDTO"}},"schemaId":"components/schemas/WebJourneyCustomHeaderDTO","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1custom-headers/put/requestBody","description":"The Web Journey Custom Headers to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-journeys/{webJourneyId}/custom-headers","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebJourneyCustomHeaderDTO"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/web-journeys/{webJourneyId}/custom-headers","href":"web-journey-custom-headers/updatewebjourneycustomheaders","openApiOperationId":"updateWebJourneyCustomHeaders","summary":"Update custom headers for a web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/WebJourneyCustomHeaderDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyCustomHeaderDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the custom headers for the web journey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyCustomHeaderDTO"}},"schemaId":"components/schemas/WebJourneyCustomHeaderDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1custom-headers/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyCustomHeaderDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyCustomHeaderDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journey-custom-headers/updatewebjourneycustomheaders"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/custom-headers"}],"content":{"contentType":"group","meta":{"name":"web-journey-custom-headers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Web Journey Custom Headers","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing web journey custom headers"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-journeys/{webJourneyId}/custom-headers","summary":"Get custom headers for a web journey","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journey-custom-headers/getwebjourneycustomheaders","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/custom-headers","summary":"Update custom headers for a web journey","prefix":{"name":"put","color":"put"},"badges":[],"link":"/web-journey-custom-headers/updatewebjourneycustomheaders","deprecated":false}]}]}]}]}},{"type":"group","label":"Web Journeys Management","link":"/openapi/combined.openapi/web-journeys-management","routeSlug":"/openapi/combined.openapi/web-journeys-management","items":[{"label":"Get web journeys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneys","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneys","metadata":{"seo":{"title":"Get web journeys","description":"GET /v3/web-journeys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneys","name":"Get web journeys","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journeys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all web journeys with optional filtering"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domainId","in":"query","schemaId":"schema_737","description":"Filter by domain ID"},{"name":"monitored","in":"query","schemaId":"schema_757","description":"Filter by monitored status"},{"name":"accountId","in":"query","schemaId":"schema_758","description":"Filter by account ID"}],"pointer":"/paths/~1v3~1web-journeys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"domainId","in":"query","required":false,"example":123,"schemaId":"schema_737"},{"name":"monitored","in":"query","required":false,"example":true,"schemaId":"schema_757"},{"name":"accountId","in":"query","required":false,"example":456,"schemaId":"schema_758"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v3/web-journeys","href":"web-journeys-management/getwebjourneys","openApiOperationId":"getWebJourneys","summary":"Get web journeys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of web journeys retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_759"}},"schemaId":"schema_759"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_759","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_759"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneys"}],"panels":[]}]},"httpPath":"/v3/web-journeys"},{"label":"Create web journey","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/createwebjourney","routeSlug":"/openapi/combined.openapi/web-journeys-management/createwebjourney","metadata":{"seo":{"title":"Create web journey","description":"POST /v3/web-journeys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebJourney","name":"Create web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyUpdateDTO"}},"schemaId":"components/schemas/WebJourneyUpdateDTO","pointer":"/paths/~1v3~1web-journeys/post/requestBody","description":"Web journey data for creation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-journeys","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebJourneyUpdateDTO"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/web-journeys","href":"web-journeys-management/createwebjourney","openApiOperationId":"createWebJourney","summary":"Create web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/WebJourneyUpdateDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyUpdateDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyDTO"}},"schemaId":"components/schemas/WebJourneyDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/createwebjourney"}],"panels":[]}]},"httpPath":"/v3/web-journeys"},{"label":"Delete web journeys by domain or folder","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/deletewebjourneys","routeSlug":"/openapi/combined.openapi/web-journeys-management/deletewebjourneys","metadata":{"seo":{"title":"Delete web journeys by domain or folder","description":"DELETE /v3/web-journeys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebJourneys","name":"Delete web journeys by domain or folder","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete web journeys by domain or folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete web journeys by domain ID or folder ID"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domainId","in":"query","schemaId":"schema_737","description":"Delete all web journeys in the specified domain"},{"name":"folderId","in":"query","schemaId":"schema_758","description":"Delete all web journeys in the specified folder"}],"pointer":"/paths/~1v3~1web-journeys/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/web-journeys","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[{"name":"domainId","in":"query","required":false,"example":123,"schemaId":"schema_737"},{"name":"folderId","in":"query","required":false,"example":456,"schemaId":"schema_758"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys","href":"web-journeys-management/deletewebjourneys","openApiOperationId":"deleteWebJourneys","summary":"Delete web journeys by domain or folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journeys deleted successfully"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/deletewebjourneys"}],"panels":[]}]},"httpPath":"/v3/web-journeys"},{"label":"Get web journey by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourney","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourney","metadata":{"seo":{"title":"Get web journey by ID","description":"GET /v3/web-journeys/{webJourneyId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourney","name":"Get web journey by ID","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journey by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a specific web journey by its ID"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}","href":"web-journeys-management/getwebjourney","openApiOperationId":"getWebJourney","summary":"Get web journey by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyDTO"}},"schemaId":"components/schemas/WebJourneyDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourney"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}"},{"label":"Update web journey","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/updatewebjourney","routeSlug":"/openapi/combined.openapi/web-journeys-management/updatewebjourney","metadata":{"seo":{"title":"Update web journey","description":"PUT /v3/web-journeys/{webJourneyId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebJourney","name":"Update web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyUpdateDTO"}},"schemaId":"components/schemas/WebJourneyUpdateDTO","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/put/requestBody","description":"Updated web journey data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-journeys/{webJourneyId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebJourneyUpdateDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}","href":"web-journeys-management/updatewebjourney","openApiOperationId":"updateWebJourney","summary":"Update web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/WebJourneyUpdateDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyUpdateDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyDTO"}},"schemaId":"components/schemas/WebJourneyDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/updatewebjourney"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}"},{"label":"Delete web journey","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/deletewebjourney","routeSlug":"/openapi/combined.openapi/web-journeys-management/deletewebjourney","metadata":{"seo":{"title":"Delete web journey","description":"DELETE /v3/web-journeys/{webJourneyId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebJourney","name":"Delete web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a specific web journey by its ID"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/web-journeys/{webJourneyId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}","href":"web-journeys-management/deletewebjourney","openApiOperationId":"deleteWebJourney","summary":"Delete web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey deleted successfully"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/deletewebjourney"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}"},{"label":"Undelete a web journey","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/undeletewebjourney","routeSlug":"/openapi/combined.openapi/web-journeys-management/undeletewebjourney","metadata":{"seo":{"title":"Undelete a web journey","description":"PATCH /v3/web-journeys/undelete"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"undeleteWebJourney","name":"Undelete a web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1undelete/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Undelete a web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/undelete"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restore a single archived web journey into a chosen destination Folder and Sub-folder. The original parents are not reinstated. Historical run data is not restored. Per-item outcomes (including destination_gone and already_restored) are returned in the 200 response body; only authentication and authorization failures use 401/403."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UndeleteWebJourneyRequest"}},"schemaId":"components/schemas/UndeleteWebJourneyRequest","pointer":"/paths/~1v3~1web-journeys~1undelete/patch/requestBody","description":"Web journey id and restore destination"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/web-journeys/undelete","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UndeleteWebJourneyRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/web-journeys/undelete","href":"web-journeys-management/undeletewebjourney","openApiOperationId":"undeleteWebJourney","summary":"Undelete a web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/UndeleteWebJourneyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UndeleteWebJourneyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Restore outcome for the requested web journey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UndeleteWebJourneyResponse"}},"schemaId":"components/schemas/UndeleteWebJourneyResponse"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1undelete/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UndeleteWebJourneyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UndeleteWebJourneyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/undeletewebjourney"}],"panels":[]}]},"httpPath":"/v3/web-journeys/undelete"},{"label":"Get web journey status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneystatus","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneystatus","metadata":{"seo":{"title":"Get web journey status","description":"GET /v3/web-journeys/{webJourneyId}/status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyStatus","name":"Get web journey status","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journey status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/status"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the current status of a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/status","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/status","href":"web-journeys-management/getwebjourneystatus","openApiOperationId":"getWebJourneyStatus","summary":"Get web journey status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey status retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyStatusDTO"}},"schemaId":"components/schemas/WebJourneyStatusDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyStatusDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyStatusDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneystatus"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/status"},{"label":"Get web journey actions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyactions","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyactions","metadata":{"seo":{"title":"Get web journey actions","description":"GET /v3/web-journeys/{webJourneyId}/actions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyActions","name":"Get web journey actions","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journey actions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all actions for a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/actions","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/actions","href":"web-journeys-management/getwebjourneyactions","openApiOperationId":"getWebJourneyActions","summary":"Get web journey actions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey actions retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}},"schemaId":"schema_715"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_715","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyactions"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/actions"},{"label":"Update web journey actions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyactions","routeSlug":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyactions","metadata":{"seo":{"title":"Update web journey actions","description":"PUT /v3/web-journeys/{webJourneyId}/actions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebJourneyActions","name":"Update web journey actions","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update web journey actions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update all actions for a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_715"}},"schemaId":"schema_715","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions/put/requestBody","description":"List of actions to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-journeys/{webJourneyId}/actions","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_715"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/actions","href":"web-journeys-management/updatewebjourneyactions","openApiOperationId":"updateWebJourneyActions","summary":"Update web journey actions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_715","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_715"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey actions updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}},"schemaId":"schema_715"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_715","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/updatewebjourneyactions"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/actions"},{"label":"Get web journey action by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyaction","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyaction","metadata":{"seo":{"title":"Get web journey action by ID","description":"GET /v3/web-journeys/{webJourneyId}/actions/{actionId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyAction","name":"Get web journey action by ID","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journey action by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a specific action by its ID within a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"actionId","in":"path","schemaId":"schema_760","description":"The ID of the action","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/actions/{actionId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"actionId","in":"path","required":true,"example":1001,"schemaId":"schema_760"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/actions/{actionId}","href":"web-journeys-management/getwebjourneyaction","openApiOperationId":"getWebJourneyAction","summary":"Get web journey action by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey action retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"schemaId":"components/schemas/ActionSetActionDto"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActionSetActionDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyaction"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/actions/{actionId}"},{"label":"Update web journey action","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyaction","routeSlug":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyaction","metadata":{"seo":{"title":"Update web journey action","description":"PUT /v3/web-journeys/{webJourneyId}/actions/{actionId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebJourneyAction","name":"Update web journey action","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update web journey action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a specific action within a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"actionId","in":"path","schemaId":"schema_760","description":"The ID of the action","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"schemaId":"components/schemas/ActionSetActionDto","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}/put/requestBody","description":"Action data to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-journeys/{webJourneyId}/actions/{actionId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"actionId","in":"path","required":true,"example":1001,"schemaId":"schema_760"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/actions/{actionId}","href":"web-journeys-management/updatewebjourneyaction","openApiOperationId":"updateWebJourneyAction","summary":"Update web journey action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/ActionSetActionDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey action updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}},"schemaId":"components/schemas/ActionSetActionDto"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActionSetActionDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionSetActionDto"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/updatewebjourneyaction"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/actions/{actionId}"},{"label":"Get web journey run status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyrunstatus","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyrunstatus","metadata":{"seo":{"title":"Get web journey run status","description":"GET /v3/web-journeys/{webJourneyId}/runs/{runId}/status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyRunStatus","name":"Get web journey run status","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journey run status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/status"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the status of a specific web journey run"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"runId","in":"path","schemaId":"schema_761","description":"The ID of the web journey run","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/runs/{runId}/status","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":12345,"schemaId":"schema_761"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/{runId}/status","href":"web-journeys-management/getwebjourneyrunstatus","openApiOperationId":"getWebJourneyRunStatus","summary":"Get web journey run status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey run status retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRunStatusObject"}},"schemaId":"components/schemas/WebJourneyRunStatusObject"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyRunStatusObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRunStatusObject"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyrunstatus"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/{runId}/status"},{"label":"Delete web journey run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/deletewebjourneyrun","routeSlug":"/openapi/combined.openapi/web-journeys-management/deletewebjourneyrun","metadata":{"seo":{"title":"Delete web journey run","description":"DELETE /v3/web-journeys/{webJourneyId}/runs/{runId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebJourneyRun","name":"Delete web journey run","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete web journey run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop/discard a specific web journey run"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"runId","in":"path","schemaId":"schema_761","description":"The ID of the web journey run","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/web-journeys/{webJourneyId}/runs/{runId}","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":12345,"schemaId":"schema_761"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/{runId}","href":"web-journeys-management/deletewebjourneyrun","openApiOperationId":"deleteWebJourneyRun","summary":"Delete web journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Web journey run deleted successfully"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/deletewebjourneyrun"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/{runId}"},{"label":"Delete current web journey run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/deletecurrentwebjourneyrun","routeSlug":"/openapi/combined.openapi/web-journeys-management/deletecurrentwebjourneyrun","metadata":{"seo":{"title":"Delete current web journey run","description":"DELETE /v3/web-journeys/{webJourneyId}/runs/current"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCurrentWebJourneyRun","name":"Delete current web journey run","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1current/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete current web journey run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/current"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop/discard the current web journey run"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1current/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/web-journeys/{webJourneyId}/runs/current","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/current","href":"web-journeys-management/deletecurrentwebjourneyrun","openApiOperationId":"deleteCurrentWebJourneyRun","summary":"Delete current web journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Current web journey run deleted successfully"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1current/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/deletecurrentwebjourneyrun"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/current"},{"label":"Get web journey notification configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneynotificationconfig","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneynotificationconfig","metadata":{"seo":{"title":"Get web journey notification configuration","description":"GET /v3/web-journeys/{webJourneyId}/notificationconfig"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyNotificationConfig","name":"Get web journey notification configuration","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1notificationconfig/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journey notification configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/notificationconfig"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve notification settings for a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1notificationconfig/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/notificationconfig","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/notificationconfig","href":"web-journeys-management/getwebjourneynotificationconfig","openApiOperationId":"getWebJourneyNotificationConfig","summary":"Get web journey notification configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Notification configuration retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyNotificationConfig"}},"schemaId":"components/schemas/WebJourneyNotificationConfig"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1notificationconfig/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyNotificationConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyNotificationConfig"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneynotificationconfig"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/notificationconfig"},{"label":"Update web journey notification configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/updatewebjourneynotificationconfig","routeSlug":"/openapi/combined.openapi/web-journeys-management/updatewebjourneynotificationconfig","metadata":{"seo":{"title":"Update web journey notification configuration","description":"PUT /v3/web-journeys/{webJourneyId}/notificationconfig"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebJourneyNotificationConfig","name":"Update web journey notification configuration","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1notificationconfig/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update web journey notification configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/notificationconfig"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update or create notification settings for a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1notificationconfig/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyNotificationConfig"}},"schemaId":"components/schemas/WebJourneyNotificationConfig","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1notificationconfig/put/requestBody","description":"Notification configuration to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-journeys/{webJourneyId}/notificationconfig","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebJourneyNotificationConfig"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/notificationconfig","href":"web-journeys-management/updatewebjourneynotificationconfig","openApiOperationId":"updateWebJourneyNotificationConfig","summary":"Update web journey notification configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/WebJourneyNotificationConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyNotificationConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Notification configuration updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyNotificationConfig"}},"schemaId":"components/schemas/WebJourneyNotificationConfig"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1notificationconfig/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyNotificationConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyNotificationConfig"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/updatewebjourneynotificationconfig"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/notificationconfig"},{"label":"Get web journey rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyrules","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyrules","metadata":{"seo":{"title":"Get web journey rules","description":"GET /v3/web-journeys/{webJourneyId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyRules","name":"Get web journey rules","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journey rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/rules"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all rules associated with a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/rules","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/rules","href":"web-journeys-management/getwebjourneyrules","openApiOperationId":"getWebJourneyRules","summary":"Get web journey rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey rules retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyAndActionRules"}},"schemaId":"components/schemas/WebJourneyAndActionRules"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyAndActionRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyAndActionRules"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyrules"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/rules"},{"label":"Update web journey rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyrules","routeSlug":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyrules","metadata":{"seo":{"title":"Update web journey rules","description":"PUT /v3/web-journeys/{webJourneyId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebJourneyRules","name":"Update web journey rules","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1rules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update web journey rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/rules"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bind rules to a web journey and its actions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1rules/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyAndActionRulesRequest"}},"schemaId":"components/schemas/WebJourneyAndActionRulesRequest","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1rules/put/requestBody","description":"Rules configuration to bind"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-journeys/{webJourneyId}/rules","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebJourneyAndActionRulesRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/rules","href":"web-journeys-management/updatewebjourneyrules","openApiOperationId":"updateWebJourneyRules","summary":"Update web journey rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/WebJourneyAndActionRulesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebJourneyAndActionRulesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web journey rules updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyAndActionRules"}},"schemaId":"components/schemas/WebJourneyAndActionRules"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1rules/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyAndActionRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyAndActionRules"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/updatewebjourneyrules"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/rules"},{"label":"Get web journey action rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyactionrules","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyactionrules","metadata":{"seo":{"title":"Get web journey action rules","description":"GET /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyActionRules","name":"Get web journey action rules","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journey action rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/rules"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve rules for a specific action within a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"actionId","in":"path","schemaId":"schema_760","description":"The ID of the action","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}~1rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"actionId","in":"path","required":true,"example":1001,"schemaId":"schema_760"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules","href":"web-journeys-management/getwebjourneyactionrules","openApiOperationId":"getWebJourneyActionRules","summary":"Get web journey action rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action rules retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_712"}},"schemaId":"schema_712"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}~1rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_712","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_712"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyactionrules"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules"},{"label":"Update web journey action rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyactionrules","routeSlug":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyactionrules","metadata":{"seo":{"title":"Update web journey action rules","description":"PUT /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebJourneyActionRules","name":"Update web journey action rules","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}~1rules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update web journey action rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/rules"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bind rules to a specific action within a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"actionId","in":"path","schemaId":"schema_760","description":"The ID of the action","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}~1rules/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_762"}},"schemaId":"schema_762","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}~1rules/put/requestBody","description":"Set of rule IDs to bind to the action"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"actionId","in":"path","required":true,"example":1001,"schemaId":"schema_760"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_762"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules","href":"web-journeys-management/updatewebjourneyactionrules","openApiOperationId":"updateWebJourneyActionRules","summary":"Update web journey action rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_762","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_762"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action rules updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_712"}},"schemaId":"schema_712"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1actions~1{actionId}~1rules/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_712","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_712"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/updatewebjourneyactionrules"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules"},{"label":"Get web journey remote file mappings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyremotefilemappings","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyremotefilemappings","metadata":{"seo":{"title":"Get web journey remote file mappings","description":"GET /v3/web-journeys/{webJourneyId}/remotefilemappings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyRemoteFileMappings","name":"Get web journey remote file mappings","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1remotefilemappings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journey remote file mappings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/remotefilemappings"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all remote file mappings associated with a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1remotefilemappings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/remotefilemappings","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/remotefilemappings","href":"web-journeys-management/getwebjourneyremotefilemappings","openApiOperationId":"getWebJourneyRemoteFileMappings","summary":"Get web journey remote file mappings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Remote file mappings retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_738"}},"schemaId":"schema_738"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1remotefilemappings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_738","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_738"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyremotefilemappings"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/remotefilemappings"},{"label":"Update web journey remote file mappings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyremotefilemappings","routeSlug":"/openapi/combined.openapi/web-journeys-management/updatewebjourneyremotefilemappings","metadata":{"seo":{"title":"Update web journey remote file mappings","description":"PUT /v3/web-journeys/{webJourneyId}/remotefilemappings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebJourneyRemoteFileMappings","name":"Update web journey remote file mappings","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1remotefilemappings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update web journey remote file mappings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/remotefilemappings"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bind remote file mappings to a web journey"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1remotefilemappings/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_763"}},"schemaId":"schema_763","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1remotefilemappings/put/requestBody","description":"Set of remote file mapping IDs to bind"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/web-journeys/{webJourneyId}/remotefilemappings","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_763"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/remotefilemappings","href":"web-journeys-management/updatewebjourneyremotefilemappings","openApiOperationId":"updateWebJourneyRemoteFileMappings","summary":"Update web journey remote file mappings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"schema_763","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_763"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Remote file mappings updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}},"schemaId":"schema_763"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1remotefilemappings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_763","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/updatewebjourneyremotefilemappings"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/remotefilemappings"},{"label":"Get action requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyactionrequests","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyactionrequests","metadata":{"seo":{"title":"Get action requests","description":"GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyActionRequests","name":"Get action requests","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionSequenceId}~1requests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get action requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSequenceId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/requests"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all network requests made during an action execution"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"runId","in":"path","schemaId":"schema_761","description":"The ID of the web journey run","required":true},{"name":"actionSequenceId","in":"path","schemaId":"schema_764","description":"The sequence ID of the action","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionSequenceId}~1requests/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":12345,"schemaId":"schema_761"},{"name":"actionSequenceId","in":"path","required":true,"example":1,"schemaId":"schema_764"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests","href":"web-journeys-management/getwebjourneyactionrequests","openApiOperationId":"getWebJourneyActionRequests","summary":"Get action requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action requests retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_765"}},"schemaId":"schema_765"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionSequenceId}~1requests/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_765","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_765"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyactionrequests"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests"},{"label":"Get action logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyactionlogs","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyactionlogs","metadata":{"seo":{"title":"Get action logs","description":"GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyActionLogs","name":"Get action logs","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionSequenceId}~1logs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get action logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/actions/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{actionSequenceId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/logs"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve console logs generated during an action execution"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"runId","in":"path","schemaId":"schema_761","description":"The ID of the web journey run","required":true},{"name":"actionSequenceId","in":"path","schemaId":"schema_764","description":"The sequence ID of the action","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionSequenceId}~1logs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":12345,"schemaId":"schema_761"},{"name":"actionSequenceId","in":"path","required":true,"example":1,"schemaId":"schema_764"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs","href":"web-journeys-management/getwebjourneyactionlogs","openApiOperationId":"getWebJourneyActionLogs","summary":"Get action logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action logs retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_766"}},"schemaId":"schema_766"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1actions~1{actionSequenceId}~1logs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_766","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_766"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyactionlogs"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs"},{"label":"Get all labels attached to specified web journey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyassignedlabels","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyassignedlabels","metadata":{"seo":{"title":"Get all labels attached to specified web journey","description":"GET /v3/web-journeys/{webJourneyId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyAssignedLabels","name":"Get all labels attached to specified web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all labels attached to specified web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/labels"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1labels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/labels","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/labels","href":"web-journeys-management/getwebjourneyassignedlabels","openApiOperationId":"getWebJourneyAssignedLabels","summary":"Get all labels attached to specified web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a list of web journey assigned labels.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelResponseDTO"}},"schemaId":"components/schemas/LabelResponseDTO"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1labels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LabelResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelResponseDTO"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyassignedlabels"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/labels"},{"label":"Patch labels attached to specified web journey","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/patchwebjourneyassignedlabels","routeSlug":"/openapi/combined.openapi/web-journeys-management/patchwebjourneyassignedlabels","metadata":{"seo":{"title":"Patch labels attached to specified web journey","description":"PATCH /v3/web-journeys/{webJourneyId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchWebJourneyAssignedLabels","name":"Patch labels attached to specified web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1labels/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch labels attached to specified web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-patch"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/labels"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1labels/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1labels/patch/requestBody","description":"Patch Document"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/web-journeys/{webJourneyId}/labels","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/labels","href":"web-journeys-management/patchwebjourneyassignedlabels","openApiOperationId":"patchWebJourneyAssignedLabels","summary":"Patch labels attached to specified web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO","mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AttachmentPatchDocument_RequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully patched web journey assigned labels.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelResponseDTO"}},"schemaId":"components/schemas/LabelResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1labels/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LabelResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/patchwebjourneyassignedlabels"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/labels"},{"label":"Get journey configuration info for specified journey run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/getwebjourneyruninfo","routeSlug":"/openapi/combined.openapi/web-journeys-management/getwebjourneyruninfo","metadata":{"seo":{"title":"Get journey configuration info for specified journey run","description":"GET /v3/web-journeys/{webJourneyId}/runs/{runId}/info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneyRunInfo","name":"Get journey configuration info for specified journey run","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get journey configuration info for specified journey run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{runId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/info"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true},{"name":"runId","in":"path","schemaId":"schema_595","description":"Unique identification number for web audit or journey run","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/web-journeys/{webJourneyId}/runs/{runId}/info","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"},{"name":"runId","in":"path","required":true,"example":33010,"schemaId":"components/schemas/RunId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/web-journeys/{webJourneyId}/runs/{runId}/info","href":"web-journeys-management/getwebjourneyruninfo","openApiOperationId":"getWebJourneyRunInfo","summary":"Get journey configuration info for specified journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Web Journey run configuration info","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_ConfigurationInfoResponseDTO"}},"schemaId":"components/schemas/WebJourneyRun_ConfigurationInfoResponseDTO"},{"code":"400","description":"The request cannot be accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"401","description":"Your token is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"403","description":"You don't have enough rights to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"},{"code":"404","description":"The object you are looking is not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}},"schemaId":"components/schemas/ErrorModel"}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs~1{runId}~1info/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyRun_ConfigurationInfoResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_ConfigurationInfoResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"401","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"403","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}},{"code":"404","schemaId":"components/schemas/ErrorModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/getwebjourneyruninfo"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs/{runId}/info"},{"label":"Run web journey","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/combined.openapi/web-journeys-management/runwebjourney","routeSlug":"/openapi/combined.openapi/web-journeys-management/runwebjourney","metadata":{"seo":{"title":"Run web journey","description":"POST /v3/web-journeys/{webJourneyId}/runs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runWebJourney","name":"Run web journey","isWebhook":false,"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run web journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"op-path-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-http-method-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v3/web-journeys/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webJourneyId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new run for the specified web journey."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The journey must exist, have actions configured, and not already be running."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webJourneyId","in":"path","schemaId":"schema_661","description":"Unique identification number for web journey item","required":true}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/web-journeys/{webJourneyId}/runs","servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"parameters":{"path":[{"name":"webJourneyId","in":"path","required":true,"example":107239,"schemaId":"components/schemas/WebJourneyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/v3/web-journeys/{webJourneyId}/runs","href":"web-journeys-management/runwebjourney","openApiOperationId":"runWebJourney","summary":"Run web journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Run created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_CreatedResponseDTO"}},"schemaId":"components/schemas/WebJourneyRun_CreatedResponseDTO"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO"}},"schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO"},{"code":"401","description":"Authentication failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767","exampleIds":["paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/401/content/application~1json/example"]}},"schemaId":"schema_767","exampleIds":["paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Usage limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO"}},"schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO"}},"schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO"},{"code":"409","description":"Journey is already running","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_RunExistsResponseDTO","exampleIds":["paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/WebJourneyRun_RunExistsResponseDTO","exampleIds":["paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebJourneyRun_CreatedResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_CreatedResponseDTO"}}},{"code":"400","schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO"}}},{"code":"401","schemaId":"schema_767","exampleIds":["paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767","exampleIds":["paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO"}}},{"code":"404","schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_ErrorResponseDTO"}}},{"code":"409","schemaId":"components/schemas/WebJourneyRun_RunExistsResponseDTO","exampleIds":["paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebJourneyRun_RunExistsResponseDTO","exampleIds":["paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/web-journeys-management/runwebjourney"}],"panels":[]}]},"httpPath":"/v3/web-journeys/{webJourneyId}/runs"}],"content":{"contentType":"group","meta":{"name":"web-journeys-management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Web Journeys Management","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing Web Journeys"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/web-journeys","summary":"Get web journeys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneys","deprecated":false},{"title":"/v3/web-journeys","summary":"Create web journey","prefix":{"name":"post","color":"post"},"badges":[],"link":"/web-journeys-management/createwebjourney","deprecated":false},{"title":"/v3/web-journeys","summary":"Delete web journeys by domain or folder","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/web-journeys-management/deletewebjourneys","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}","summary":"Get web journey by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourney","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}","summary":"Update web journey","prefix":{"name":"put","color":"put"},"badges":[],"link":"/web-journeys-management/updatewebjourney","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}","summary":"Delete web journey","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/web-journeys-management/deletewebjourney","deprecated":false},{"title":"/v3/web-journeys/undelete","summary":"Undelete a web journey","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/web-journeys-management/undeletewebjourney","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/status","summary":"Get web journey status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneystatus","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/actions","summary":"Get web journey actions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyactions","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/actions","summary":"Update web journey actions","prefix":{"name":"put","color":"put"},"badges":[],"link":"/web-journeys-management/updatewebjourneyactions","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/actions/{actionId}","summary":"Get web journey action by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyaction","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/actions/{actionId}","summary":"Update web journey action","prefix":{"name":"put","color":"put"},"badges":[],"link":"/web-journeys-management/updatewebjourneyaction","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/runs/{runId}/status","summary":"Get web journey run status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyrunstatus","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/runs/{runId}","summary":"Delete web journey run","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/web-journeys-management/deletewebjourneyrun","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/runs/current","summary":"Delete current web journey run","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/web-journeys-management/deletecurrentwebjourneyrun","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/notificationconfig","summary":"Get web journey notification configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneynotificationconfig","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/notificationconfig","summary":"Update web journey notification configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/web-journeys-management/updatewebjourneynotificationconfig","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/rules","summary":"Get web journey rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyrules","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/rules","summary":"Update web journey rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/web-journeys-management/updatewebjourneyrules","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules","summary":"Get web journey action rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyactionrules","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules","summary":"Update web journey action rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/web-journeys-management/updatewebjourneyactionrules","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/remotefilemappings","summary":"Get web journey remote file mappings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyremotefilemappings","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/remotefilemappings","summary":"Update web journey remote file mappings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/web-journeys-management/updatewebjourneyremotefilemappings","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests","summary":"Get action requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyactionrequests","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs","summary":"Get action logs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyactionlogs","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/labels","summary":"Get all labels attached to specified web journey","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyassignedlabels","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/labels","summary":"Patch labels attached to specified web journey","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/web-journeys-management/patchwebjourneyassignedlabels","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/runs/{runId}/info","summary":"Get journey configuration info for specified journey run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/web-journeys-management/getwebjourneyruninfo","deprecated":false},{"title":"/v3/web-journeys/{webJourneyId}/runs","summary":"Run web journey","prefix":{"name":"post","color":"post"},"badges":[],"link":"/web-journeys-management/runwebjourney","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/DateAndTime":{"id":"components/schemas/DateAndTime","kind":"json-schema","title":"DateAndTime","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date-time in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc3339.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC3339 profile ISO 8601 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the following additional restrictions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An uppercase T must separate the date and time portions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An uppercase Z must denote that a numeric time zone offset isn't present."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In general, these timestamp requirements are the same in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AWS Step Functions - Choice Rules"},"children":[]}]}]}]}],"example":"2016-08-18T17:33:00Z"}},"components/schemas/DateUtc":{"id":"components/schemas/DateUtc","kind":"json-schema","title":"DateUtc","data":{"type":"string","format":"date","description":"Date in ISO 8601 format, in UTC timezone"}},"components/schemas/AccountId":{"id":"components/schemas/AccountId","kind":"json-schema","title":"AccountId","data":{"type":"integer","description":"ID of an account","example":123}},"components/schemas/UserId":{"id":"components/schemas/UserId","kind":"json-schema","title":"UserId","data":{"type":"integer","description":"ID of a user","example":123}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":"object","required":["id","userName"],"properties":{"id":{"$ref":"#/components/schemas/UserId"},"userName":{"type":"string"}}}},"components/schemas/FolderId":{"id":"components/schemas/FolderId","kind":"json-schema","title":"FolderId","data":{"type":"integer","format":"int32","description":"ID of a folder","example":123}},"components/schemas/DomainId":{"id":"components/schemas/DomainId","kind":"json-schema","title":"DomainId","data":{"type":"integer","format":"int32","description":"ID of a domain","example":123}},"components/schemas/ItemType":{"id":"components/schemas/ItemType","kind":"json-schema","title":"ItemType","data":{"type":"string","enum":["audit","web_journey","app_journey","live_connect"]}},"components/schemas/ItemId":{"id":"components/schemas/ItemId","kind":"json-schema","title":"ItemId","data":{"type":"integer","format":"int64","description":"ID of a data collector, see ItemType","example":107239}},"components/schemas/WebJourneyId":{"id":"components/schemas/WebJourneyId","kind":"json-schema","title":"WebJourneyId","data":{"type":"integer","format":"int64","example":107239}},"components/schemas/ManualJourneyId":{"id":"components/schemas/ManualJourneyId","kind":"json-schema","title":"ManualJourneyId","data":{"type":"integer","format":"int64","example":107239}},"components/schemas/AuditId":{"id":"components/schemas/AuditId","kind":"json-schema","title":"AuditId","data":{"type":"integer","format":"int64","example":107239}},"components/schemas/AthenaQueryRequestId":{"id":"components/schemas/AthenaQueryRequestId","kind":"json-schema","title":"AthenaQueryRequestId","data":{"type":"string","pattern":"\\S+","minLength":1,"maxLength":128,"example":"7dda25df-580d-4c6b-afc9-a9e87d33f83a"}},"components/schemas/RunId":{"id":"components/schemas/RunId","kind":"json-schema","title":"RunId","data":{"type":"integer","format":"int64","example":33010}},"components/schemas/PageId":{"id":"components/schemas/PageId","kind":"json-schema","title":"PageId","data":{"type":"string","example":"f9d32cc7cc2046d6decb145a80289287f5226323"}},"components/schemas/ActionId":{"id":"components/schemas/ActionId","kind":"json-schema","title":"ActionId","data":{"type":"integer","format":"int64","example":107239}},"components/schemas/ActionSequenceId":{"id":"components/schemas/ActionSequenceId","kind":"json-schema","title":"ActionSequenceId","data":{"type":"integer","format":"int64","example":107239}},"components/schemas/PageUrl":{"id":"components/schemas/PageUrl","kind":"json-schema","title":"PageUrl","data":{"type":"string","format":"url","example":"https://example.com/about"}},"components/schemas/PageLoadTime":{"id":"components/schemas/PageLoadTime","kind":"json-schema","title":"PageLoadTime","data":{"type":"integer","description":"Time page took to load, in milliseconds"}},"components/schemas/PageStatusCode":{"id":"components/schemas/PageStatusCode","kind":"json-schema","title":"PageStatusCode","data":{"type":"integer","description":"Page HTTP status code"}},"components/schemas/TagId":{"id":"components/schemas/TagId","kind":"json-schema","title":"TagId","data":{"type":"integer","description":"Tag ID"}},"components/schemas/TagName":{"id":"components/schemas/TagName","kind":"json-schema","title":"TagName","data":{"type":"string","description":"Tag name"}},"components/schemas/TagAccount":{"id":"components/schemas/TagAccount","kind":"json-schema","title":"TagAccount","data":{"type":"string","description":"Tag account"}},"components/schemas/TagCategoryId":{"id":"components/schemas/TagCategoryId","kind":"json-schema","title":"TagCategoryId","data":{"type":"integer","description":"Tag category ID"}},"components/schemas/TagCategoryName":{"id":"components/schemas/TagCategoryName","kind":"json-schema","title":"TagCategoryName","data":{"type":"string","description":"Name of a category of a tag"}},"components/schemas/TagVendorId":{"id":"components/schemas/TagVendorId","kind":"json-schema","title":"TagVendorId","data":{"type":"integer","description":"Tag vendor ID"}},"components/schemas/TagLoadTime":{"id":"components/schemas/TagLoadTime","kind":"json-schema","title":"TagLoadTime","data":{"type":"integer","description":"Tag load time, in milliseconds","default":0}},"components/schemas/TagRequestSize":{"id":"components/schemas/TagRequestSize","kind":"json-schema","title":"TagRequestSize","data":{"type":"integer","description":"Tag network request size, in bytes"}},"components/schemas/VariableName":{"id":"components/schemas/VariableName","kind":"json-schema","title":"VariableName","data":{"type":"string","description":"Variable name (key)"}},"components/schemas/VariableValue":{"id":"components/schemas/VariableValue","kind":"json-schema","title":"VariableValue","data":{"type":"string","description":"Variable value"}},"components/schemas/StringInclusionFilter":{"id":"components/schemas/StringInclusionFilter","kind":"json-schema","title":"StringInclusionFilter","data":{"type":"object","required":["filterType","filterValue"],"properties":{"filterType":{"$ref":"#/components/schemas/StringInclusionFilterTypeEnum"},"filterValue":{"type":"string","minLength":1}}}},"components/schemas/StringInclusionFilterTypeEnum":{"id":"components/schemas/StringInclusionFilterTypeEnum","kind":"json-schema","title":"StringInclusionFilterTypeEnum","data":{"type":"string","enum":["contains","not_contains"]}},"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"type":"string","description":"A currency represented by its ISO 4217 alpha code","pattern":"^[A-Z]{3}$","example":"USD"}},"components/schemas/MonetaryAmount":{"id":"components/schemas/MonetaryAmount","kind":"json-schema","title":"MonetaryAmount","data":{"type":"object","description":"A monetary amount","required":["amount","currency"],"properties":{"amount":{"type":"number","example":0.01},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}}},"components/schemas/RuleSnapshotId":{"id":"components/schemas/RuleSnapshotId","kind":"json-schema","title":"RuleSnapshotId","data":{"type":"integer","format":"int64"}},"components/schemas/RulePageFilterSnapshotId":{"id":"components/schemas/RulePageFilterSnapshotId","kind":"json-schema","title":"RulePageFilterSnapshotId","data":{"type":"integer","format":"int64"}},"components/schemas/RuleTagSnapshotId":{"id":"components/schemas/RuleTagSnapshotId","kind":"json-schema","title":"RuleTagSnapshotId","data":{"type":"integer","format":"int64"}},"components/schemas/RuleTagVariableSnapshotId":{"id":"components/schemas/RuleTagVariableSnapshotId","kind":"json-schema","title":"RuleTagVariableSnapshotId","data":{"type":"integer","format":"int64"}},"components/schemas/MatchType":{"id":"components/schemas/MatchType","kind":"json-schema","title":"MatchType","data":{"type":"string","enum":["Unknown","TagPresent","Equals","NotEqual","Contains","DoesNotContain","Regex","IsSet","NotSet","GreaterThanOrEquals","LessThanOrEquals","EqualIgnoreCase","NotEqualIgnoreCase","ContainsIgnoreCase","DoesNotContainIgnoreCase"]}},"components/schemas/StatusCodeValueType":{"id":"components/schemas/StatusCodeValueType","kind":"json-schema","title":"StatusCodeValueType","data":{"type":"string","enum":["Specific","SuccessAndRedirect","Broken"]}},"components/schemas/RuleId":{"id":"components/schemas/RuleId","kind":"json-schema","title":"RuleId","data":{"type":"integer","format":"int64","description":"Rule ID","example":12}},"components/schemas/RuleStatus":{"id":"components/schemas/RuleStatus","kind":"json-schema","title":"RuleStatus","data":{"type":"string","enum":["failed","passed","not_applied"]}},"components/schemas/CookieName":{"id":"components/schemas/CookieName","kind":"json-schema","title":"CookieName","data":{"type":"string","description":"Cookie name"}},"components/schemas/CookieDomain":{"id":"components/schemas/CookieDomain","kind":"json-schema","title":"CookieDomain","data":{"type":"string","description":"Cookie domain; preceding dot removed"}},"components/schemas/CookiePartyType":{"id":"components/schemas/CookiePartyType","kind":"json-schema","title":"CookiePartyType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if cookie domain is different from domain of a page it was set on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owned_3rd_party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is deprecated"},"children":[]}]}]}],"enum":["1st_party","owned_3rd_party","3rd_party"]}},"components/schemas/CookieExpirationType":{"id":"components/schemas/CookieExpirationType","kind":"json-schema","title":"CookieExpirationType","data":{"type":"string","enum":["session","timestamp"]}},"components/schemas/CookieSameSite":{"id":"components/schemas/CookieSameSite","kind":"json-schema","title":"CookieSameSite","data":{"type":"string","nullable":true,"enum":["None","Lax","Strict"]}},"components/schemas/CookieSameSiteExtended":{"id":"components/schemas/CookieSameSiteExtended","kind":"json-schema","title":"CookieSameSiteExtended","data":{"type":"string","nullable":true,"enum":["None","Lax","Strict","Empty"]}},"components/schemas/CookieSize":{"id":"components/schemas/CookieSize","kind":"json-schema","title":"CookieSize","data":{"type":"integer","description":"Cookie value size, in bytes. May not be available for old runs","nullable":true}},"components/schemas/CookieChangeTypeEnum":{"id":"components/schemas/CookieChangeTypeEnum","kind":"json-schema","title":"CookieChangeTypeEnum","data":{"type":"string","enum":["ADD","UPDATE","DELETE","NO_CHANGE","REPEAT_SET"]}},"components/schemas/CookieOriginTypeEnum":{"id":"components/schemas/CookieOriginTypeEnum","kind":"json-schema","title":"CookieOriginTypeEnum","data":{"type":"string","nullable":true,"enum":["PRE_AUDIT_ACTION","PAGE_LOAD","ON_PAGE_ACTION"]}},"components/schemas/CookieInitiator":{"id":"components/schemas/CookieInitiator","kind":"json-schema","title":"CookieInitiator","data":{"type":"object","properties":{"tagId":{"$ref":"#/components/schemas/TagId"},"initiatorType":{"type":"string","enum":["HTTP","APP","OP_ACTION","UNKNOWN"]}}}},"components/schemas/CookiePartitionKey":{"id":"components/schemas/CookiePartitionKey","kind":"json-schema","title":"CookiePartitionKey","data":{"type":"object","properties":{"value":{"type":"string"}}}},"components/schemas/BrowserLogMessageLevelEnum":{"id":"components/schemas/BrowserLogMessageLevelEnum","kind":"json-schema","title":"BrowserLogMessageLevelEnum","data":{"type":"string","enum":["error","warn","info","debug","other"]}},"components/schemas/ConsentCategoryName":{"id":"components/schemas/ConsentCategoryName","kind":"json-schema","title":"ConsentCategoryName","data":{"type":"string","description":"Name of consent category item (tag, cookie, domain, geo) belongs to"}},"components/schemas/ConsentCategorySnapshotId":{"id":"components/schemas/ConsentCategorySnapshotId","kind":"json-schema","title":"ConsentCategorySnapshotId","data":{"type":"integer","format":"int64","example":33010,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use in filtering purposes is DEPRECATED in favour of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConsentCategoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"! Snapshot Id of consent category attached to this run"},"children":[]}]}]}]}},"components/schemas/ConsentCategoryId":{"id":"components/schemas/ConsentCategoryId","kind":"json-schema","title":"ConsentCategoryId","data":{"type":"integer","example":3301,"description":"ID of consent category"}},"components/schemas/ConsentCategoryComplianceStatus":{"id":"components/schemas/ConsentCategoryComplianceStatus","kind":"json-schema","title":"ConsentCategoryComplianceStatus","data":{"type":"string","enum":["approved","unapproved"]}},"components/schemas/RunHasNoConsentCategoriesAssigned":{"id":"components/schemas/RunHasNoConsentCategoriesAssigned","kind":"json-schema","title":"RunHasNoConsentCategoriesAssigned","data":{"type":"boolean","description":"When TRUE, run did not have any consent categories assigned.\nWhen NOT specified or FALSE, it had at least one.\n"}},"components/schemas/RequestDomain":{"id":"components/schemas/RequestDomain","kind":"json-schema","title":"RequestDomain","data":{"type":"string","description":"Network request URL domain","example":"example.com"}},"components/schemas/RequestFilename":{"id":"components/schemas/RequestFilename","kind":"json-schema","title":"RequestFilename","data":{"type":"string","description":"Name of the file. Identified as the last non-empty part of URL path","example":"main.js"}},"components/schemas/CountryCode":{"id":"components/schemas/CountryCode","kind":"json-schema","title":"CountryCode","data":{"type":"string","description":"ISO 3166-1 (Alpha-2) country code","example":"US"}},"components/schemas/RequestOriginTypeEnum":{"id":"components/schemas/RequestOriginTypeEnum","kind":"json-schema","title":"RequestOriginTypeEnum","data":{"type":"string","nullable":true,"enum":["PRE_AUDIT_ACTION","ON_PAGE"]}},"components/schemas/ItemRunTrendsItemTrait":{"id":"components/schemas/ItemRunTrendsItemTrait","kind":"json-schema","title":"ItemRunTrendsItemTrait","data":{"type":"object","required":["runId","completedAt"],"properties":{"runId":{"$ref":"#/components/schemas/RunId"},"completedAt":{"$ref":"#/components/schemas/DateAndTime"}}}},"components/schemas/AuditActionSnapshotId":{"id":"components/schemas/AuditActionSnapshotId","kind":"json-schema","title":"AuditActionSnapshotId","data":{"type":"integer","format":"int64","minimum":0,"description":"An ID assigned to actions of all types on an audit - unique in the context of an individual run"}},"components/schemas/AuditRunPageTrait":{"id":"components/schemas/AuditRunPageTrait","kind":"json-schema","title":"AuditRunPageTrait","data":{"description":"Common trait for audit page with mandatory page properties","type":"object","required":["pageId","pageUrl"],"properties":{"pageId":{"$ref":"#/components/schemas/PageId"},"pageUrl":{"$ref":"#/components/schemas/PageUrl"}}}},"components/schemas/AuditRunPageCommonColumnsTrait":{"id":"components/schemas/AuditRunPageCommonColumnsTrait","kind":"json-schema","title":"AuditRunPageCommonColumnsTrait","data":{"description":"Trait for audit page with common page properties","allOf":[{"$ref":"#/components/schemas/AuditRunPageTrait"},{"type":"object","required":["pageLoadTime","pageStatusCode"],"properties":{"pageLoadTime":{"$ref":"#/components/schemas/PageLoadTime"},"pageStatusCode":{"$ref":"#/components/schemas/PageStatusCode"}}}]}},"components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait":{"id":"components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait","kind":"json-schema","title":"AuditRunPageCommonColumnsWithFinalValuesTrait","data":{"description":"Trait for audit page with final URL and final status code","allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsTrait"},{"type":"object","properties":{"finalPageUrl":{"$ref":"#/components/schemas/PageUrl"},"finalPageStatusCode":{"$ref":"#/components/schemas/PageStatusCode"}}}]}},"components/schemas/AuditRunRulePageCountTrait":{"id":"components/schemas/AuditRunRulePageCountTrait","kind":"json-schema","title":"AuditRunRulePageCountTrait","data":{"description":"Common trait for page count per rule result type attributes","type":"object","required":["failedRulePageCount","passedRulePageCount","notAppliedRulePageCount"],"properties":{"failedRulePageCount":{"type":"integer","description":"Number of pages with at least 1 rule failed","default":0},"passedRulePageCount":{"type":"integer","description":"Number of pages with at least 1 rule passed","default":0},"notAppliedRulePageCount":{"type":"integer","description":"Number of pages with at least 1 rule not applied","default":0}}}},"components/schemas/AuditRunRuleCountTrait":{"id":"components/schemas/AuditRunRuleCountTrait","kind":"json-schema","title":"AuditRunRuleCountTrait","data":{"description":"Common trait for rule count per rule result type attributes","type":"object","required":["failedRuleCount","passedRuleCount","notAppliedRuleCount"],"properties":{"failedRuleCount":{"type":"integer","description":"Number of rules failed on at least 1 page","default":0},"passedRuleCount":{"type":"integer","description":"Number of rules passed on at least 1 page","default":0},"notAppliedRuleCount":{"type":"integer","description":"Number of rules not applied on at least 1 page","default":0}}}},"components/schemas/TagInfoTrait":{"id":"components/schemas/TagInfoTrait","kind":"json-schema","title":"TagInfoTrait","data":{"type":"object","description":"Common tag info","required":["tagId","tagName","tagCategoryId","tagCategoryName"],"properties":{"tagId":{"$ref":"#/components/schemas/TagId"},"tagName":{"$ref":"#/components/schemas/TagName"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagCategoryName":{"$ref":"#/components/schemas/TagCategoryName"}}}},"components/schemas/IntegerRangeFilterTrait":{"id":"components/schemas/IntegerRangeFilterTrait","kind":"json-schema","title":"IntegerRangeFilterTrait","data":{"type":"object","description":"Common trait for integer min max filter","properties":{"min":{"type":"integer","minimum":0},"max":{"type":"integer"}}}},"components/schemas/LongIntegerRangeFilterTrait":{"id":"components/schemas/LongIntegerRangeFilterTrait","kind":"json-schema","title":"LongIntegerRangeFilterTrait","data":{"type":"object","description":"Common trait for long integer min max filter","properties":{"min":{"type":"integer","format":"int64","minimum":0},"max":{"type":"integer","format":"int64"}}}},"components/schemas/DoubleRangeFilterTrait":{"id":"components/schemas/DoubleRangeFilterTrait","kind":"json-schema","title":"DoubleRangeFilterTrait","data":{"type":"object","description":"Common trait for double min max filter","properties":{"min":{"type":"number","format":"double","minimum":0},"max":{"type":"number","format":"double"}}}},"components/schemas/PageFiltersTrait":{"id":"components/schemas/PageFiltersTrait","kind":"json-schema","title":"PageFiltersTrait","data":{"type":"object","description":"Common trait for page filters","properties":{"pageUrl":{"$ref":"#/components/schemas/PageUrlFilter"},"finalPageUrl":{"$ref":"#/components/schemas/PageUrlFilter"},"pageTitle":{"$ref":"#/components/schemas/PageTitleFilter"},"initialPageStatusCode":{"$ref":"#/components/schemas/IntegerFilter"},"finalPageStatusCode":{"$ref":"#/components/schemas/IntegerFilter"},"combinedPageStatusCode":{"$ref":"#/components/schemas/CombinedPageStatusCodeEnum"},"pageLoadTime":{"$ref":"#/components/schemas/PageLoadTimeFilter"},"pageSize":{"$ref":"#/components/schemas/PageSizeFilter"},"redirectCount":{"$ref":"#/components/schemas/PageRedirectCountFilter"},"hasBrokenLinks":{"type":"boolean"}}}},"components/schemas/AggregatedCookieTrait":{"id":"components/schemas/AggregatedCookieTrait","kind":"json-schema","title":"AggregatedCookieTrait","data":{"type":"object","description":"Common trait for cookies from Cookie Inventory Cookies and Cookie Privacy Compliance","properties":{"cookieChangedDuring":{"type":"array","description":"List of phases during which this cookie was changed, aggregated across all pages","minItems":1,"items":{"$ref":"#/components/schemas/CookieOriginTypeEnum"}}}}},"components/schemas/CookieFiltersTrait":{"id":"components/schemas/CookieFiltersTrait","kind":"json-schema","title":"CookieFiltersTrait","data":{"type":"object","description":"Common trait for cookie filters","properties":{"cookieOriginInclusion":{"$ref":"#/components/schemas/CookieOriginInclusionTypeEnum"}}}},"components/schemas/PageUrlFilter":{"id":"components/schemas/PageUrlFilter","kind":"json-schema","title":"PageUrlFilter","data":{"type":"object","required":["filterType","filterValue"],"properties":{"filterType":{"$ref":"#/components/schemas/PageUrlFilterEnum"},"filterValue":{"type":"string","minLength":1},"negated":{"type":"boolean","description":"Switches from \"contains\" to \"not contains\", and from \"matches regex\" to \"does not match regex\". Supported only by Page Summary for now","default":false}}}},"components/schemas/PageUrlFilterEnum":{"id":"components/schemas/PageUrlFilterEnum","kind":"json-schema","title":"PageUrlFilterEnum","data":{"type":"string","enum":["contains","regex"]}},"components/schemas/PageTitleFilter":{"id":"components/schemas/PageTitleFilter","kind":"json-schema","title":"PageTitleFilter","data":{"type":"object","required":["filterType","filterValue"],"properties":{"filterType":{"$ref":"#/components/schemas/StringInclusionFilterTypeEnum"},"filterValue":{"type":"string","description":"Page title as displayed by browser","minLength":1,"example":"ObserveP"}}}},"components/schemas/PageLoadTimeFilter":{"id":"components/schemas/PageLoadTimeFilter","kind":"json-schema","title":"PageLoadTimeFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page load time in milliseconds. Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties defined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exclusive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/IntegerRangeFilterTrait"}]}},"components/schemas/PageSizeFilter":{"id":"components/schemas/PageSizeFilter","kind":"json-schema","title":"PageSizeFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page size in bytes. Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties defined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exclusive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/LongIntegerRangeFilterTrait"}]}},"components/schemas/PageRedirectCountFilter":{"id":"components/schemas/PageRedirectCountFilter","kind":"json-schema","title":"PageRedirectCountFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of redirects for a page. Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties defined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exclusive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/IntegerRangeFilterTrait"}]}},"components/schemas/CombinedPageStatusCodeEnum":{"id":"components/schemas/CombinedPageStatusCodeEnum","kind":"json-schema","title":"CombinedPageStatusCodeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - initial or final URL are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"good"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - initial URL is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"good"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and final URL is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"good"},"children":[]}]}]}]}],"enum":["broken","good"]}},"components/schemas/StatusCodeEnum":{"id":"components/schemas/StatusCodeEnum","kind":"json-schema","title":"StatusCodeEnum","data":{"description":"good - 2xx, redirects - 3xx, broken - all others","deprecated":true,"type":"string","enum":["good","redirects","broken"]}},"components/schemas/IntegerFilter":{"id":"components/schemas/IntegerFilter","kind":"json-schema","title":"IntegerFilter","data":{"type":"object","required":["filterType","negated"],"properties":{"filterType":{"$ref":"#/components/schemas/IntegerFilterTypeEnum"},"negated":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Switches from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"between [minInclusive, maxExclusive)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT between [minInclusive, maxExclusive)"},"children":[]}]}]}]}},"discriminator":{"propertyName":"filterType","mapping":{"specific":"#/components/schemas/SpecificIntegerFilter","range":"#/components/schemas/IntegerRangeFilter"}}}},"components/schemas/IntegerFilterTypeEnum":{"id":"components/schemas/IntegerFilterTypeEnum","kind":"json-schema","title":"IntegerFilterTypeEnum","data":{"type":"string","enum":["specific","range"]}},"components/schemas/SpecificIntegerFilter":{"id":"components/schemas/SpecificIntegerFilter","kind":"json-schema","title":"SpecificIntegerFilter","data":{"allOf":[{"$ref":"#/components/schemas/IntegerFilter"},{"type":"object","required":["filterValue"],"properties":{"filterValue":{"type":"integer"}}}]}},"components/schemas/IntegerRangeFilter":{"id":"components/schemas/IntegerRangeFilter","kind":"json-schema","title":"IntegerRangeFilter","data":{"allOf":[{"$ref":"#/components/schemas/IntegerFilter"},{"type":"object","required":["minInclusive","maxExclusive"],"properties":{"minInclusive":{"type":"integer"},"maxExclusive":{"type":"integer"}}}]}},"components/schemas/TagLoadTimeFilter":{"id":"components/schemas/TagLoadTimeFilter","kind":"json-schema","title":"TagLoadTimeFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties defined"},"children":[]}]}]}],"type":"object","properties":{"min":{"type":"integer","description":"Minimum (inclusive) tag load time in milliseconds","minimum":0},"max":{"type":"integer","description":"Maximum (exclusive) tag load time in milliseconds"}}}},"components/schemas/FoldersFilter":{"id":"components/schemas/FoldersFilter","kind":"json-schema","title":"FoldersFilter","data":{"type":"array","description":"non-empty array of folders with domains (subfolders), items from which will be included in response","minItems":1,"items":{"$ref":"#/components/schemas/FoldersFilterItem"}}},"components/schemas/FoldersFilterItem":{"id":"components/schemas/FoldersFilterItem","kind":"json-schema","title":"FoldersFilterItem","data":{"type":"object","required":["folderId"],"properties":{"folderId":{"$ref":"#/components/schemas/FolderId"},"domains":{"type":"array","description":"null or empty array of domains (subfolders) present on an item, works as \"null or empty if entire folder (all domains in a folder), otherwise specific domain IDs\"","items":{"$ref":"#/components/schemas/DomainId"}}}}},"components/schemas/CookieOriginInclusionTypeEnum":{"id":"components/schemas/CookieOriginInclusionTypeEnum","kind":"json-schema","title":"CookieOriginInclusionTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_pre_audit_action_only_cookies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - exclude cookies which were only changed during pre-audit actions"},"children":[]}]}]}]}],"enum":["exclude_pre_audit_action_only_cookies"]}},"components/schemas/ItemRun_SpecificTrendValuesDTO":{"id":"components/schemas/ItemRun_SpecificTrendValuesDTO","kind":"json-schema","title":"ItemRun_SpecificTrendValuesDTO","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/ItemRun_SpecificTrendValueItem"}}}}},"components/schemas/ItemRun_SpecificTrendValueItem":{"id":"components/schemas/ItemRun_SpecificTrendValueItem","kind":"json-schema","title":"ItemRun_SpecificTrendValueItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["trendValue"],"properties":{"trendValue":{"type":"number"}}}]}},"components/schemas/CommonIterableResponseMetadata":{"id":"components/schemas/CommonIterableResponseMetadata","kind":"json-schema","title":"CommonIterableResponseMetadata","data":{"description":"Common metadata for iterable","type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}}}},"components/schemas/ExportId":{"id":"components/schemas/ExportId","kind":"json-schema","title":"ExportId","data":{"type":"integer","format":"int64","description":"Unique ID of an export"}},"components/schemas/ExportUuid":{"id":"components/schemas/ExportUuid","kind":"json-schema","title":"ExportUuid","data":{"type":"string","format":"uuid","description":"Unique ID of an export link"}},"components/schemas/ExportCenter_ExportedItemTypeEnum":{"id":"components/schemas/ExportCenter_ExportedItemTypeEnum","kind":"json-schema","title":"ExportCenter_ExportedItemTypeEnum","data":{"type":"string","enum":["audit","web_journey","live_connect","consent_categories","alert","account_usage","grid_data"]}},"components/schemas/ExportCenter_ExportsSortColumn":{"id":"components/schemas/ExportCenter_ExportsSortColumn","kind":"json-schema","title":"ExportCenter_ExportsSortColumn","data":{"type":"string","enum":["date_exported","item_name","run_date","export_name","exported_item_type","requested_by","status","is_scheduled"],"default":"date_exported"}},"components/schemas/ExportCenter_ExportsDTO":{"id":"components/schemas/ExportCenter_ExportsDTO","kind":"json-schema","title":"ExportCenter_ExportsDTO","data":{"type":"object","required":["metadata","exports"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"exports":{"type":"array","items":{"$ref":"#/components/schemas/ExportCenter_ExportsItem"}}}}},"components/schemas/ExportCenter_ExportsItem":{"id":"components/schemas/ExportCenter_ExportsItem","kind":"json-schema","title":"ExportCenter_ExportsItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not all exports are related to a particular audit/web-journey/manual-journey item or its run, e.g. consent category configs export. Such exports do not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runDate"},"children":[]}]}]}],"required":["exportId","dateExported","exportType","specificExportType","exportName","requestedByUserId","exportStatus","exportDownloadLink"],"properties":{"exportId":{"$ref":"#/components/schemas/ExportId"},"dateExported":{"$ref":"#/components/schemas/DateAndTime"},"exportType":{"$ref":"#/components/schemas/ExportTypeEnum"},"itemType":{"$ref":"#/components/schemas/ExportCenter_ExportedItemTypeEnum"},"itemId":{"$ref":"#/components/schemas/ItemId"},"itemName":{"type":"string","description":"Name of an item this export has been executed for, see ItemType","example":"My Audit"},"runId":{"$ref":"#/components/schemas/RunId"},"runDate":{"$ref":"#/components/schemas/DateAndTime"},"specificExportType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific export type, for example AuditRun_ExportTypeEnum for audits"},"children":[]}]}]}]},"exportName":{"type":"string"},"requestedByUserId":{"$ref":"#/components/schemas/UserId"},"exportStatus":{"$ref":"#/components/schemas/ExportCenter_ExportStatus"},"exportDownloadLink":{"type":"string","description":"Export file download link","example":"https://api.observepoint.com/v3/exports/550e8400-e29b-41d4-a716-446655440000"},"scheduleId":{"$ref":"#/components/schemas/ScheduledExportId"},"isScheduled":{"type":"boolean","description":"Whether the export is scheduled or not","default":false}}}},"components/schemas/ExportCenter_ExportStatus":{"id":"components/schemas/ExportCenter_ExportStatus","kind":"json-schema","title":"ExportCenter_ExportStatus","data":{"type":"string","enum":["queued","in_progress","completed","failed","no_data"]}},"components/schemas/ExportCenter_ResendExportEmailRequestDTO":{"id":"components/schemas/ExportCenter_ResendExportEmailRequestDTO","kind":"json-schema","title":"ExportCenter_ResendExportEmailRequestDTO","data":{"type":"object","required":["toAddresses"],"properties":{"toAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"},"minItems":1,"maxItems":10,"description":"list of unique emails"},"customEmailMessage":{"type":"string","minLength":1,"maxLength":1000,"example":"Here is the export, enjoy!"}}}},"components/schemas/EmailAddress":{"id":"components/schemas/EmailAddress","kind":"json-schema","title":"EmailAddress","data":{"type":"string","format":"email","minLength":3,"example":"user@example.com"}},"components/schemas/ScheduledExportId":{"id":"components/schemas/ScheduledExportId","kind":"json-schema","title":"ScheduledExportId","data":{"type":"integer","format":"int64"}},"components/schemas/ScheduledExports_ExportedItemType":{"id":"components/schemas/ScheduledExports_ExportedItemType","kind":"json-schema","title":"ScheduledExports_ExportedItemType","data":{"type":"string","enum":["saved_report"]}},"components/schemas/ScheduledExports_ReportLinkType":{"id":"components/schemas/ScheduledExports_ReportLinkType","kind":"json-schema","title":"ScheduledExports_ReportLinkType","data":{"type":"string","enum":["public_link","regular_link"]}},"components/schemas/ScheduledExports_ExportedItemId":{"id":"components/schemas/ScheduledExports_ExportedItemId","kind":"json-schema","title":"ScheduledExports_ExportedItemId","data":{"type":"integer","format":"int64"}},"components/schemas/ScheduledExports_ExportFileFormat":{"id":"components/schemas/ScheduledExports_ExportFileFormat","kind":"json-schema","title":"ScheduledExports_ExportFileFormat","data":{"type":"string","enum":["csv","tsv","xlsx"]}},"components/schemas/ScheduledExports_SortColumn":{"id":"components/schemas/ScheduledExports_SortColumn","kind":"json-schema","title":"ScheduledExports_SortColumn","data":{"type":"string","enum":["name","schedule_description","schedule_is_paused","owner_user_name","exported_item_type","exported_item_name","is_editable","created_at","updated_at"]}},"components/schemas/ScheduledExports_ScheduleConfig":{"id":"components/schemas/ScheduledExports_ScheduleConfig","kind":"json-schema","title":"ScheduledExports_ScheduleConfig","data":{"type":"object","description":"When and how often Scheduled Export will be run.","required":["dtStart","recurrenceRule","tzId","isPaused"],"properties":{"dtStart":{"type":"string","format":"local-date-time","description":"Date of first desired start (if in range of recurrence rule).","example":"2025-03-14T12:00:00"},"recurrenceRule":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string."},"children":[]}]}]}],"example":"WKST=SU;FREQ=DAILY;INTERVAL=1"},"tzId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timezone identifier compliant with tz database (ex. America/New_York). https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"},"children":[]}]}]}],"example":"America/New_York"},"isPaused":{"type":"boolean","description":"Whether the schedule is paused or not."},"exceptions":{"description":"List of dates to skip when scheduling. If empty or omitted, no dates will be skipped.","type":"array","items":{"type":"string","format":"local-date-time","example":"2025-03-14T12:00:00"}}}}},"components/schemas/ScheduledExports_ScheduleConfigWithDescription":{"id":"components/schemas/ScheduledExports_ScheduleConfigWithDescription","kind":"json-schema","title":"ScheduledExports_ScheduleConfigWithDescription","data":{"allOf":[{"$ref":"#/components/schemas/ScheduledExports_ScheduleConfig"},{"type":"object","required":["description","presetType"],"properties":{"description":{"type":"string","example":"Every day"},"presetType":{"type":"string","example":"DAILY"},"nextExportAt":{"$ref":"#/components/schemas/DateAndTime"}}}]}},"components/schemas/ScheduledExports_ExportEmailConfig":{"id":"components/schemas/ScheduledExports_ExportEmailConfig","kind":"json-schema","title":"ScheduledExports_ExportEmailConfig","data":{"type":"object","description":"Configuration for the email sent when export completes.","required":["addExportFileAttachment"],"properties":{"addExportFileAttachment":{"type":"boolean"},"customMessage":{"type":"string"},"reportLinkType":{"$ref":"#/components/schemas/ScheduledExports_ReportLinkType"},"suppressEmailWhenNoData":{"type":"boolean","default":false}}}},"components/schemas/ScheduledExports_CommonTrait":{"id":"components/schemas/ScheduledExports_CommonTrait","kind":"json-schema","title":"ScheduledExports_CommonTrait","data":{"type":"object","required":["name","exportedItemType","exportedItemId","exportFileFormat","exportEmailConfig"],"properties":{"name":{"type":"string"},"exportedItemType":{"$ref":"#/components/schemas/ScheduledExports_ExportedItemType"},"exportedItemId":{"$ref":"#/components/schemas/ScheduledExports_ExportedItemId"},"exportFileFormat":{"$ref":"#/components/schemas/ScheduledExports_ExportFileFormat"},"exportEmailConfig":{"$ref":"#/components/schemas/ScheduledExports_ExportEmailConfig"},"emails":{"type":"array","description":"List of email addresses that will receive export email. If empty, no emails will be sent. If omitted, emails will not be changed (update only).","items":{"$ref":"#/components/schemas/EmailAddress"}}}}},"components/schemas/CreateScheduledExportRequestDTO":{"id":"components/schemas/CreateScheduledExportRequestDTO","kind":"json-schema","title":"CreateScheduledExportRequestDTO","data":{"allOf":[{"$ref":"#/components/schemas/ScheduledExports_CommonTrait"},{"type":"object","required":["schedule"],"properties":{"schedule":{"$ref":"#/components/schemas/ScheduledExports_ScheduleConfig"}}}]}},"components/schemas/ScheduledExportDTO":{"id":"components/schemas/ScheduledExportDTO","kind":"json-schema","title":"ScheduledExportDTO","data":{"allOf":[{"$ref":"#/components/schemas/ScheduledExports_CommonTrait"},{"type":"object","required":["id","schedule","exportedItemName","isEditable"],"properties":{"id":{"$ref":"#/components/schemas/ScheduledExportId"},"createdAt":{"$ref":"#/components/schemas/DateAndTime"},"updatedAt":{"$ref":"#/components/schemas/DateAndTime"},"owner":{"$ref":"#/components/schemas/User"},"schedule":{"$ref":"#/components/schemas/ScheduledExports_ScheduleConfigWithDescription"},"exportedItemName":{"type":"string"},"isEditable":{"type":"boolean"}}}]}},"components/schemas/ScheduledExportListDTO":{"id":"components/schemas/ScheduledExportListDTO","kind":"json-schema","title":"ScheduledExportListDTO","data":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"scheduledExports":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledExportDTO"}}}}},"components/schemas/AuditRunPage_InitiatorsTree_RequestDTO":{"id":"components/schemas/AuditRunPage_InitiatorsTree_RequestDTO","kind":"json-schema","title":"AuditRunPage_InitiatorsTree_RequestDTO","data":{"description":"Request body with filters for Page Details Initiators tree, supporting filtering by request tags and cookies as well as request attributes","type":"object","properties":{"tagsOnly":{"type":"boolean","description":"If set then return only tags, else ignored"},"primaryTagsOnly":{"type":"boolean","description":"If set then return only primary tags, else ignored"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"withCookiesOnly":{"type":"boolean","description":"If set then return only requests that specified cookies, else ignored"},"cookieName":{"$ref":"#/components/schemas/StringInclusionFilter"},"cookieDomain":{"$ref":"#/components/schemas/StringInclusionFilter"},"partyType":{"$ref":"#/components/schemas/CookiePartyType"},"requestUrl":{"$ref":"#/components/schemas/StringInclusionFilter"},"requestStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"}}}},"components/schemas/AuditRunPage_InitiatorsTree_ResponseDTO":{"id":"components/schemas/AuditRunPage_InitiatorsTree_ResponseDTO","kind":"json-schema","title":"AuditRunPage_InitiatorsTree_ResponseDTO","data":{"type":"object","required":["initiatorsSummary","initiatorsTreeRoot"],"properties":{"initiatorsSummary":{"$ref":"#/components/schemas/AuditRunPage_InitiatorsSummary"},"initiatorsTreeRoot":{"$ref":"#/components/schemas/InitiatorsTreeVertex"}}}},"components/schemas/AuditRunPage_InitiatorsSummary":{"id":"components/schemas/AuditRunPage_InitiatorsSummary","kind":"json-schema","title":"AuditRunPage_InitiatorsSummary","data":{"type":"object","required":["totalNetworkRequestCount","filteredNetworkRequestCount","totalBrokenNetworkRequestCount","filteredBrokenNetworkRequestCount","totalTagCount","filteredTagCount","totalCookieCount","filteredCookieCount"],"properties":{"totalNetworkRequestCount":{"type":"integer","minimum":1},"filteredNetworkRequestCount":{"type":"integer","minimum":0},"totalBrokenNetworkRequestCount":{"type":"integer","minimum":0},"filteredBrokenNetworkRequestCount":{"type":"integer","minimum":0},"totalTagCount":{"type":"integer","minimum":0},"filteredTagCount":{"type":"integer","minimum":0},"totalCookieCount":{"type":"integer","minimum":0},"filteredCookieCount":{"type":"integer","minimum":0}}}},"components/schemas/InitiatorsTreeVertex":{"id":"components/schemas/InitiatorsTreeVertex","kind":"json-schema","title":"InitiatorsTreeVertex","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a node in the initiators tree."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each node/vertex is a network request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The root node is the page request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The root node does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relationToParent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Leaf nodes are requests that have no children."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get information about specific nodes use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/initiators/request-log"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"harEntryIndices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified"},"children":[]}]}]}],"type":"object","required":["harEntryIndex","children","originalSubtreeSize","filteredSubtreeSize","matchesFilter"],"properties":{"harEntryIndex":{"$ref":"#/components/schemas/HarEntryIndex"},"relationToParent":{"$ref":"#/components/schemas/InitiatorParentChildRelationType"},"children":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When filters applied, only the following nodes are retained in the children array:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"leaf nodes matching filters,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"intermediate nodes matching filters,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"intermediate nodes not matching filters but having successors matching filters."},"children":[]}]}]}]}],"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/InitiatorsTreeVertex"}},"originalSubtreeSize":{"type":"integer","description":"Total number of nodes under the current node (including its children, grand-children and so on)"},"filteredSubtreeSize":{"type":"integer","description":"Number of nodes under the current node (including its children, grand-children and so on) after filtering"},"matchesFilter":{"type":"boolean","description":"True if this node matches the filter criteria; false if kept only as a path to matching descendants"}}}},"components/schemas/InitiatorParentChildRelationType":{"id":"components/schemas/InitiatorParentChildRelationType","kind":"json-schema","title":"InitiatorParentChildRelationType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"normal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", may be omitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The root node does not have relation."},"children":[]}]}]}],"enum":["normal","weak"]}},"components/schemas/HarEntryIndex":{"id":"components/schemas/HarEntryIndex","kind":"json-schema","title":"HarEntryIndex","data":{"type":"integer","minimum":0,"description":"The 0-based index of the HAR entry that this request corresponds to. Used to uniquely identify a request on a page."}},"components/schemas/QueryByHarEntryIndices_RequestDto":{"id":"components/schemas/QueryByHarEntryIndices_RequestDto","kind":"json-schema","title":"QueryByHarEntryIndices_RequestDto","data":{"type":"object","required":["harEntryIndices"],"properties":{"harEntryIndices":{"type":"array","description":"Empty array means \"query all (no filtering)\"","minItems":0,"maxItems":10000,"items":{"$ref":"#/components/schemas/HarEntryIndex"}}}}},"components/schemas/GetCookiesByHarEntryIndices_ResponseDto":{"id":"components/schemas/GetCookiesByHarEntryIndices_ResponseDto","kind":"json-schema","title":"GetCookiesByHarEntryIndices_ResponseDto","data":{"type":"object","required":["requests"],"properties":{"requests":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/GetCookiesByHarEntryIndices_RequestItem"}}}}},"components/schemas/GetCookiesByHarEntryIndices_RequestItem":{"id":"components/schemas/GetCookiesByHarEntryIndices_RequestItem","kind":"json-schema","title":"GetCookiesByHarEntryIndices_RequestItem","data":{"type":"object","required":["harEntryIndex","cookies"],"properties":{"harEntryIndex":{"$ref":"#/components/schemas/HarEntryIndex"},"cookies":{"type":"array","items":{"$ref":"#/components/schemas/GetCookiesByHarEntryIndices_RequestCookieItem"}}}}},"components/schemas/GetCookiesByHarEntryIndices_RequestCookieItem":{"id":"components/schemas/GetCookiesByHarEntryIndices_RequestCookieItem","kind":"json-schema","title":"GetCookiesByHarEntryIndices_RequestCookieItem","data":{"allOf":[{"$ref":"#/components/schemas/BaseResponseCookieChangeItemTrait"}]}},"components/schemas/GetRequestsByHarEntryIndices_ResponseDto":{"id":"components/schemas/GetRequestsByHarEntryIndices_ResponseDto","kind":"json-schema","title":"GetRequestsByHarEntryIndices_ResponseDto","data":{"type":"object","required":["requests"],"properties":{"requests":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/GetRequestsByHarEntryIndices_RequestItem"}}}}},"components/schemas/GetRequestsByHarEntryIndices_RequestItem":{"id":"components/schemas/GetRequestsByHarEntryIndices_RequestItem","kind":"json-schema","title":"GetRequestsByHarEntryIndices_RequestItem","data":{"allOf":[{"$ref":"#/components/schemas/RequestLogTrait"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These properties are available altogether only if request is a tag:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tagId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tagVendorId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tagCategoryId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tagAccount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileSubstitution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present only if request had file substitution applied."},"children":[]}]}]}]}],"required":["consoleLogSummary"],"properties":{"tagId":{"$ref":"#/components/schemas/TagId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"consoleLogSummary":{"$ref":"#/components/schemas/ConsoleLogSummary"},"fileSubstitution":{"$ref":"#/components/schemas/FileSubstitution"}}}]}},"components/schemas/FileSubstitution":{"id":"components/schemas/FileSubstitution","kind":"json-schema","title":"FileSubstitution","data":{"type":"object","required":["substituteUrl"],"properties":{"substituteUrl":{"type":"string","description":"URL of the file that was used as a substitute"},"tagId":{"type":"integer"},"failure":{"$ref":"#/components/schemas/FileSubstitutionFailure"}}}},"components/schemas/FileSubstitutionFailure":{"id":"components/schemas/FileSubstitutionFailure","kind":"json-schema","title":"FileSubstitutionFailure","data":{"type":"object","required":["failureType"],"properties":{"failureType":{"$ref":"#/components/schemas/FileSubstitutionFailureType"},"failureMessage":{"type":"string"}}}},"components/schemas/FileSubstitutionFailureType":{"id":"components/schemas/FileSubstitutionFailureType","kind":"json-schema","title":"FileSubstitutionFailureType","data":{"type":"string","enum":["unknown","file_size_limit_exceeded","file_not_found","cannot_get_file"]}},"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO":{"id":"components/schemas/AuditRunPage_ConsoleLogs_RequestDTO","kind":"json-schema","title":"AuditRunPage_ConsoleLogs_RequestDTO","data":{"type":"object","properties":{"includedLevels":{"type":"array","items":{"$ref":"#/components/schemas/BrowserLogMessageLevelEnum"}},"search":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters logs by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with 'contains' predicate"},"children":[]}]}]}]}}}},"components/schemas/AuditRunPage_ConsoleLogsDTO":{"id":"components/schemas/AuditRunPage_ConsoleLogsDTO","kind":"json-schema","title":"AuditRunPage_ConsoleLogsDTO","data":{"type":"object","required":["metadata","consoleLogs"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"consoleLogs":{"type":"array","items":{"$ref":"#/components/schemas/BrowserConsoleLog"}}}}},"components/schemas/ConsoleLogSummary":{"id":"components/schemas/ConsoleLogSummary","kind":"json-schema","title":"ConsoleLogSummary","data":{"type":"object","required":["errorLogCount","warnLogCount","infoLogCount","debugLogCount","otherLogCount"],"properties":{"errorLogCount":{"type":"integer"},"warnLogCount":{"type":"integer"},"debugLogCount":{"type":"integer"},"infoLogCount":{"type":"integer","example":4},"otherLogCount":{"type":"integer","deprecated":true,"description":"Deprecated, included only for backward compatibility, value is always 0"}}}},"components/schemas/AuditRunPage_BrowserLogs_MessagesSortColumn":{"id":"components/schemas/AuditRunPage_BrowserLogs_MessagesSortColumn","kind":"json-schema","title":"AuditRunPage_BrowserLogs_MessagesSortColumn","data":{"type":"string","enum":["message","timestamp","level","source","count","related_tag"]}},"components/schemas/BrowserConsoleLog":{"id":"components/schemas/BrowserConsoleLog","kind":"json-schema","title":"BrowserConsoleLog","data":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64","example":1612568767911},"message":{"type":"string","example":"loadscript added to queue: /path/to/example.js"},"level":{"$ref":"#/components/schemas/BrowserLogMessageLevelEnum"},"source":{"type":"string"},"count":{"type":"integer","example":4},"relatedTag":{"$ref":"#/components/schemas/BrowserConsoleLogTagItem"}},"required":["timestamp","message","level","count"]}},"components/schemas/BrowserConsoleLogTagItem":{"id":"components/schemas/BrowserConsoleLogTagItem","kind":"json-schema","title":"BrowserConsoleLogTagItem","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"}]}},"components/schemas/AuditRun_PageDetails_RequestLogSortColumn":{"id":"components/schemas/AuditRun_PageDetails_RequestLogSortColumn","kind":"json-schema","title":"AuditRun_PageDetails_RequestLogSortColumn","data":{"type":"string","enum":["request_start_time","request_url","tag_name","mime_type","response_size","load_time","status_code","geo","date_difference","size_difference","started_at"]}},"components/schemas/RequestLogDTO":{"id":"components/schemas/RequestLogDTO","kind":"json-schema","title":"RequestLogDTO","data":{"type":"object","required":["metadata","requests"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"requests":{"type":"array","items":{"$ref":"#/components/schemas/RequestLog"}}}}},"components/schemas/RequestLog":{"id":"components/schemas/RequestLog","kind":"json-schema","title":"RequestLog","data":{"allOf":[{"$ref":"#/components/schemas/RequestLogTrait"},{"type":"object","description":"fileChange property is only available for customers who purchased privacy product offering","properties":{"tagId":{"type":"integer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property instead"},"children":[]}]}]}]},"tag":{"$ref":"#/components/schemas/RequestLogItemTag"},"fileChange":{"$ref":"#/components/schemas/RequestLogItemFileChange"},"origin":{"$ref":"#/components/schemas/RequestOriginTypeEnum"},"relatedCookies":{"type":"array","items":{"$ref":"#/components/schemas/CookieOriginRequestDTO"}}}}]}},"components/schemas/RequestLogTrait":{"id":"components/schemas/RequestLogTrait","kind":"json-schema","title":"RequestLogTrait","data":{"type":"object","required":["harEntryIndex","requestUrl","statusCode","loadTime"],"properties":{"harEntryIndex":{"$ref":"#/components/schemas/HarEntryIndex"},"resourceType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of resource that was requested.  e.g. 'xhr', 'script', 'image', 'stylesheet', 'font', 'document', 'other'. Available since "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://observepoint.atlassian.net/browse/WORK-24937"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WORK-24937"},"children":[]}]}]}]}]},"method":{"type":"string","description":"The HTTP method used for the request"},"serverIPAddress":{"type":"string","format":"ipAddress","description":"The IP address of the server that responded to the request"},"httpVersion":{"type":"string","description":"The HTTP version used for the request (e.g. 'HTTP/1.1')"},"requestUrl":{"type":"string"},"statusCode":{"type":"integer","description":"HTTP status code of network request"},"loadTime":{"type":"number","description":"Time took for network request to execute, in milliseconds"},"geoLocation":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geoLocationInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property instead. It will be renamed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geoLocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" soon"},"children":[]}]}]}]},"geoLocationInfo":{"$ref":"#/components/schemas/RequestLogItemGeoLocation"},"mimeType":{"type":"string"},"fileInfo":{"$ref":"#/components/schemas/RequestLogItemFileInfo"},"responseSizeBytes":{"type":"integer"},"startedAt":{"$ref":"#/components/schemas/DateAndTime"},"startedAtRelativeToPageNavigation":{"type":"integer","format":"int64"}}}},"components/schemas/RequestLogItemTag":{"id":"components/schemas/RequestLogItemTag","kind":"json-schema","title":"RequestLogItemTag","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"}]}},"components/schemas/RequestLogItemGeoLocation":{"id":"components/schemas/RequestLogItemGeoLocation","kind":"json-schema","title":"RequestLogItemGeoLocation","data":{"type":"object","required":["countryCode","countryName"],"properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"countryName":{"type":"string"}}}},"components/schemas/RequestLogItemFileInfo":{"id":"components/schemas/RequestLogItemFileInfo","kind":"json-schema","title":"RequestLogItemFileInfo","data":{"type":"object","required":["filename","requestDomain"],"properties":{"lastModifiedDate":{"$ref":"#/components/schemas/DateAndTime"},"filename":{"$ref":"#/components/schemas/RequestFilename"},"requestDomain":{"$ref":"#/components/schemas/RequestDomain"}}}},"components/schemas/RequestLogItemFileChange":{"id":"components/schemas/RequestLogItemFileChange","kind":"json-schema","title":"RequestLogItemFileChange","data":{"type":"object","description":"Available only for JavaScript files for now. Provided only for customers that have Privacy features available.\n","required":["fileChangeType"],"properties":{"fileChangeType":{"$ref":"#/components/schemas/AuditRun_FileChanges_FileChangeType"},"largestDateDifference":{"$ref":"#/components/schemas/AuditRun_FileChanges_DateDifferenceInMinutes"},"largestSizeDifference":{"$ref":"#/components/schemas/AuditRun_FileChanges_SizeDifferenceInBytes"}}}},"components/schemas/TagInfoDTO":{"id":"components/schemas/TagInfoDTO","kind":"json-schema","title":"TagInfoDTO","data":{"type":"array","items":{"$ref":"#/components/schemas/TagInfo"}}},"components/schemas/TagInfoDTOWithInsights":{"id":"components/schemas/TagInfoDTOWithInsights","kind":"json-schema","title":"TagInfoDTOWithInsights","data":{"type":"object","properties":{"pageTagInsights":{"$ref":"#/components/schemas/TagInsights"},"pageTags":{"$ref":"#/components/schemas/TagInfoDTO"}}}},"components/schemas/TagInsights":{"id":"components/schemas/TagInsights","kind":"json-schema","title":"TagInsights","data":{"type":"object","properties":{"noOfTagRequests":{"type":"integer"},"noOfUniqueTags":{"type":"integer"},"noOfBrokenTags":{"type":"integer"}}}},"components/schemas/TagInfo":{"id":"components/schemas/TagInfo","kind":"json-schema","title":"TagInfo","data":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"tagId":{"type":"integer"},"pageTagInstances":{"type":"array","items":{"$ref":"#/components/schemas/TagInstance"}},"relatedCookies":{"type":"array","items":{"$ref":"#/components/schemas/CookieOriginRequestDTO"}},"tagRequestCount":{"type":"integer","description":"Total number of tag requests on a page for given tag"},"tagDuplicateRequestCount":{"type":"integer","description":"Number of duplicate tag requests for given tag"},"tagMultipleRequestCount":{"type":"integer","description":"Number of multiple tag requests for given tag (tag requests that are not exact copies of each other and have the same account)"},"tagUniqueRequestCount":{"type":"integer","description":"Number of tag requests that do not have duplicates or multiples"}}}},"components/schemas/TagInstance":{"id":"components/schemas/TagInstance","kind":"json-schema","title":"TagInstance","data":{"type":"object","properties":{"tagInstanceId":{"type":"string"},"account":{"type":"string"},"bytes":{"type":"integer"},"loadTime":{"type":"integer","format":"int64"},"duplicates":{"type":"integer"},"multiples":{"type":"integer"},"statusCode":{"type":"integer"},"tagInstanceVariables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}},"relatedCookies":{"type":"array","items":{"$ref":"#/components/schemas/CookieOriginRequestDTO"}},"harEntryIndex":{"$ref":"#/components/schemas/HarEntryIndex"}}}},"components/schemas/Variable":{"id":"components/schemas/Variable","kind":"json-schema","title":"Variable","data":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"components/schemas/SparkLinesDTO":{"id":"components/schemas/SparkLinesDTO","kind":"json-schema","title":"SparkLinesDTO","data":{"type":"array","items":{"$ref":"#/components/schemas/SparkLineDTO"}}},"components/schemas/SparkLineDTO":{"id":"components/schemas/SparkLineDTO","kind":"json-schema","title":"SparkLineDTO","data":{"type":"object","properties":{"runId":{"type":"number"},"runCompletionDate":{"type":"string","format":"date-time"},"pageInsights":{"$ref":"#/components/schemas/SparkLinePageInsights"}}}},"components/schemas/SparkLinePageInsights":{"id":"components/schemas/SparkLinePageInsights","kind":"json-schema","title":"SparkLinePageInsights","data":{"type":"object","properties":{"loadTime":{"type":"number"},"statusCode":{"type":"number"},"size":{"type":"number"}}}},"components/schemas/PageTrendsDTO":{"id":"components/schemas/PageTrendsDTO","kind":"json-schema","title":"PageTrendsDTO","data":{"type":"array","items":{"$ref":"#/components/schemas/PageTrendDTO"}}},"components/schemas/PageTrendDTO":{"id":"components/schemas/PageTrendDTO","kind":"json-schema","title":"PageTrendDTO","data":{"type":"object","properties":{"runId":{"type":"integer","format":"int64"},"runCompletionDate":{"type":"string","format":"date-time"},"trendName":{"type":"string"},"trendValue":{"type":"integer","format":"int64"}}}},"components/schemas/PageSummaryTrendsDTO":{"id":"components/schemas/PageSummaryTrendsDTO","kind":"json-schema","title":"PageSummaryTrendsDTO","data":{"type":"object","properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/PageSummaryTrendDTO"}}}}},"components/schemas/PageSummaryTrendDTO":{"id":"components/schemas/PageSummaryTrendDTO","kind":"json-schema","title":"PageSummaryTrendDTO","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","properties":{"trendValue":{"type":"integer"}}}]}},"components/schemas/AuditPage":{"id":"components/schemas/AuditPage","kind":"json-schema","title":"AuditPage","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PageId"},"url":{"type":"string"},"loadTime":{"type":"number"},"statusCode":{"type":"integer"},"size":{"type":"number"}}}},"components/schemas/PageInfo":{"id":"components/schemas/PageInfo","kind":"json-schema","title":"PageInfo","data":{"type":"object","properties":{"url":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialPageUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}]},"initialPageUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial page URL - before the first redirect. If there were no redirects, equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finalPageUrl"},"children":[]}]}]}]},"loadTime":{"type":"number"},"statusCode":{"type":"integer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"example":200},"initialStatusCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial page status code - before the first redirect. If there were no redirects, equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finalStatusCode"},"children":[]}]}]}]},"size":{"type":"number"},"screenshot":{"type":"string"},"parent":{"type":"object","properties":{"pageId":{"type":"string"},"pageUrl":{"type":"string"}}},"finalPageUrl":{"type":"string","example":"https://example.com/some-path","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final page URL - after all redirects. If there were no redirects, equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialPageUrl"},"children":[]}]}]}],"maxLength":11264},"finalStatusCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status code - after all redirects. If there were no redirects, equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialStatusCode"},"children":[]}]}]}],"example":302},"title":{"type":"object","description":"Page title as displayed by browser","example":"My Cards - ObservePoint"},"browserError":{"type":"string","description":"error produced by browser upon opening the page","example":"This site can’t be reached. example.com’s server IP address could not be found. ERR_NAME_NOT_RESOLVED"},"visitStartTimestamp":{"type":"integer","format":"int64","description":"timestamp - GMT in milliseconds","example":1637944293},"visitEndTimestamp":{"type":"integer","format":"int64","description":"timestamp - GMT in milliseconds","example":1637944293},"redirects":{"type":"array","description":"NULL if page had no redirects. Does not include final page","maxItems":100,"items":{"$ref":"#/components/schemas/AuditRun_PageInfo_RedirectChainElement"}},"links":{"$ref":"#/components/schemas/AuditRun_PageInfo_LinkSummary"},"onPageActionResults":{"description":"(Optional) Present if failure/s is/are present in On-Page Actions execution","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/AuditActionResult"}},"webVitalsSummary":{"$ref":"#/components/schemas/WebVitalsSummary"},"accessibilityChecksSummary":{"$ref":"#/components/schemas/AccessibilityChecksResults"}}}},"components/schemas/AccessibilityChecksResults":{"id":"components/schemas/AccessibilityChecksResults","kind":"json-schema","title":"AccessibilityChecksResults","data":{"type":"object","required":["configurationTags","issues"],"properties":{"configurationTags":{"description":"The tags used for the run configuration that indicate both version and conformance level","type":"array","items":{"type":"string","description":"The conformance levels of the checks"},"example":["wcag2a","wcag21aa","wcag2aaa","wcag2aa","wcag21a","wcag22aa"]},"scores":{"$ref":"#/components/schemas/PageAccessibilityScores"},"issues":{"type":"array","items":{"$ref":"#/components/schemas/AccessibilityRuleResult"}},"inconclusive":{"description":"The accessibility checks that were inconclusive","type":"array","items":{"$ref":"#/components/schemas/AccessibilityRuleResult"},"example":[{"id":"color-contrast","impact":"serious","description":"Elements must meet enhanced color contrast ratio thresholds","help":"Elements must meet enhanced color contrast ratio thresholds","helpUrl":"https://www.w3.org/WAI/WCAG21/Understanding/contrast-enhanced","htmlElements":[{"html":"<span class='fl-heading-text'>Validate Your Privacy, Landing Pages, and Analytics</span>","htmlCssSelectors":["h1",".fl-heading-text"],"failureSummary":"Fix any of the following: Element's background color could not be determined due to a background image"}]}]}}}},"components/schemas/PageAccessibilityScores":{"id":"components/schemas/PageAccessibilityScores","kind":"json-schema","title":"PageAccessibilityScores","data":{"type":"object","description":"The accessibility scores for the page based on different WCAG versions and conformance levels","required":["wcag2a","wcag2aa","wcag2aaa","wcag21a","wcag21aa","wcag21aaa","wcag22a","wcag22aa","wcag22aaa"],"properties":{"wcag2a":{"$ref":"#/components/schemas/PageScoreValue"},"wcag2aa":{"$ref":"#/components/schemas/PageScoreValue"},"wcag2aaa":{"$ref":"#/components/schemas/PageScoreValue"},"wcag21a":{"$ref":"#/components/schemas/PageScoreValue"},"wcag21aa":{"$ref":"#/components/schemas/PageScoreValue"},"wcag21aaa":{"$ref":"#/components/schemas/PageScoreValue"},"wcag22a":{"$ref":"#/components/schemas/PageScoreValue"},"wcag22aa":{"$ref":"#/components/schemas/PageScoreValue"},"wcag22aaa":{"$ref":"#/components/schemas/PageScoreValue"}}}},"components/schemas/PageScoreValue":{"id":"components/schemas/PageScoreValue","kind":"json-schema","title":"PageScoreValue","data":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page accessibility score in %, 1 digit after decimal point"},"children":[]}]}]}],"minimum":0,"maximum":100}},"components/schemas/AccessibilityRuleResult":{"id":"components/schemas/AccessibilityRuleResult","kind":"json-schema","title":"AccessibilityRuleResult","data":{"type":"object","required":["id","impact","description","help","wcagVersion","wcagConformanceLevel","successCriteria","htmlElements"],"properties":{"id":{"type":"string","description":"The unique identifier for the evaluated rule"},"impact":{"type":"string","description":"The impact of the issue","enum":["minor","moderate","serious","critical"]},"description":{"type":"string","description":"The description of the issue"},"help":{"type":"string","description":"The help text for the issue","example":"Elements must meet enhanced color contrast ratio thresholds"},"wcagVersion":{"type":"string","description":"The WCAG version that the issue is associated with","example":"2.1"},"wcagConformanceLevel":{"type":"string","description":"The WCAG conformance level that the issue is associated with","example":"AA"},"successCriteria":{"description":"List of success criteria that the issue is associated with","type":"array","items":{"$ref":"#/components/schemas/AccessibilitySuccessCriteria"}},"htmlElements":{"type":"array","items":{"$ref":"#/components/schemas/AccessibilityTestedElement"},"minItems":1}}}},"components/schemas/AccessibilityTestedElement":{"id":"components/schemas/AccessibilityTestedElement","kind":"json-schema","title":"AccessibilityTestedElement","data":{"type":"object","required":["html"],"properties":{"failureSummary":{"type":"string","description":"Summary of all rule criteria which failed and needs to be resolved.","example":"Fix any of the following: Element has insufficient color contrast of 6.14 (foreground color: #5d5d5d, background color: #f7f7f7, font size: 12.0pt (16px), font weight: normal). Expected contrast ratio of 7:1"},"fixOneOf":{"type":"array","description":"List of rule criteria where at least one must pass for the rule to be considered passing.","items":{"type":"string"}},"fixAllOf":{"type":"array","description":"List of rule criteria where all must pass for the rule to be considered passing.","items":{"type":"string"}},"doNoneOf":{"type":"array","description":"List of rule criteria where all must not pass for the rule to be considered passing.","items":{"type":"string"}},"html":{"type":"string","description":"The html for the node","example":"<span style='font-weight: 400;'>(without 10 new QA headcount.)</span>"},"htmlCssSelectors":{"description":"The html/css selector for the issue","type":"array","items":{"type":"string"}},"shadowDomCssSelectors":{"description":"This points to an element in a shadow DOM and each item (except the n-1th) in this array is a selector to a DOM element with a shadow DOM. The last element in the array points to the final node within the shadow DOM.","type":"array","items":{"type":"array","items":{"type":"string"}}}}}},"components/schemas/AccessibilitySuccessCriteria":{"id":"components/schemas/AccessibilitySuccessCriteria","kind":"json-schema","title":"AccessibilitySuccessCriteria","data":{"type":"object","required":["wcagSuccessCriteria"],"properties":{"wcagSuccessCriteria":{"type":"string","description":"The WCAG success criteria that the issue is associated with","example":"1.4.6"},"w3Link":{"type":"string","description":"The link to the W3 page for the issue","example":"https://www.w3.org/WAI/WCAG21/Understanding/contrast-enhanced"}}}},"components/schemas/WebVitalsSummary":{"id":"components/schemas/WebVitalsSummary","kind":"json-schema","title":"WebVitalsSummary","data":{"type":"object","description":"Google's Web Vitals metrics for a given page","required":["largestContentfulPaint","cumulativeLayoutShift","firstContentfulPaint","timeToFirstByte"],"properties":{"largestContentfulPaint":{"$ref":"#/components/schemas/WebVitalDetails"},"cumulativeLayoutShift":{"$ref":"#/components/schemas/WebVitalDetails"},"firstContentfulPaint":{"$ref":"#/components/schemas/WebVitalDetails"},"timeToFirstByte":{"$ref":"#/components/schemas/WebVitalDetails"}}}},"components/schemas/WebVitalDetails":{"id":"components/schemas/WebVitalDetails","kind":"json-schema","title":"WebVitalDetails","data":{"type":"object","description":"Specific details for a given Web Vital","required":["pass","warnThreshold","failThreshold"],"properties":{"value":{"type":"number","format":"double","description":"The value of the Web Vital.  May also be null.","example":1234.56},"pass":{"type":"boolean","description":"Whether the Web Vital is beneath the warning threshold"},"warnThreshold":{"type":"number","format":"double","description":"The threshold for the vital to be in a warning state","example":1234},"failThreshold":{"type":"number","format":"double","description":"The threshold for the vital to be in a fail state","example":1234}}}},"components/schemas/AuditFailureResults":{"id":"components/schemas/AuditFailureResults","kind":"json-schema","title":"AuditFailureResults","data":{"type":"object","required":["preAuditActionResults"],"properties":{"preAuditActionResults":{"$ref":"#/components/schemas/PreAuditActionResults"},"onPagesActionResults":{"$ref":"#/components/schemas/OnPagesActionResults"},"startingUrlResults":{"$ref":"#/components/schemas/StartingUrlResults"}}}},"components/schemas/PreAuditActionResults":{"id":"components/schemas/PreAuditActionResults","kind":"json-schema","title":"PreAuditActionResults","data":{"type":"object","required":["zeroAndOut"],"properties":{"zeroAndOut":{"description":"Indicates whether pre-audit actions failed executing in all allocated engine containers.","type":"boolean"},"preAuditActionFailures":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/AuditActionResult"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-audit action results failures. A a set of failed actions with their failure messages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uniqueness is determined by the combination of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failureMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auditActionSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/OnPagesActionResults":{"id":"components/schemas/OnPagesActionResults","kind":"json-schema","title":"OnPagesActionResults","data":{"description":"(Optional) Present if failure/s is/are present for any Page's On-Page Actions execution","type":"object","required":["totalConfiguredCount","totalFailedCount","resultsSample"],"properties":{"totalConfiguredCount":{"type":"integer","description":"Total number of pages configured with On-Page Actions for the Audit run"},"totalFailedCount":{"type":"integer","description":"Total number of Pages in the Audit run with On-Page Action failures"},"resultsSample":{"description":"A sample of On-Page actions failures.","type":"array","minItems":1,"maxItems":3,"items":{"$ref":"#/components/schemas/OnPagesActionResultItem"}}}}},"components/schemas/OnPagesActionResultItem":{"id":"components/schemas/OnPagesActionResultItem","kind":"json-schema","title":"OnPagesActionResultItem","data":{"type":"object","required":["pageUrl","results"],"properties":{"pageUrl":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AuditActionResult"}}}}},"components/schemas/StartingUrlResults":{"id":"components/schemas/StartingUrlResults","kind":"json-schema","title":"StartingUrlResults","data":{"type":"object","description":"Provide information for the following use cases:\n  One and Out - All starting URLs failed to launch\n  One and Out - All links found were excluded by filters\n","required":["failureType"],"properties":{"failureType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_links_scanned_one_and_out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" All conditions must be met:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of scanned pages matches number of starting URLs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scan limit is higher than number of scanned pages"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least 1 link has been excluded."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all_starting_urls_failed_one_and_out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Flag indicating if all starting Urls failed navigation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Navigation resulted in status codes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zero"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500+"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details for this data is available from the page summary pages endpoint"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all_starting_urls_failed_zero_and_out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Flag indicating if all starting Urls failed navigation but without records."},"children":[]}]}]}]}],"type":"string","enum":["no_links_scanned_one_and_out","all_starting_urls_failed_one_and_out","all_starting_urls_failed_zero_and_out"]},"linksExcludedSample":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optional) Present if failureType is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_links_scanned_one_and_out"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sample of links found from starting URLs that were excluded from the audit."},"children":[]}]}]}],"type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/PageUrl"}},"startingUrlFailures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optional) Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all_starting_urls_failed_one_and_out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true"},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/StartingUrlFailureItem"}}}}},"components/schemas/StartingUrlFailureItem":{"id":"components/schemas/StartingUrlFailureItem","kind":"json-schema","title":"StartingUrlFailureItem","data":{"required":["statusCode","pageCount"],"properties":{"statusCode":{"$ref":"#/components/schemas/PageStatusCode"},"pageCount":{"type":"integer"},"browserError":{"type":"string","description":"error produced by browser upon opening the page","example":"This site can’t be reached. example.com’s server IP address could not be found. ERR_NAME_NOT_RESOLVED"}}}},"components/schemas/AuditActionResult":{"id":"components/schemas/AuditActionResult","kind":"json-schema","title":"AuditActionResult","data":{"type":"object","required":["auditActionSnapshotId","failureMessage"],"properties":{"auditActionSnapshotId":{"$ref":"#/components/schemas/AuditActionSnapshotId"},"failureMessage":{"type":"string"}}}},"components/schemas/PageErrorsFilter":{"id":"components/schemas/PageErrorsFilter","kind":"json-schema","title":"PageErrorsFilter","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"non-empty list of kinds of errors present on a page, depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": page has all types of errors specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": page has any type of errors present in specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list"},"children":[]}]}]}]}],"required":["filterType","errorTypes"],"properties":{"filterType":{"$ref":"#/components/schemas/PageErrorsFilterTypeEnum"},"errorTypes":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/PageErrorTypeEnum"}}}}},"components/schemas/PageErrorsFilterTypeEnum":{"id":"components/schemas/PageErrorsFilterTypeEnum","kind":"json-schema","title":"PageErrorsFilterTypeEnum","data":{"type":"string","enum":["ALL","ANY"]}},"components/schemas/PageErrorTypeEnum":{"id":"components/schemas/PageErrorTypeEnum","kind":"json-schema","title":"PageErrorTypeEnum","data":{"type":"string","enum":["ON_PAGE_ACTION_ERROR"]}},"components/schemas/AuditRun_PageInfo_LinkSummary":{"id":"components/schemas/AuditRun_PageInfo_LinkSummary","kind":"json-schema","title":"AuditRun_PageInfo_LinkSummary","data":{"type":"object","required":["linkToInitialUrlCount","linkToFinalUrlCount"],"properties":{"linkToInitialUrlCount":{"type":"integer","example":32},"linkToFinalUrlCount":{"type":"integer","example":12},"linksFromThisPageV2":{"type":"object","required":["scannedInternalSuccessfulPageCount","scannedInternalBrokenPageCount","scannedExternalSuccessfulPageCount","scannedExternalBrokenPageCount","unscannedInternaLinkCount","unscannedExternaLinkCount"],"properties":{"scannedInternalSuccessfulPageCount":{"type":"integer"},"scannedInternalBrokenPageCount":{"type":"integer"},"scannedExternalSuccessfulPageCount":{"type":"integer"},"scannedExternalBrokenPageCount":{"type":"integer"},"unscannedInternaLinkCount":{"type":"integer"},"unscannedExternaLinkCount":{"type":"integer"}}}}}},"components/schemas/AuditRun_PageInfo_RedirectChainElement":{"id":"components/schemas/AuditRun_PageInfo_RedirectChainElement","kind":"json-schema","title":"AuditRun_PageInfo_RedirectChainElement","data":{"type":"object","required":["statusCode","url","type"],"properties":{"statusCode":{"type":"integer","example":302},"url":{"type":"string","example":"https://example.com","maxLength":11264},"type":{"$ref":"#/components/schemas/BrowserRedirectType"}}}},"components/schemas/BrowserRedirectType":{"id":"components/schemas/BrowserRedirectType","kind":"json-schema","title":"BrowserRedirectType","data":{"type":"string","enum":["SERVER_SIDE","CLIENT_SIDE"]}},"components/schemas/AuditRun_PageInfo_LinkDirection":{"id":"components/schemas/AuditRun_PageInfo_LinkDirection","kind":"json-schema","title":"AuditRun_PageInfo_LinkDirection","data":{"type":"string","enum":["to_this_page","from_this_page"]}},"components/schemas/AuditRun_PageInfo_LinkDownloadOptionEnum":{"id":"components/schemas/AuditRun_PageInfo_LinkDownloadOptionEnum","kind":"json-schema","title":"AuditRun_PageInfo_LinkDownloadOptionEnum","data":{"type":"string","enum":["to_internal_pages","to_external_pages","to_urls_not_audited"]}},"components/schemas/AuditRun_PageInfo_ThisUrlTypeEnum":{"id":"components/schemas/AuditRun_PageInfo_ThisUrlTypeEnum","kind":"json-schema","title":"AuditRun_PageInfo_ThisUrlTypeEnum","data":{"type":"string","enum":["initial","final"]}},"components/schemas/AuditRun_PageInfo_LinksDTO":{"id":"components/schemas/AuditRun_PageInfo_LinksDTO","kind":"json-schema","title":"AuditRun_PageInfo_LinksDTO","data":{"type":"object","required":["links"],"properties":{"links":{"type":"array","maxItems":1000,"items":{"$ref":"#/components/schemas/AuditRun_PageInfo_LinkItem"}}}}},"components/schemas/AuditRun_PageInfo_LinkItem":{"id":"components/schemas/AuditRun_PageInfo_LinkItem","kind":"json-schema","title":"AuditRun_PageInfo_LinkItem","data":{"type":"object","required":["initial_page_url","initial_page_status_code","final_page_url","final_page_status_code","page_linked_from_url","outer_html"],"properties":{"initial_page_url":{"type":"string","description":"URL initially opened by engine"},"initial_page_status_code":{"type":"integer","description":"Initial status code observed by engine"},"final_page_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final URL after all redirects. If no redirects, equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initial_page_url"},"children":[]}]}]}]},"final_page_status_code":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status code observed by engine after all redirects. If no redirects, equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initial_page_status_code"},"children":[]}]}]}]},"page_linked_from_url":{"type":"string","description":"URL of another page that has link to this page"},"outer_html":{"type":"string","maxLength":500,"example":"<a href='https://www.iana.org/domains/example'>More information...</a>"}}}},"components/schemas/AuditRun_PageDetails_TrendsEnum":{"id":"components/schemas/AuditRun_PageDetails_TrendsEnum","kind":"json-schema","title":"AuditRun_PageDetails_TrendsEnum","data":{"type":"string","enum":["pageSize","pageLoadTime"],"example":"pageSize"}},"components/schemas/FileMappingMatchTypeEnum":{"id":"components/schemas/FileMappingMatchTypeEnum","kind":"json-schema","title":"FileMappingMatchTypeEnum","data":{"type":"integer","enum":[1,2],"description":"1 - success, 2 - failure"}},"components/schemas/FileMappingResultsDTO":{"id":"components/schemas/FileMappingResultsDTO","kind":"json-schema","title":"FileMappingResultsDTO","data":{"type":"object","properties":{"remoteFileMappingId":{"type":"integer"},"match":{"type":"string"},"matchType":{"$ref":"#/components/schemas/FileMappingMatchTypeEnum"},"fileUrl":{"type":"string"},"mappedRequests":{"type":"array","items":{"type":"string"}}}}},"components/schemas/AuditRun_Pages_DTO":{"id":"components/schemas/AuditRun_Pages_DTO","kind":"json-schema","title":"AuditRun_Pages_DTO","data":{"description":"DTO returning pages of a particular run in paged way.","type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditPage"}}}}},"components/schemas/AuditRun_PagesSort":{"id":"components/schemas/AuditRun_PagesSort","kind":"json-schema","title":"AuditRun_PagesSort","data":{"description":"possible ways to sort pages in a given run","type":"string","enum":["url","load_time","status_code","size"]}},"components/schemas/CookieDTO":{"id":"components/schemas/CookieDTO","kind":"json-schema","title":"CookieDTO","data":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"}},"description":"Cookie name and domain"}},"components/schemas/CookieTrait":{"id":"components/schemas/CookieTrait","kind":"json-schema","title":"CookieTrait","data":{"type":"object","required":["name","value","domain","path","httpOnly","secure","sameSite","expires"],"properties":{"name":{"type":"string"},"value":{"type":"string"},"domain":{"type":"string"},"path":{"type":"string"},"httpOnly":{"type":"boolean"},"secure":{"type":"boolean"},"sameSite":{"type":"string"},"expires":{"type":"string"}}}},"components/schemas/CookieChangeSnapshot":{"id":"components/schemas/CookieChangeSnapshot","kind":"json-schema","title":"CookieChangeSnapshot","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/CookieTrait"},{"type":"object","required":["partyType"],"properties":{"partyType":{"$ref":"#/components/schemas/CookiePartyType"},"cookieTTL":{"type":"integer","description":"difference (in minutes) between cookie expiration and cookie set time (page scan) cookieTTL","format":"int64"},"partitionKey":{"type":"string"}}}]}},"components/schemas/Cookie":{"id":"components/schemas/Cookie","kind":"json-schema","title":"Cookie","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/CookieTrait"},{"type":"object","required":["expirationTimestamp","opChangeType"],"properties":{"expirationTimestamp":{"type":"integer","format":"int64"},"opChangeType":{"$ref":"#/components/schemas/CookieChangeTypeEnum"}}}]}},"components/schemas/WebJourneyActionCookieItem":{"id":"components/schemas/WebJourneyActionCookieItem","kind":"json-schema","title":"WebJourneyActionCookieItem","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/FullCookieTrait"},{"type":"object","properties":{"expirationTimestamp":{"type":"integer","format":"int64"},"opChangeType":{"$ref":"#/components/schemas/CookieChangeTypeEnum"}}}]}},"components/schemas/FullCookieTrait":{"id":"components/schemas/FullCookieTrait","kind":"json-schema","title":"FullCookieTrait","data":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"domain":{"type":"string"},"path":{"type":"string"},"httpOnly":{"type":"boolean"},"secure":{"type":"boolean"},"samesite":{"type":"string"},"expires":{"type":"string"},"partyType":{"$ref":"#/components/schemas/CookiePartyType"},"origin":{"$ref":"#/components/schemas/CookieOriginDto"},"initiators":{"type":"array","items":{"$ref":"#/components/schemas/CookieInitiator"}},"partitionKey":{"type":"string"}}}},"components/schemas/BaseCookieInsights":{"id":"components/schemas/BaseCookieInsights","kind":"json-schema","title":"BaseCookieInsights","data":{"type":"object","required":["noOfUniqueCookies","noOfUniqueDomains","noOf3rdPartyCookies"],"properties":{"noOfUniqueCookies":{"type":"integer"},"noOfUniqueDomains":{"type":"integer"},"noOf3rdPartyCookies":{"type":"integer"}}}},"components/schemas/AuditCookieInsights":{"id":"components/schemas/AuditCookieInsights","kind":"json-schema","title":"AuditCookieInsights","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCookieInsights"}]}},"components/schemas/WebJourneyCookieInsights":{"id":"components/schemas/WebJourneyCookieInsights","kind":"json-schema","title":"WebJourneyCookieInsights","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCookieInsights"}]}},"components/schemas/AuditPageCookiesDTO":{"id":"components/schemas/AuditPageCookiesDTO","kind":"json-schema","title":"AuditPageCookiesDTO","data":{"type":"object","required":["insights","cookies"],"properties":{"insights":{"$ref":"#/components/schemas/AuditCookieInsights"},"cookies":{"type":"array","items":{"$ref":"#/components/schemas/AuditPageCookieItem"}}}}},"components/schemas/AuditPageCookieItem":{"id":"components/schemas/AuditPageCookieItem","kind":"json-schema","title":"AuditPageCookieItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getOrigins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueInitiatorCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiators"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array won't be included"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/FullCookieTrait"},{"type":"object","properties":{"ttlInMinutes":{"type":"integer","format":"int64"},"uniqueInitiatorCount":{"type":"integer"},"changes":{"type":"array","items":{"$ref":"#/components/schemas/AuditPageCookieChangeItem"}},"cookieChangedDuring":{"type":"array","items":{"$ref":"#/components/schemas/CookieOriginTypeEnum"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origins where this cookie was changed during the audit (PRE_AUDIT_ACTION, PAGE_LOAD, ON_PAGE_ACTION)"},"children":[]}]}]}]}}}]}},"components/schemas/WebJourneyActionCookiesDTO":{"id":"components/schemas/WebJourneyActionCookiesDTO","kind":"json-schema","title":"WebJourneyActionCookiesDTO","data":{"type":"object","required":["insights","create"],"properties":{"insights":{"$ref":"#/components/schemas/WebJourneyCookieInsights"},"create":{"type":"array","items":{"$ref":"#/components/schemas/WebJourneyActionCookieItem"}}}}},"components/schemas/CookieOriginRequestDTO":{"id":"components/schemas/CookieOriginRequestDTO","kind":"json-schema","title":"CookieOriginRequestDTO","data":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"},"path":{"type":"string"}}}},"components/schemas/BaseCookieChangeActionTrait":{"id":"components/schemas/BaseCookieChangeActionTrait","kind":"json-schema","title":"BaseCookieChangeActionTrait","data":{"type":"object","required":["sequence","label"],"properties":{"sequence":{"type":"integer"},"label":{"type":"string"}}}},"components/schemas/BaseResponseCookieChangeItemTrait":{"id":"components/schemas/BaseResponseCookieChangeItemTrait","kind":"json-schema","title":"BaseResponseCookieChangeItemTrait","data":{"type":"object","required":["cookieChangeType","cookie"],"properties":{"cookieChangeType":{"$ref":"#/components/schemas/CookieChangeTypeEnum"},"cookie":{"$ref":"#/components/schemas/CookieChangeSnapshot"}}}},"components/schemas/AuditCookieChangeAction":{"id":"components/schemas/AuditCookieChangeAction","kind":"json-schema","title":"AuditCookieChangeAction","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCookieChangeActionTrait"},{"type":"object","required":["actionSnapshotId"],"properties":{"actionSnapshotId":{"type":"integer"}}}]}},"components/schemas/AuditPageCookieChangeItem":{"id":"components/schemas/AuditPageCookieChangeItem","kind":"json-schema","title":"AuditPageCookieChangeItem","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseResponseCookieChangeItemTrait"},{"type":"object","required":["action","initiators","cookieOriginType"],"properties":{"action":{"$ref":"#/components/schemas/AuditCookieChangeAction"},"initiators":{"type":"array","items":{"$ref":"#/components/schemas/CookieChangeInitiator"}},"cookieOriginType":{"$ref":"#/components/schemas/CookieOriginTypeEnum"}}}]}},"components/schemas/WebJourneyCookieChangeAction":{"id":"components/schemas/WebJourneyCookieChangeAction","kind":"json-schema","title":"WebJourneyCookieChangeAction","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCookieChangeActionTrait"}]}},"components/schemas/WebJourneyResponseCookieChangeItem":{"id":"components/schemas/WebJourneyResponseCookieChangeItem","kind":"json-schema","title":"WebJourneyResponseCookieChangeItem","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseResponseCookieChangeItemTrait"},{"type":"object","required":["action","initiators"],"properties":{"initiators":{"type":"array","items":{"$ref":"#/components/schemas/BaseCookieInitiator"}},"action":{"$ref":"#/components/schemas/WebJourneyCookieChangeAction"}}}]}},"components/schemas/WebJourneyResponseCookieOriginDto":{"id":"components/schemas/WebJourneyResponseCookieOriginDto","kind":"json-schema","title":"WebJourneyResponseCookieOriginDto","data":{"type":"object","required":["changes"],"properties":{"changes":{"type":"array","items":{"$ref":"#/components/schemas/WebJourneyResponseCookieChangeItem"}}}}},"components/schemas/WebJourneyRunCookieOrigin":{"id":"components/schemas/WebJourneyRunCookieOrigin","kind":"json-schema","title":"WebJourneyRunCookieOrigin","data":{"type":"object","required":["totalCookieActionCount","totalCookieInitiatorCount","actions"],"properties":{"totalCookieActionCount":{"type":"integer"},"totalCookieInitiatorCount":{"type":"integer"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WebJourneyRunCookieOriginAction"}}}}},"components/schemas/WebJourneyRunCookieOriginAction":{"id":"components/schemas/WebJourneyRunCookieOriginAction","kind":"json-schema","title":"WebJourneyRunCookieOriginAction","data":{"type":"object","required":["action","cookieChangeType","initiators","cookie"],"properties":{"action":{"$ref":"#/components/schemas/WebJourneyCookieChangeAction"},"cookieChangeType":{"$ref":"#/components/schemas/CookieChangeTypeEnum"},"initiators":{"type":"array","items":{"$ref":"#/components/schemas/CookieChangeInitiator"}},"cookie":{"$ref":"#/components/schemas/CookieChangeSnapshot"}}}},"components/schemas/CookieChangeInitiator":{"id":"components/schemas/CookieChangeInitiator","kind":"json-schema","title":"CookieChangeInitiator","data":{"allOf":[{"$ref":"#/components/schemas/BaseCookieInitiator"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HTTP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" initiator have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"harEntryIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties"},"children":[]}]}]}],"properties":{"line":{"type":"integer","description":"The line number in the JS file that created the cookie"},"column":{"type":"integer","description":"The column number in the JS file that created the cookie"},"harEntryIndex":{"$ref":"#/components/schemas/HarEntryIndex"}}}]}},"components/schemas/BaseCookieInitiator":{"id":"components/schemas/BaseCookieInitiator","kind":"json-schema","title":"BaseCookieInitiator","data":{"type":"object","required":["initiatorType"],"properties":{"initiatorType":{"$ref":"#/components/schemas/CookieInitiatorTypeEnum"},"tagId":{"type":"integer","description":"Will include a tag ID when a specific tag signature has been matched to initiating requests"},"requestUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiatorType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HTTP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be the URL of the request that created the cookie"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OP_ACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This field will be undefined"},"children":[]}]}]}]}]}}}},"components/schemas/CookieInitiatorTypeEnum":{"id":"components/schemas/CookieInitiatorTypeEnum","kind":"json-schema","title":"CookieInitiatorTypeEnum","data":{"type":"string","description":"Type of event that created the cookie","enum":["HTTP","APP","OP_ACTION","UNKNOWN"]}},"components/schemas/CookieInitiatorAppSourceTrait":{"id":"components/schemas/CookieInitiatorAppSourceTrait","kind":"json-schema","title":"CookieInitiatorAppSourceTrait","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source of the JavaScript that created the cookie. This object is only applicable for cookies with initiators of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APP"},"children":[]}]}]}],"required":["file","line","column"],"properties":{"file":{"type":"string","description":"The file-name in URL format of the JS file that created the cookie"},"line":{"type":"integer","description":"The line number in the JS file that created the cookie"},"column":{"type":"integer","description":"The column number in the JS file that created the cookie"}}}},"components/schemas/CookieInitiatorAppSource":{"id":"components/schemas/CookieInitiatorAppSource","kind":"json-schema","title":"CookieInitiatorAppSource","data":{"allOf":[{"$ref":"#/components/schemas/CookieInitiatorAppSourceTrait"},{"type":"object","required":["harEntryIndex"],"properties":{"harEntryIndex":{"type":"integer","description":"HAR entry index of the JS file request"}}}]}},"components/schemas/GeoLocationDTO":{"id":"components/schemas/GeoLocationDTO","kind":"json-schema","title":"GeoLocationDTO","data":{"type":"object","properties":{"id":{"type":"integer"},"countryCode":{"type":"integer"},"countryName":{"type":"string"}}}},"components/schemas/RequestDomainDTO":{"id":"components/schemas/RequestDomainDTO","kind":"json-schema","title":"RequestDomainDTO","data":{"type":"array","items":{"$ref":"#/components/schemas/RequestDomainParsingResult"}}},"components/schemas/RequestDomainParsingResult":{"id":"components/schemas/RequestDomainParsingResult","kind":"json-schema","title":"RequestDomainParsingResult","data":{"oneOf":[{"$ref":"#/components/schemas/RequestDomainDTO-parsed1"},{"$ref":"#/components/schemas/RequestDomainDTO-parsed2"},{"$ref":"#/components/schemas/RequestDomainDTO-failedToParse"}]}},"components/schemas/RequestDomainDTO-parsed1":{"id":"components/schemas/RequestDomainDTO-parsed1","kind":"json-schema","title":"RequestDomainDTO-parsed1","data":{"type":"object","properties":{"domain":{"type":"string","example":"observepoint.com"},"scheme":{"type":"string","example":"https"},"isValid":{"type":"boolean","example":true}}}},"components/schemas/RequestDomainDTO-parsed2":{"id":"components/schemas/RequestDomainDTO-parsed2","kind":"json-schema","title":"RequestDomainDTO-parsed2","data":{"type":"object","properties":{"domain":{"type":"string","example":"obs_ervepoint.com"},"scheme":{"type":"string","example":"https"},"isValid":{"type":"boolean","example":false}}}},"components/schemas/RequestDomainDTO-failedToParse":{"id":"components/schemas/RequestDomainDTO-failedToParse","kind":"json-schema","title":"RequestDomainDTO-failedToParse","data":{"type":"object","properties":{"isValid":{"type":"boolean","example":false},"OriginalUrl":{"type":"string","example":"fadsjguianvasnkd"}}}},"components/schemas/PageInsightsResponse":{"id":"components/schemas/PageInsightsResponse","kind":"json-schema","title":"PageInsightsResponse","data":{"type":"object","properties":{"pagesFiltered":{"type":"integer"},"totalPages":{"type":"integer"},"averagePageLoadTime":{"type":"integer"},"brokenPages":{"type":"integer","deprecated":true},"pagesWithBrokenInitialStatusCode":{"type":"integer"},"pagesWithBrokenFinalStatusCode":{"type":"integer"},"pageCountByLoadTimes":{"type":"object","properties":{"below3":{"type":"integer"},"3to6":{"type":"integer"},"6to10":{"type":"integer"},"10andAbove":{"type":"integer"}}},"pageCountsByInitialStatusCodes":{"$ref":"#/components/schemas/PageInsightsResponsePageCountsByStatusCodes"},"pageCountsByFinalStatusCodes":{"$ref":"#/components/schemas/PageInsightsResponsePageCountsByStatusCodes"},"pagesWithBrokenLinks":{"type":"integer","description":"Count of all pages that have broken links pointing to other pages"},"webVitals":{"$ref":"#/components/schemas/AuditRun_PageSummary_AggregatedRunWebVitals"}}}},"components/schemas/PageInsightsResponsePageCountsByStatusCodes":{"id":"components/schemas/PageInsightsResponsePageCountsByStatusCodes","kind":"json-schema","title":"PageInsightsResponsePageCountsByStatusCodes","data":{"type":"object","properties":{"good":{"type":"integer"},"redirects":{"type":"integer"},"broken":{"type":"integer"}}}},"components/schemas/InsightsByPageResponse":{"id":"components/schemas/InsightsByPageResponse","kind":"json-schema","title":"InsightsByPageResponse","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_PageWebVitals"},{"type":"object","properties":{"pageId":{"type":"string"},"dataCollectionUuid":{"type":"string"},"pageUrl":{"type":"string"},"finalPageUrl":{"type":"string"},"pageTitle":{"type":"string"},"pageLoadTime":{"type":"integer"},"pageStatusCode":{"type":"integer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialPageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" & "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finalPageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}]},"initialPageStatusCode":{"type":"integer"},"finalPageStatusCode":{"type":"integer"},"redirectCount":{"type":"integer","description":"Number of redirects from initialUrl to finalUrl of the page or 0 if none"},"size":{"type":"integer","format":"int64"},"browserError":{"type":"string","description":"error produced by browser upon opening the page","example":"This site can’t be reached. example.com’s server IP address could not be found. ERR_NAME_NOT_RESOLVED"}}}]}},"components/schemas/PageSummarySparkLinesDTO":{"id":"components/schemas/PageSummarySparkLinesDTO","kind":"json-schema","title":"PageSummarySparkLinesDTO","data":{"type":"object","properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/PageSummarySparkLineDTO"}}}}},"components/schemas/PageSummarySparkLineDTO":{"id":"components/schemas/PageSummarySparkLineDTO","kind":"json-schema","title":"PageSummarySparkLineDTO","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","properties":{"averagePageLoadTime":{"type":"integer"},"pagesWithBrokenInitialStatusCode":{"type":"integer"},"pagesWithBrokenFinalStatusCode":{"type":"integer"},"pagesWithBrokenLinks":{"type":"integer"}}}]}},"components/schemas/AuditRun_PageSummary_TrendsEnum":{"id":"components/schemas/AuditRun_PageSummary_TrendsEnum","kind":"json-schema","title":"AuditRun_PageSummary_TrendsEnum","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"type":"string","enum":["avg_page_load_time","broken_initial_page","broken_final_page","pages_with_broken_links"]}},"components/schemas/PageSummaryPagesDTO":{"id":"components/schemas/PageSummaryPagesDTO","kind":"json-schema","title":"PageSummaryPagesDTO","data":{"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/InsightsByPageResponse"}}}}},"components/schemas/PageSummaryRequestDTO":{"id":"components/schemas/PageSummaryRequestDTO","kind":"json-schema","title":"PageSummaryRequestDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is deprecated"},"children":[]}]}]}],"properties":{"pageLoadTime":{"$ref":"#/components/schemas/PageLoadTimeFilter"},"pageUrl":{"$ref":"#/components/schemas/PageUrlFilter"},"finalPageUrl":{"$ref":"#/components/schemas/PageUrlFilter"},"pageStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"pageSize":{"$ref":"#/components/schemas/PageSizeFilter"},"primaryTagsOnly":{"type":"boolean"},"tagId":{"type":"integer"},"tagCategoryId":{"type":"integer"},"tagAccount":{"type":"string"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"pageTitle":{"$ref":"#/components/schemas/PageTitleFilter"},"initialPageStatusCode":{"$ref":"#/components/schemas/IntegerFilter"},"finalPageStatusCode":{"$ref":"#/components/schemas/IntegerFilter"},"hasBrokenLinks":{"type":"boolean"},"redirectCount":{"$ref":"#/components/schemas/PageRedirectCountFilter"},"combinedPageStatusCode":{"$ref":"#/components/schemas/CombinedPageStatusCodeEnum"},"hasParentPage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only pages that do not have a parent page will be returned - starting URLs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only pages that have a parent page will be returned - pages that were discovered during crawling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or undefined - all pages will be returned."},"children":[]}]}]}]}]},"errors":{"$ref":"#/components/schemas/PageErrorsFilter"},"largestContentfulPaint":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitals_LargestContentfulPaintFilter"},"firstContentfulPaint":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitals_FirstContentfulPaintFilter"},"timeToFirstByte":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitals_TimeToFirstByteFilter"},"cumulativeLayoutShift":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitals_CumulativeLayoutShiftFilter"}}}},"components/schemas/AuditRun_PageSummary_PagesSortColumn":{"id":"components/schemas/AuditRun_PageSummary_PagesSortColumn","kind":"json-schema","title":"AuditRun_PageSummary_PagesSortColumn","data":{"type":"string","enum":["page_url","page_status_code","size","page_load_time","final_page_url","page_title","initial_page_status_code","final_page_status_code","redirect_count","largest_contentful_paint","first_contentful_paint","time_to_first_byte","cumulative_layout_shift"]}},"components/schemas/PagesWithJsVariablesDTO":{"id":"components/schemas/PagesWithJsVariablesDTO","kind":"json-schema","title":"PagesWithJsVariablesDTO","data":{"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/S3IterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/PageWithJsVariables"}}}}},"components/schemas/PageWithJsVariables":{"id":"components/schemas/PageWithJsVariables","kind":"json-schema","title":"PageWithJsVariables","data":{"type":"object","required":["pageId","pageUrl","pageInitialStatusCode","pageFinalStatusCode","variables"],"properties":{"pageId":{"$ref":"#/components/schemas/PageId"},"pageUrl":{"$ref":"#/components/schemas/PageUrl"},"pageInitialStatusCode":{"$ref":"#/components/schemas/PageStatusCode"},"pageFinalStatusCode":{"$ref":"#/components/schemas/PageStatusCode"},"variables":{"description":"All JS variables found on specific page","type":"array","items":{"$ref":"#/components/schemas/JsVariable"}}}}},"components/schemas/JsVariable":{"id":"components/schemas/JsVariable","kind":"json-schema","title":"JsVariable","data":{"type":"object","required":["name","value"],"properties":{"name":{"description":"Name of collected JS variable","example":"dataLayer","type":"string"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raw value of collected JS variable as it appeared on a page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be any value - string, number, boolean, array, object or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"}}}},"components/schemas/S3IterableResponseMetadata":{"id":"components/schemas/S3IterableResponseMetadata","kind":"json-schema","title":"S3IterableResponseMetadata","data":{"description":"Metadata for iterable results from S3","type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/S3PaginationMetadata"}}}},"components/schemas/S3PaginationMetadata":{"id":"components/schemas/S3PaginationMetadata","kind":"json-schema","title":"S3PaginationMetadata","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents pagination metadata for results from S3, where each result page contains multiple pageIds."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's not possible to efficiently get total count of files in S3, so metadata is missing fields like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPageCount"},"children":[]}]}]}],"type":"object","required":["pageSize","currentPageSize","lastPageId"],"properties":{"pageSize":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page size - number of items per result page configured by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter or default page size"},"children":[]}]}]}],"example":50,"type":"integer"},"currentPageSize":{"description":"Number of items in current result page","example":1,"type":"integer"},"lastPageId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last pageId on current result page, pass it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startAfterPageId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query param to retrieve next page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null if no items were returned"},"children":[]}]}]}],"example":"f9d32cc7cc2046d6decb145a80289287f5226323","type":"string","nullable":true}}}},"components/schemas/AccountUsage_RequestDTO":{"id":"components/schemas/AccountUsage_RequestDTO","kind":"json-schema","title":"AccountUsage_RequestDTO","data":{"description":"Request body without filters for Account Usage report","type":"object","properties":{"dummyValue":{"type":"string","description":"Necessary value to generate DTO"}}}},"components/schemas/AuditRun_AuditSummary_RequestDTO":{"id":"components/schemas/AuditRun_AuditSummary_RequestDTO","kind":"json-schema","title":"AuditRun_AuditSummary_RequestDTO","data":{"description":"Request body with filters for Audit Summary report","type":"object","properties":{"primaryTagsOnly":{"type":"boolean","description":"(This filter option no longer works due to the response body change on May 2021) if true then return only pages/tags with primary tags else return all pages/tags"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"}}}},"components/schemas/AuditRun_RuleResultsSummaryDTO":{"id":"components/schemas/AuditRun_RuleResultsSummaryDTO","kind":"json-schema","title":"AuditRun_RuleResultsSummaryDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Total Pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rules Applied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rule Instances by Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pages by Rule Status"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/AuditRunRulePageCountTrait"},{"$ref":"#/components/schemas/AuditRunRuleCountTrait"},{"type":"object","required":["totalPageCount","filteredPageCount","totalRuleCount","filteredRuleCount","totalRuleFailureCount","filteredRuleFailureCount"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"totalRuleCount":{"type":"integer","description":"Total number of rules applied to an audit run"},"filteredRuleCount":{"type":"integer","description":"Number of rules passing all applied filters"},"totalRuleFailureCount":{"type":"integer","description":"Total number of rule failures (counted for every rule on every page)"},"filteredRuleFailureCount":{"type":"integer","description":"Number of rule failures (counted for every rule on every page) passing all applied filters"}}}]}},"components/schemas/AuditRun_AuditSummary_SummaryDTO":{"id":"components/schemas/AuditRun_AuditSummary_SummaryDTO","kind":"json-schema","title":"AuditRun_AuditSummary_SummaryDTO","data":{"description":"Audit Summary data. This endpoint will only provide unique primary tags data. the rest should be retrieved from tag-inventory : getAuditRunTagInventorySummary","type":"object","required":["totalUniquePrimaryTagCount","filteredUniquePrimaryTagCount"],"properties":{"totalUniquePrimaryTagCount":{"type":"integer","description":"Total number of tag vendors selected as account primary tags discovered during an audit run"},"filteredUniquePrimaryTagCount":{"type":"integer","description":"Number of tag vendors selected as account primary tags passing all applied filters"}}}},"components/schemas/AuditRun_RuleSummary_RuleResults_AllTrendsDTO":{"id":"components/schemas/AuditRun_RuleSummary_RuleResults_AllTrendsDTO","kind":"json-schema","title":"AuditRun_RuleSummary_RuleResults_AllTrendsDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audit rule results trends overview (a.k.a. trendlines a.k.a. sparklines) for both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rule Instances by Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pages by Rule Status"},"children":[]}]}]}],"type":"object","required":["runs"],"properties":{"runs":{"type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/AuditRun_RuleResults_AllTrendsItem"}}}}},"components/schemas/AuditRun_RuleResults_AllTrendsItem":{"id":"components/schemas/AuditRun_RuleResults_AllTrendsItem","kind":"json-schema","title":"AuditRun_RuleResults_AllTrendsItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"$ref":"#/components/schemas/AuditRunRulePageCountTrait"},{"$ref":"#/components/schemas/AuditRunRuleCountTrait"}]}},"components/schemas/AuditRun_RuleSummary_RuleResultsTrendDTO":{"id":"components/schemas/AuditRun_RuleSummary_RuleResultsTrendDTO","kind":"json-schema","title":"AuditRun_RuleSummary_RuleResultsTrendDTO","data":{"description":"Audit rule results trend values","type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRunRuleResultsTrendItem"}}}}},"components/schemas/AuditRunRuleResultsTrendItem":{"id":"components/schemas/AuditRunRuleResultsTrendItem","kind":"json-schema","title":"AuditRunRuleResultsTrendItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"$ref":"#/components/schemas/AuditRunRuleCountTrait"}]}},"components/schemas/AuditRun_RuleSummary_RuleResults_PageCountTrendDTO":{"id":"components/schemas/AuditRun_RuleSummary_RuleResults_PageCountTrendDTO","kind":"json-schema","title":"AuditRun_RuleSummary_RuleResults_PageCountTrendDTO","data":{"description":"Audit rule results page count trend values","type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRunRuleResultsPageCountTrendItem"}}}}},"components/schemas/AuditRunRuleResultsPageCountTrendItem":{"id":"components/schemas/AuditRunRuleResultsPageCountTrendItem","kind":"json-schema","title":"AuditRunRuleResultsPageCountTrendItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"$ref":"#/components/schemas/AuditRunRulePageCountTrait"}]}},"components/schemas/AuditRun_RuleSummary_RuleCountTrendDTO":{"id":"components/schemas/AuditRun_RuleSummary_RuleCountTrendDTO","kind":"json-schema","title":"AuditRun_RuleSummary_RuleCountTrendDTO","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["ruleCount","ruleFailureCount"],"properties":{"ruleCount":{"type":"integer","description":"Number of rules applied to an audit run"},"ruleFailureCount":{"type":"integer","description":"Number of rule failures (counted for every rule on every page)"}}}]}},"components/schemas/AuditRun_AuditSummary_TrendsDTO":{"id":"components/schemas/AuditRun_AuditSummary_TrendsDTO","kind":"json-schema","title":"AuditRun_AuditSummary_TrendsDTO","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_AuditSummary_TrendItem"}}}}},"components/schemas/AuditRun_AuditSummary_TrendItem":{"id":"components/schemas/AuditRun_AuditSummary_TrendItem","kind":"json-schema","title":"AuditRun_AuditSummary_TrendItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalBrokenPageCount","totalUniqueTagCount","totalBrokenTagCount"],"properties":{"totalBrokenPageCount":{"type":"integer","description":"Total number of broken pages"},"totalUniqueTagCount":{"type":"integer","description":"Total number of unique tag vendors"},"totalBrokenTagCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of broken tag requests (0, 400+ or 500+ HTTP status code)"},"children":[]}]}]}]}}}]}},"components/schemas/AuditRun_AuditSummary_TrendsEnum":{"id":"components/schemas/AuditRun_AuditSummary_TrendsEnum","kind":"json-schema","title":"AuditRun_AuditSummary_TrendsEnum","data":{"type":"string","enum":["unique_tags","broken_tags","broken_pages"]}},"components/schemas/AuditRun_RuleSummary_AllRuleResultsOverviewDTO":{"id":"components/schemas/AuditRun_RuleSummary_AllRuleResultsOverviewDTO","kind":"json-schema","title":"AuditRun_RuleSummary_AllRuleResultsOverviewDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rule Details by Page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - all rules overview"},"children":[]}]}]}],"type":"object","required":["rules"],"properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_AllRuleResultsItem"}}}}},"components/schemas/AuditRun_AllRuleResultsItem":{"id":"components/schemas/AuditRun_AllRuleResultsItem","kind":"json-schema","title":"AuditRun_AllRuleResultsItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunRulePageCountTrait"},{"type":"object","required":["ruleSnapshotId","name","tags","hasEmailNotification","emailRecipients"],"properties":{"ruleSnapshotId":{"$ref":"#/components/schemas/RuleSnapshotId"},"originalRuleId":{"$ref":"#/components/schemas/RuleId"},"ruleConfigExists":{"type":"boolean","description":"If false, the rule config doesn't exist anymore"},"name":{"type":"string","description":"Rule name"},"tags":{"type":"array","description":"List of tags checked in the rule","items":{"$ref":"#/components/schemas/TagInfoTrait"}},"hasEmailNotification":{"type":"boolean"},"emailRecipients":{"type":"array","items":{"type":"string","format":"email"}}}}]}},"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsDTO":{"id":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsDTO","kind":"json-schema","title":"AuditRun_RuleSummary_SpecificRuleResultsDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rule Details by Page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - single rule details"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/AuditRun_AllRuleResultsItem"},{"type":"object","required":["pageFilters","tags"],"properties":{"originalRuleId":{"description":"ID of an original rule snapshot has been taken from. May not be available if the rule doesn't exist anymore","type":"integer","format":"int64"},"pageFilters":{"type":"array","items":{"$ref":"#/components/schemas/PageFilterSnapshot"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/RuleTagSnapshot"}}}}]}},"components/schemas/PageFilterSnapshot":{"id":"components/schemas/PageFilterSnapshot","kind":"json-schema","title":"PageFilterSnapshot","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunRulePageCountTrait"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same as v2 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PageFilter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but with snapshot ID and page count per rule outcome"},"children":[]}]}]}],"required":["pageFilterSnapshotId","ruleSnapshotId"],"properties":{"pageFilterSnapshotId":{"$ref":"#/components/schemas/RulePageFilterSnapshotId"},"ruleSnapshotId":{"$ref":"#/components/schemas/RuleSnapshotId"},"value":{"type":"string"},"type":{"type":"integer","format":"int32","description":"1 - url, 2 - status code, 3 - final url, 4 - final status code","enum":[1,2,3,4]},"matchType":{"$ref":"#/components/schemas/MatchType"}}}]}},"components/schemas/RuleTagSnapshot":{"id":"components/schemas/RuleTagSnapshot","kind":"json-schema","title":"RuleTagSnapshot","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunRulePageCountTrait"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same as v2 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RuleTag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but with snapshot ID and page count per rule outcome"},"children":[]}]}]}],"required":["ruleTagSnapshotId","ruleSnapshotId","tagId"],"properties":{"ruleTagSnapshotId":{"$ref":"#/components/schemas/RuleTagSnapshotId"},"ruleSnapshotId":{"$ref":"#/components/schemas/RuleSnapshotId"},"tagId":{"type":"integer","format":"int32"},"tagName":{"type":"string"},"tagCategoryId":{"type":"integer","format":"int32"},"tagCategoryName":{"type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"},"account":{"type":"string"},"validationDescription":{"type":"string"},"clause":{"type":"string","enum":["If","Then","Else"]},"variables":{"type":"array","items":{"$ref":"#/components/schemas/RuleTagVariableSnapshot"}},"statusCode":{"$ref":"#/components/schemas/RuleTagStatusCode"}}}]}},"components/schemas/RuleTagStatusCode":{"id":"components/schemas/RuleTagStatusCode","kind":"json-schema","title":"RuleTagStatusCode","data":{"type":"object","required":["matchType","valueType"],"properties":{"matchType":{"$ref":"#/components/schemas/MatchType"},"valueType":{"$ref":"#/components/schemas/StatusCodeValueType"},"value":{"type":"integer","format":"int32"}}}},"components/schemas/RuleTagVariableSnapshot":{"id":"components/schemas/RuleTagVariableSnapshot","kind":"json-schema","title":"RuleTagVariableSnapshot","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunRulePageCountTrait"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same as v2 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RuleTagVariable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but with snapshot ID and page count per rule outcome"},"children":[]}]}]}],"required":["ruleTagVariableSnapshotId","ruleTagSnapshotId","variable","isRegexVariableName"],"properties":{"ruleTagVariableSnapshotId":{"$ref":"#/components/schemas/RuleTagVariableSnapshotId"},"ruleTagSnapshotId":{"$ref":"#/components/schemas/RuleTagSnapshotId"},"variable":{"type":"string"},"isRegexVariableName":{"type":"boolean","description":"Indicates whether the variable name represents a regex pattern (i.e., originally had 'regex:' prefix in storage)"},"value":{"type":"string"},"validationDescription":{"type":"string"},"matchType":{"$ref":"#/components/schemas/MatchType"},"valueTagId":{"type":"integer","format":"int32"},"selectorType":{"type":"string","enum":["String","UrlParameter","DataLayer","Tag","FinalUrlParam"]}}}]}},"components/schemas/AuditRun_AuditSummary_PrimaryTagsDTO":{"id":"components/schemas/AuditRun_AuditSummary_PrimaryTagsDTO","kind":"json-schema","title":"AuditRun_AuditSummary_PrimaryTagsDTO","data":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_AuditSummary_PrimaryTagItem"}}}}},"components/schemas/AuditRun_AuditSummary_PrimaryTagItem":{"id":"components/schemas/AuditRun_AuditSummary_PrimaryTagItem","kind":"json-schema","title":"AuditRun_AuditSummary_PrimaryTagItem","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"},{"type":"object","required":["pageCount","tagAccountCount","tagVersionCount","tagLoadTimeAverage","statusCodeDistribution"],"properties":{"pageCount":{"type":"integer","description":"Number of pages this tag has been discovered on","default":0},"tagAccountCount":{"type":"integer","description":"Number of distinct accounts of the tag","default":0},"tagVersionCount":{"type":"integer","description":"Number of distinct versions of the tag","default":0},"tagLoadTimeAverage":{"$ref":"#/components/schemas/TagLoadTime"},"statusCodeDistribution":{"$ref":"#/components/schemas/AuditRun_AuditSummary_TagStatusCodeDistribution"}}}]}},"components/schemas/AuditRun_AuditSummary_TagStatusCodeDistribution":{"id":"components/schemas/AuditRun_AuditSummary_TagStatusCodeDistribution","kind":"json-schema","title":"AuditRun_AuditSummary_TagStatusCodeDistribution","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StatusCodeEnum"},"children":[]}]}]}],"type":"object","nullable":false,"required":["good","redirect","broken"],"properties":{"good":{"type":"integer","description":"Number of tag requests with \"good\" status code","default":0},"redirect":{"type":"integer","description":"Number of tag requests with \"redirect\" status code","default":0},"broken":{"type":"integer","description":"Number of tag requests with \"broken\" status code","default":0}}}},"components/schemas/AuditRun_AuditSummary_DetectedTagsDTO":{"id":"components/schemas/AuditRun_AuditSummary_DetectedTagsDTO","kind":"json-schema","title":"AuditRun_AuditSummary_DetectedTagsDTO","data":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_AuditSummary_DetectedTagItem"}}}}},"components/schemas/AuditRun_AuditSummary_DetectedTagItem":{"id":"components/schemas/AuditRun_AuditSummary_DetectedTagItem","kind":"json-schema","title":"AuditRun_AuditSummary_DetectedTagItem","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"},{"type":"object","required":["pageCount","pageNotPresentCount","tagLoadTimeAverage","tagAccountCount","uniqueVariableCount"],"properties":{"pageCount":{"type":"integer","description":"Number of pages this tag has been discovered on"},"pageNotPresentCount":{"type":"integer","description":"Number of pages this tag has not been discovered on"},"tagLoadTimeAverage":{"$ref":"#/components/schemas/TagLoadTime"},"tagAccountCount":{"type":"integer","description":"Number of distinct accounts of the tag"},"uniqueVariableCount":{"type":"integer","description":"Number of unique variables in the tag"}}}]}},"components/schemas/AuditRun_AuditSummary_ScoresDTO":{"id":"components/schemas/AuditRun_AuditSummary_ScoresDTO","kind":"json-schema","title":"AuditRun_AuditSummary_ScoresDTO","data":{"type":"object","required":["total","tagPresence","tagPerformance","rules","pagePerformance","cookies"],"properties":{"total":{"$ref":"#/components/schemas/AuditRun_AuditSummary_Score"},"tagPresence":{"$ref":"#/components/schemas/AuditRun_AuditSummary_Score"},"tagPerformance":{"$ref":"#/components/schemas/AuditRun_AuditSummary_Score"},"rules":{"$ref":"#/components/schemas/AuditRun_AuditSummary_Score"},"pagePerformance":{"$ref":"#/components/schemas/AuditRun_AuditSummary_Score"},"cookies":{"$ref":"#/components/schemas/AuditRun_AuditSummary_Score"}}}},"components/schemas/AuditRun_AuditSummary_Score":{"id":"components/schemas/AuditRun_AuditSummary_Score","kind":"json-schema","title":"AuditRun_AuditSummary_Score","data":{"type":"object","required":["score","max"],"properties":{"score":{"type":"number","format":"float","description":"Amount of points obtained in given score category. Rounded to one digit after dot"},"max":{"type":"integer","description":"Max points for given score category, inclusive"}}}},"components/schemas/AuditRun_AuditSummary_AllScoresTrendValuesDTO":{"id":"components/schemas/AuditRun_AuditSummary_AllScoresTrendValuesDTO","kind":"json-schema","title":"AuditRun_AuditSummary_AllScoresTrendValuesDTO","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AllScoresTrendValueItem"}}}}},"components/schemas/AuditRun_AuditSummary_AllScoresTrendValueItem":{"id":"components/schemas/AuditRun_AuditSummary_AllScoresTrendValueItem","kind":"json-schema","title":"AuditRun_AuditSummary_AllScoresTrendValueItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["scores"],"properties":{"scores":{"$ref":"#/components/schemas/AuditRun_AuditSummary_ScoresDTO"}}}]}},"components/schemas/AuditRun_AuditSummary_ScoreTrendsEnum":{"id":"components/schemas/AuditRun_AuditSummary_ScoreTrendsEnum","kind":"json-schema","title":"AuditRun_AuditSummary_ScoreTrendsEnum","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"type":"string","enum":["total","tag_presence","tag_performance","rules","page_performance","cookies"]}},"components/schemas/AuditRun_AuditSummary_ScoreTrendValuesDTO":{"id":"components/schemas/AuditRun_AuditSummary_ScoreTrendValuesDTO","kind":"json-schema","title":"AuditRun_AuditSummary_ScoreTrendValuesDTO","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_AuditSummary_ScoreTrendValueItem"}}}}},"components/schemas/AuditRun_AuditSummary_ScoreTrendValueItem":{"id":"components/schemas/AuditRun_AuditSummary_ScoreTrendValueItem","kind":"json-schema","title":"AuditRun_AuditSummary_ScoreTrendValueItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["score"],"properties":{"score":{"$ref":"#/components/schemas/AuditRun_AuditSummary_Score"}}}]}},"components/schemas/AuditRun_AlertSummary_AlertsOverviewResponseDTO":{"id":"components/schemas/AuditRun_AlertSummary_AlertsOverviewResponseDTO","kind":"json-schema","title":"AuditRun_AlertSummary_AlertsOverviewResponseDTO","data":{"type":"object","required":["alerts"],"properties":{"alerts":{"type":"array","minItems":0,"items":{"title":"AuditRun_AlertSummary_AlertsOverviewItem","type":"object","required":["id","name","metricType","status","isSubscribed","alertConfigExists"],"properties":{"id":{"$ref":"#/components/schemas/AlertId"},"name":{"$ref":"#/components/schemas/AlertName"},"metricType":{"$ref":"#/components/schemas/AlertMetricTypeEnum"},"status":{"$ref":"#/components/schemas/AlertResultStatusEnum"},"isSubscribed":{"type":"boolean"},"alertConfigExists":{"$ref":"#/components/schemas/AlertConfigExistsFlag"}}}}}}},"components/schemas/AuditRun_AlertSummary_SummaryRequestDTO":{"id":"components/schemas/AuditRun_AlertSummary_SummaryRequestDTO","kind":"json-schema","title":"AuditRun_AlertSummary_SummaryRequestDTO","data":{"description":"Request body with filters for Alert Summary report","type":"object","properties":{"alertName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when populated works as \"alert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains given substring\" filter"},"children":[]}]}]}]},"metricTypes":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/AlertMetricTypeEnum"}},"status":{"$ref":"#/components/schemas/AlertResultSimplifiedStatusEnum"},"subscribedOnly":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then all alerts are returned, otherwise only alerts user is subscribed to are returned"},"children":[]}]}]}]}}}},"components/schemas/AlertResultSimplifiedStatusEnum":{"id":"components/schemas/AlertResultSimplifiedStatusEnum","kind":"json-schema","title":"AlertResultSimplifiedStatusEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simplified version of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#/components/schemas/AlertResultStatusEnum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for UI filters"},"children":[]}]}]}],"enum":["TRIGGERED","NOT_TRIGGERED"]}},"components/schemas/AuditRun_AuditSummary_AlertsResponseDTO":{"id":"components/schemas/AuditRun_AuditSummary_AlertsResponseDTO","kind":"json-schema","title":"AuditRun_AuditSummary_AlertsResponseDTO","data":{"type":"object","required":["metadata","alerts"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AlertsResponseItem"}}}}},"components/schemas/AccountUsage_AlertSummary_AlertsResponseDTO":{"id":"components/schemas/AccountUsage_AlertSummary_AlertsResponseDTO","kind":"json-schema","title":"AccountUsage_AlertSummary_AlertsResponseDTO","data":{"type":"object","required":["alerts"],"properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AccountUsage_AlertSummary_AlertsResponseItem"}}}}},"components/schemas/AuditRun_AuditSummary_AlertsSortColumn":{"id":"components/schemas/AuditRun_AuditSummary_AlertsSortColumn","kind":"json-schema","title":"AuditRun_AuditSummary_AlertsSortColumn","data":{"type":"string","enum":["ALERT_NAME","ALERT_LOGIC","ACTUAL_VALUE","SUBSCRIBERS"]}},"components/schemas/AccountUsage_AlertSummary_AlertsResponseItem":{"id":"components/schemas/AccountUsage_AlertSummary_AlertsResponseItem","kind":"json-schema","title":"AccountUsage_AlertSummary_AlertsResponseItem","data":{"type":"object","required":["id","config","result"],"properties":{"id":{"$ref":"#/components/schemas/AlertId"},"config":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AlertsResponseItemConfig"},"result":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AlertResult"}}}},"components/schemas/AuditRun_AuditSummary_AlertsResponseItem":{"id":"components/schemas/AuditRun_AuditSummary_AlertsResponseItem","kind":"json-schema","title":"AuditRun_AuditSummary_AlertsResponseItem","data":{"type":"object","required":["id","config","result","history","alertConfigExists"],"properties":{"id":{"$ref":"#/components/schemas/AlertId"},"config":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AlertsResponseItemConfig"},"result":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AlertResult"},"history":{"$ref":"#/components/schemas/AlertResultsHistoryArray"},"alertConfigExists":{"$ref":"#/components/schemas/AlertConfigExistsFlag"}}}},"components/schemas/AuditRun_AuditSummary_AlertResult":{"id":"components/schemas/AuditRun_AuditSummary_AlertResult","kind":"json-schema","title":"AuditRun_AuditSummary_AlertResult","data":{"allOf":[{"$ref":"#/components/schemas/AlertResultDetails"}]}},"components/schemas/AuditRun_AuditSummary_AlertsResponseItemConfig":{"id":"components/schemas/AuditRun_AuditSummary_AlertsResponseItemConfig","kind":"json-schema","title":"AuditRun_AuditSummary_AlertsResponseItemConfig","data":{"allOf":[{"$ref":"#/components/schemas/AlertConfigTrait"},{"type":"object","required":["subscriberCount","isUserSubscribed"],"properties":{"subscriberCount":{"type":"integer"},"isUserSubscribed":{"type":"boolean"}}}]}},"components/schemas/AlertResultsHistoryArray":{"id":"components/schemas/AlertResultsHistoryArray","kind":"json-schema","title":"AlertResultsHistoryArray","data":{"type":"array","description":"Returns up to 20 runs with alert results","minItems":0,"maxItems":20,"items":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AlertsItem_HistoryItem"}}},"components/schemas/AuditRun_AuditSummary_AlertsItem_HistoryItem":{"id":"components/schemas/AuditRun_AuditSummary_AlertsItem_HistoryItem","kind":"json-schema","title":"AuditRun_AuditSummary_AlertsItem_HistoryItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"$ref":"#/components/schemas/AlertResultDetails"}]}},"components/schemas/AlertResultDetails":{"id":"components/schemas/AlertResultDetails","kind":"json-schema","title":"AlertResultDetails","data":{"type":"object","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/AlertResultStatusEnum"},"actualValue":{"description":"Value of the computed metric or its change.","type":"number","format":"double"},"currentRunValue":{"description":"Value of computed metric for current run. Present when alert is configured on metric change, not on single run metric value","type":"number","format":"double"},"previousRunValue":{"description":"Value of computed metric for previous run. Present when alert is configured on metric change, not on single run metric value","type":"number","format":"double"}}}},"components/schemas/AuditRun_AuditSummary_SpecificAlertResponseDTO":{"id":"components/schemas/AuditRun_AuditSummary_SpecificAlertResponseDTO","kind":"json-schema","title":"AuditRun_AuditSummary_SpecificAlertResponseDTO","data":{"type":"object","required":["id","config","result","alertConfigExists"],"properties":{"id":{"$ref":"#/components/schemas/AlertId"},"config":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AlertsResponseItemConfig"},"result":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AlertResult"},"alertConfigExists":{"$ref":"#/components/schemas/AlertConfigExistsFlag"}}}},"components/schemas/AlertConfigExistsFlag":{"id":"components/schemas/AlertConfigExistsFlag","kind":"json-schema","title":"AlertConfigExistsFlag","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then alert config exists and can be edited, otherwise it is deleted"},"children":[]}]}]}]}},"components/schemas/AuditRun_AlertSummary_SummaryDTO":{"id":"components/schemas/AuditRun_AlertSummary_SummaryDTO","kind":"json-schema","title":"AuditRun_AlertSummary_SummaryDTO","data":{"description":"Alert Summary report summary","type":"object","required":["totalConfiguredAlertsCount","totalTriggeredAlertsCount"],"properties":{"totalConfiguredAlertsCount":{"type":"integer","description":"Number of alerts configured for audit run"},"totalTriggeredAlertsCount":{"type":"integer","description":"Number of alerts triggered in audit run"}}}},"components/schemas/AuditRun_AlertSummary_TrendsDTO":{"id":"components/schemas/AuditRun_AlertSummary_TrendsDTO","kind":"json-schema","title":"AuditRun_AlertSummary_TrendsDTO","data":{"description":"Alert Summary report trends","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_AlertSummary_TrendItem"}}}}},"components/schemas/AuditRun_AlertSummary_TrendItem":{"id":"components/schemas/AuditRun_AlertSummary_TrendItem","kind":"json-schema","title":"AuditRun_AlertSummary_TrendItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalConfiguredAlertsCount","totalTriggeredAlertsCount"],"properties":{"totalConfiguredAlertsCount":{"type":"integer","description":"Total number of alerts configured for audit run"},"totalTriggeredAlertsCount":{"type":"integer","description":"Total number of alerts triggered in audit run"}}}]}},"components/schemas/AuditRun_AlertSummary_TrendsEnum":{"id":"components/schemas/AuditRun_AlertSummary_TrendsEnum","kind":"json-schema","title":"AuditRun_AlertSummary_TrendsEnum","data":{"type":"string","x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"enum":["configured_alerts","triggered_alerts"]}},"components/schemas/AccountTriggeredAlertsRequestDTO":{"id":"components/schemas/AccountTriggeredAlertsRequestDTO","kind":"json-schema","title":"AccountTriggeredAlertsRequestDTO","data":{"description":"Request body with filters for Account Triggered Alerts","type":"object","properties":{"runDateRange":{"$ref":"#/components/schemas/AlertRunDateRange"},"metricTypes":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/AlertMetricTypeEnum"}},"alertName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when populated works as \"alert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains given substring\" filter"},"children":[]}]}]}]},"alertLabels":{"type":"array","description":"non-empty array of labels present on an alert","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"itemName":{"type":"string","minLength":1,"description":"optional \"item name contains substring\" filter"},"itemLabels":{"type":"array","description":"non-empty array of labels present on an item, works as \"item has all specified labels\" filter","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"itemType":{"$ref":"#/components/schemas/AlertAssignmentItemTypeEnum"},"folders":{"$ref":"#/components/schemas/FoldersFilter"},"subscribedOnly":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then all alerts are returned, otherwise only alerts user is subscribed to are returned"},"children":[]}]}]}]}}}},"components/schemas/AccountTriggeredAlertsSpecificAlertRequestDTO":{"id":"components/schemas/AccountTriggeredAlertsSpecificAlertRequestDTO","kind":"json-schema","title":"AccountTriggeredAlertsSpecificAlertRequestDTO","data":{"type":"object","properties":{"runDateRange":{"$ref":"#/components/schemas/AlertRunDateRange"},"itemName":{"type":"string","minLength":1,"description":"optional \"item name contains substring\" filter"},"itemLabels":{"type":"array","description":"non-empty array of labels present on an item, works as \"item has all specified labels\" filter","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"itemType":{"$ref":"#/components/schemas/AlertAssignmentItemTypeEnum"},"folders":{"$ref":"#/components/schemas/FoldersFilter"}}}},"components/schemas/AlertRunDateRange":{"id":"components/schemas/AlertRunDateRange","kind":"json-schema","title":"AlertRunDateRange","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dates defined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exclusive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date should be after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date."},"children":[]}]}]}],"properties":{"from":{"$ref":"#/components/schemas/DateAndTime"},"to":{"$ref":"#/components/schemas/DateAndTime"}}}},"components/schemas/AccountTriggeredAlerts_SummaryDTO":{"id":"components/schemas/AccountTriggeredAlerts_SummaryDTO","kind":"json-schema","title":"AccountTriggeredAlerts_SummaryDTO","data":{"type":"object","required":["triggeredAlertAffectedPageCount","triggeredAlertsInMostRecentRunCount","auditsWithTriggeredAlertCount","triggeredUsageAlertCount"],"properties":{"triggeredAlertAffectedPageCount":{"type":"integer"},"triggeredAlertsInMostRecentRunCount":{"type":"integer"},"auditsWithTriggeredAlertCount":{"type":"integer"},"triggeredUsageAlertCount":{"type":"integer"}}}},"components/schemas/AccountTriggeredAlerts_DataSourcesDTO":{"id":"components/schemas/AccountTriggeredAlerts_DataSourcesDTO","kind":"json-schema","title":"AccountTriggeredAlerts_DataSourcesDTO","data":{"type":"object","required":["metadata","dataSources"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"dataSources":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/AccountTriggeredAlerts_DataSource"}}}}},"components/schemas/AccountTriggeredAlerts_DataSource":{"id":"components/schemas/AccountTriggeredAlerts_DataSource","kind":"json-schema","title":"AccountTriggeredAlerts_DataSource","data":{"allOf":[{"$ref":"#/components/schemas/AlertResultDetails"},{"$ref":"#/components/schemas/PagesWithTriggeredAlerts"},{"type":"object","required":["runDate","itemName","itemType","runId","itemId"],"properties":{"runDate":{"$ref":"#/components/schemas/DateAndTime"},"itemName":{"type":"string"},"itemType":{"$ref":"#/components/schemas/AlertAssignmentItemTypeEnum"},"runId":{"$ref":"#/components/schemas/RunId"},"itemId":{"$ref":"#/components/schemas/AlertAssignmentItemId"}}}]}},"components/schemas/AccountTriggeredAlerts_AlertsDTO":{"id":"components/schemas/AccountTriggeredAlerts_AlertsDTO","kind":"json-schema","title":"AccountTriggeredAlerts_AlertsDTO","data":{"type":"object","required":["metadata","alerts"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"alerts":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/AccountTriggeredAlerts_Alert"}}}}},"components/schemas/AccountTriggeredAlerts_Alert":{"id":"components/schemas/AccountTriggeredAlerts_Alert","kind":"json-schema","title":"AccountTriggeredAlerts_Alert","data":{"allOf":[{"$ref":"#/components/schemas/AlertConfigTrait"},{"$ref":"#/components/schemas/PagesWithTriggeredAlerts"},{"type":"object","required":["id","subscriberCount","isUserSubscribed","recentTriggeredDate","dataSourceCount","alertConfigExists"],"properties":{"id":{"$ref":"#/components/schemas/AlertId"},"subscriberCount":{"type":"integer"},"isUserSubscribed":{"type":"boolean"},"recentTriggeredDate":{"$ref":"#/components/schemas/DateAndTime"},"dataSourceCount":{"type":"integer"},"alertConfigExists":{"$ref":"#/components/schemas/AlertConfigExistsFlag"}}}]}},"components/schemas/PagesWithTriggeredAlerts":{"id":"components/schemas/PagesWithTriggeredAlerts","kind":"json-schema","title":"PagesWithTriggeredAlerts","data":{"type":"object","required":["appliedAlertPageCount","triggeredAlertAffectedPageCount"],"properties":{"appliedAlertPageCount":{"type":"integer"},"triggeredAlertAffectedPageCount":{"type":"integer"}}}},"components/schemas/GetAccountTriggeredAlertsSortColumn":{"id":"components/schemas/GetAccountTriggeredAlertsSortColumn","kind":"json-schema","title":"GetAccountTriggeredAlertsSortColumn","data":{"type":"string","enum":["RECENTLY_TRIGGERED_DATE","ALERT_NAME","REPORT_METRIC","PAGES_WITH_TRIGGERED_ALERTS","SUBSCRIBERS","DATA_SOURCES"]}},"components/schemas/GetAccountTriggeredAlertSortColumn":{"id":"components/schemas/GetAccountTriggeredAlertSortColumn","kind":"json-schema","title":"GetAccountTriggeredAlertSortColumn","data":{"type":"string","enum":["RUN_DATE","DATA_SOURCE_NAME","PAGES_WITH_TRIGGERED_ALERTS"]}},"components/schemas/AuditRun_RuleSummary_BaseRequestTrait":{"id":"components/schemas/AuditRun_RuleSummary_BaseRequestTrait","kind":"json-schema","title":"AuditRun_RuleSummary_BaseRequestTrait","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common request body with filters applicable to rule summary report If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialPageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be ignored"},"children":[]}]}]}],"type":"object","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"pageStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"primaryTagsOnly":{"description":"if true then return only rules/pages with primary tags else return all rules/pages","type":"boolean"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"ruleFailuresOnly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"type":"boolean","deprecated":true},"ruleStatus":{"$ref":"#/components/schemas/RuleStatus"}}}]}},"components/schemas/AuditRun_RuleSummary_RequestDTO":{"id":"components/schemas/AuditRun_RuleSummary_RequestDTO","kind":"json-schema","title":"AuditRun_RuleSummary_RequestDTO","data":{"description":"Request to get rule summary","x-implements":["com.observepoint.reportingapi.gen.interfaces.RuleSummaryFilters"],"allOf":[{"$ref":"#/components/schemas/AuditRun_RuleSummary_BaseRequestTrait"},{"type":"object","properties":{"ruleId":{"$ref":"#/components/schemas/RuleId"}}}]}},"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsRequestDTO":{"id":"components/schemas/AuditRun_RuleSummary_SpecificRuleResultsRequestDTO","kind":"json-schema","title":"AuditRun_RuleSummary_SpecificRuleResultsRequestDTO","data":{"description":"Request to get rule results list","x-implements":["com.observepoint.reportingapi.gen.interfaces.RuleSummaryFilters"],"allOf":[{"$ref":"#/components/schemas/AuditRun_RuleSummary_BaseRequestTrait"}]}},"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO":{"id":"components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO","kind":"json-schema","title":"AuditRun_RuleSummary_AllRuleResultsRequestDTO","data":{"description":"Request to get all rules/pages results","x-implements":["com.observepoint.reportingapi.gen.interfaces.RuleSummaryFilters"],"allOf":[{"$ref":"#/components/schemas/AuditRun_RuleSummary_RequestDTO"}]}},"components/schemas/AuditRun_RuleSummary_PageRuleResultsDTO":{"id":"components/schemas/AuditRun_RuleSummary_PageRuleResultsDTO","kind":"json-schema","title":"AuditRun_RuleSummary_PageRuleResultsDTO","data":{"description":"Pages list with rule failures (when no specific rule condition/outcome selected)","type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_RuleSummary_PageRuleResultsItem"}}}}},"components/schemas/AuditRun_RuleSummary_AllRules_PagesSortColumn":{"id":"components/schemas/AuditRun_RuleSummary_AllRules_PagesSortColumn","kind":"json-schema","title":"AuditRun_RuleSummary_AllRules_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_status_code","final_page_status_code","page_load_time","rule_failures"]}},"components/schemas/AuditRun_RuleSummary_PageRuleResultsItem":{"id":"components/schemas/AuditRun_RuleSummary_PageRuleResultsItem","kind":"json-schema","title":"AuditRun_RuleSummary_PageRuleResultsItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["ruleFailureCount"],"properties":{"ruleFailureCount":{"type":"integer","description":"Number of rules failed on the page"}}}]}},"components/schemas/AuditRun_RuleSummary_SpecificRulePagesRequestDTO":{"id":"components/schemas/AuditRun_RuleSummary_SpecificRulePagesRequestDTO","kind":"json-schema","title":"AuditRun_RuleSummary_SpecificRulePagesRequestDTO","data":{"description":"Request to get pages list with rule condition details (when specific rule condition/outcome is selected)","x-implements":["com.observepoint.reportingapi.gen.interfaces.RuleSummaryFilters"],"allOf":[{"$ref":"#/components/schemas/AuditRun_RuleSummary_BaseRequestTrait"},{"type":"object","properties":{"ruleFilter":{"$ref":"#/components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleFilter"},"ruleResultType":{"$ref":"#/components/schemas/AuditRun_RuleSummary_RuleResultEnum"}}}]}},"components/schemas/AuditRun_RuleSummary_SpecificRulePagesExportRequestDTO":{"id":"components/schemas/AuditRun_RuleSummary_SpecificRulePagesExportRequestDTO","kind":"json-schema","title":"AuditRun_RuleSummary_SpecificRulePagesExportRequestDTO","data":{"description":"Request used in exports to get pages list with rule condition details (when specific rule condition/outcome is selected)","x-implements":["com.observepoint.reportingapi.gen.interfaces.RuleSummaryFilters"],"allOf":[{"$ref":"#/components/schemas/AuditRun_RuleSummary_SpecificRulePagesRequestDTO"},{"type":"object","required":["ruleSnapshotId"],"properties":{"ruleSnapshotId":{"$ref":"#/components/schemas/RuleSnapshotId"}}}]}},"components/schemas/AuditRun_RuleSummary_RuleResultEnum":{"id":"components/schemas/AuditRun_RuleSummary_RuleResultEnum","kind":"json-schema","title":"AuditRun_RuleSummary_RuleResultEnum","data":{"type":"string","enum":["passed","failed","not_applied","broken"]}},"components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleFilter":{"id":"components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleFilter","kind":"json-schema","title":"AuditRun_RuleSummary_PageRuleResultsRuleFilter","data":{"type":"object","required":["filterType"],"properties":{"filterType":{"$ref":"#/components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleFilterEnum"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally filters by a specific component within the rule's logic (e.g., a tag or variable condition)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_variable_filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it overrides the default behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleResultType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter, applying it to this specific component's outcome"},"children":[]}]}]}],"discriminator":{"propertyName":"filterType","mapping":{"page_filter":"#/components/schemas/AuditRun_RuleSummary_PageRuleResultsRulePageFilter","tag_filter":"#/components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleTagFilter","tag_variable_filter":"#/components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleTagVariableFilter"}}}},"components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleFilterEnum":{"id":"components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleFilterEnum","kind":"json-schema","title":"AuditRun_RuleSummary_PageRuleResultsRuleFilterEnum","data":{"type":"string","enum":["page_filter","tag_filter","tag_variable_filter"]}},"components/schemas/AuditRun_RuleSummary_PageRuleResultsRulePageFilter":{"id":"components/schemas/AuditRun_RuleSummary_PageRuleResultsRulePageFilter","kind":"json-schema","title":"AuditRun_RuleSummary_PageRuleResultsRulePageFilter","data":{"x-discriminator-value":"page_filter","allOf":[{"$ref":"#/components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleFilter"},{"type":"object","required":["pageFilterSnapshotId"],"properties":{"pageFilterSnapshotId":{"$ref":"#/components/schemas/RulePageFilterSnapshotId"}}}]}},"components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleTagFilter":{"id":"components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleTagFilter","kind":"json-schema","title":"AuditRun_RuleSummary_PageRuleResultsRuleTagFilter","data":{"x-discriminator-value":"tag_filter","allOf":[{"$ref":"#/components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleFilter"},{"type":"object","required":["tagSnapshotId"],"properties":{"tagSnapshotId":{"$ref":"#/components/schemas/RuleTagSnapshotId"}}}]}},"components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleTagVariableFilter":{"id":"components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleTagVariableFilter","kind":"json-schema","title":"AuditRun_RuleSummary_PageRuleResultsRuleTagVariableFilter","data":{"x-discriminator-value":"tag_variable_filter","allOf":[{"$ref":"#/components/schemas/AuditRun_RuleSummary_PageRuleResultsRuleFilter"},{"type":"object","required":["tagSnapshotId","tagVariableSnapshotId"],"properties":{"tagSnapshotId":{"$ref":"#/components/schemas/RuleTagSnapshotId"},"tagVariableSnapshotId":{"$ref":"#/components/schemas/RuleTagVariableSnapshotId"}}}]}},"components/schemas/AuditRun_RuleSummary_SpecificRulePageRuleResultsDTO":{"id":"components/schemas/AuditRun_RuleSummary_SpecificRulePageRuleResultsDTO","kind":"json-schema","title":"AuditRun_RuleSummary_SpecificRulePageRuleResultsDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pages list with rule condition details (when specific rule condition/outcome is selected)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleResultType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter applies to the specific condition outcome when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleFilter.filterType"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_variable_filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise, it applies to the overall rule result for the page"},"children":[]}]}]}],"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_RuleSummary_SpecificRulePageRuleResultsItem"}}}}},"components/schemas/AuditRun_RuleSummary_SpecificRule_PagesSortColumn":{"id":"components/schemas/AuditRun_RuleSummary_SpecificRule_PagesSortColumn","kind":"json-schema","title":"AuditRun_RuleSummary_SpecificRule_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_status_code","final_page_status_code","page_load_time"]}},"components/schemas/AuditRun_RuleSummary_SpecificRulePageRuleResultsItem":{"id":"components/schemas/AuditRun_RuleSummary_SpecificRulePageRuleResultsItem","kind":"json-schema","title":"AuditRun_RuleSummary_SpecificRulePageRuleResultsItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["conditionResult"],"properties":{"conditionResult":{"$ref":"#/components/schemas/AuditRun_RuleSummary_RuleConditionResult"}}}]}},"components/schemas/AuditRun_RuleSummary_RuleConditionResult":{"id":"components/schemas/AuditRun_RuleSummary_RuleConditionResult","kind":"json-schema","title":"AuditRun_RuleSummary_RuleConditionResult","data":{"description":"Only tag variable condition has parent - tag condition","type":"object","required":["id","idType","name","matcher","expected"],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"condition snapshot ID. One of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RulePageFilterSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RuleTagSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RuleTagVariableSnapshotId"},"children":[]}]}]}],"type":"integer","format":"int64"},"idType":{"type":"string"},"parentId":{"$ref":"#/components/schemas/RuleTagSnapshotId"},"parentType":{"type":"string"},"name":{"type":"string"},"matcher":{"type":"string"},"actual":{"type":"string"},"expected":{"$ref":"#/components/schemas/ConditionExpectedResult"}}}},"components/schemas/ConditionExpectedResult":{"id":"components/schemas/ConditionExpectedResult","kind":"json-schema","title":"ConditionExpectedResult","data":{"description":"The rule condition expected values","type":"object","required":["expected"],"properties":{"expected":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"selectorType":{"type":"string","enum":["String","UrlParameter","DataLayer","Tag","FinalUrlParam","Empty"]}}}},"components/schemas/AuditRun_TagInventory_RequestDTO":{"id":"components/schemas/AuditRun_TagInventory_RequestDTO","kind":"json-schema","title":"AuditRun_TagInventory_RequestDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body with filters for Tag Inventory report."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialPageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagesWithoutTagId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missingTag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagesWithoutTagCategoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missingTagCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagesWithoutTagVendorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missingTagVendor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"pageStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"primaryTagsOnly":{"type":"boolean","description":"if true then return only pages/tags with primary tags else return all pages/tags"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"pagesWithoutTagId":{"deprecated":true,"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated in favour of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagesWithoutTag"},"children":[]}]}]}]},"pagesWithoutTagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"pagesWithoutTagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"pagesWithoutTag":{"$ref":"#/components/schemas/AuditRun_TagInventory_PagesWithoutTag"}}}]}},"components/schemas/AuditRun_TagInventory_FilteredRequestDTO":{"id":"components/schemas/AuditRun_TagInventory_FilteredRequestDTO","kind":"json-schema","title":"AuditRun_TagInventory_FilteredRequestDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for Tag Inventory report with filters present in path removed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialPageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagesWithoutTagId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missingTag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagesWithoutTagCategoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missingTagCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagesWithoutTagVendorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missingTagVendor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"pageStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"pagesWithoutTagId":{"$ref":"#/components/schemas/TagId"},"pagesWithoutTagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"pagesWithoutTagVendorId":{"$ref":"#/components/schemas/TagVendorId"}}}]}},"components/schemas/AuditRun_TagInventory_PagesWithoutTag":{"id":"components/schemas/AuditRun_TagInventory_PagesWithoutTag","kind":"json-schema","title":"AuditRun_TagInventory_PagesWithoutTag","data":{"type":"object","required":["tagId"],"properties":{"tagId":{"$ref":"#/components/schemas/TagId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"}}}},"components/schemas/AuditRun_TagInventory_SummaryDTO":{"id":"components/schemas/AuditRun_TagInventory_SummaryDTO","kind":"json-schema","title":"AuditRun_TagInventory_SummaryDTO","data":{"description":"Tag Inventory report summary","type":"object","required":["totalPageCount","filteredPageCount","filteredBrokenPageCount","filteredUniqueTagCount","filteredBrokenTagCount","totalTagInstanceCount"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"filteredBrokenPageCount":{"type":"integer","description":"Number of broken pages passing all applied filters"},"filteredUniqueTagCount":{"type":"integer","description":"Number of unique tag vendors passing all applied filters"},"filteredBrokenTagCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of broken tag requests (0, 400+ or 500+ HTTP status code) passing all applied filters"},"children":[]}]}]}]},"totalTagInstanceCount":{"type":"integer","description":"Total number of tag requests discovered"}}}},"components/schemas/AuditRun_TagInventory_TagCategoriesSummaryDTO":{"id":"components/schemas/AuditRun_TagInventory_TagCategoriesSummaryDTO","kind":"json-schema","title":"AuditRun_TagInventory_TagCategoriesSummaryDTO","data":{"type":"object","required":["tagCategories"],"properties":{"tagCategories":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All tag categories discovered. Not affected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagCategoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AuditRun_TagInventory_TagCategoryItem"}}}}},"components/schemas/AuditRun_TagInventory_TagCategoryItem":{"id":"components/schemas/AuditRun_TagInventory_TagCategoryItem","kind":"json-schema","title":"AuditRun_TagInventory_TagCategoryItem","data":{"type":"object","required":["tagCategoryId","totalTagInstanceCount","tagFilterStatus"],"properties":{"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"totalTagInstanceCount":{"type":"integer","description":"Number of instances of tags from this category"},"tagFilterStatus":{"type":"boolean","description":"True if this tag category had tag instances that met any of the tag filter criteria"}}}},"components/schemas/AuditRun_TagInventory_TrendsDTO":{"id":"components/schemas/AuditRun_TagInventory_TrendsDTO","kind":"json-schema","title":"AuditRun_TagInventory_TrendsDTO","data":{"description":"Tag Inventory trends overview (a.k.a. trendlines a.k.a. sparklines)","type":"object","required":["runs"],"properties":{"runs":{"type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/AuditRun_TagInventory_TrendsItem"}}}}},"components/schemas/AuditRun_TagInventory_TrendsItem":{"id":"components/schemas/AuditRun_TagInventory_TrendsItem","kind":"json-schema","title":"AuditRun_TagInventory_TrendsItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalBrokenPageCount","totalUniqueTagCount","totalBrokenTagCount"],"properties":{"totalBrokenPageCount":{"type":"integer","description":"Total number of broken pages"},"totalUniqueTagCount":{"type":"integer","description":"Total number of unique tag vendors discovered"},"totalBrokenTagCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of broken tag requests (0, 400+ or 500+ HTTP status code)"},"children":[]}]}]}]}}}]}},"components/schemas/AuditRun_TagInventory_TrendsEnum":{"id":"components/schemas/AuditRun_TagInventory_TrendsEnum","kind":"json-schema","title":"AuditRun_TagInventory_TrendsEnum","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"type":"string","enum":["unique_tags","broken_tags","broken_pages"]}},"components/schemas/AuditRun_TagInventory_TagPresenceItemTrait":{"id":"components/schemas/AuditRun_TagInventory_TagPresenceItemTrait","kind":"json-schema","title":"AuditRun_TagInventory_TagPresenceItemTrait","data":{"type":"object","required":["tagPresentPageCount","tagAbsentPageCount"],"properties":{"tagPresentPageCount":{"type":"integer","description":"Total number of pages with the tag/account"},"tagAbsentPageCount":{"type":"integer","description":"Total number of pages without tag/account"}}}},"components/schemas/AuditRun_TagInventory_TagPresenceDTO":{"id":"components/schemas/AuditRun_TagInventory_TagPresenceDTO","kind":"json-schema","title":"AuditRun_TagInventory_TagPresenceDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pages With & Without Tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data"},"children":[]}]}]}],"type":"object","required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagInventory_TagPresence_TagItem"}}}}},"components/schemas/AuditRun_TagInventory_TagPresence_TagItem":{"id":"components/schemas/AuditRun_TagInventory_TagPresence_TagItem","kind":"json-schema","title":"AuditRun_TagInventory_TagPresence_TagItem","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"},{"$ref":"#/components/schemas/AuditRun_TagInventory_TagPresenceItemTrait"},{"type":"object","required":["filteredTagAccountCount"],"properties":{"filteredTagAccountCount":{"type":"integer","description":"Number of accounts of a tag passing all applied filters"}}}]}},"components/schemas/AuditRun_TagInventory_TagAccountPresenceDTO":{"id":"components/schemas/AuditRun_TagInventory_TagAccountPresenceDTO","kind":"json-schema","title":"AuditRun_TagInventory_TagAccountPresenceDTO","data":{"type":"object","required":["metadata","tagAccounts"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"tagAccounts":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagInventory_TagAccountsPresenceItem"}}}}},"components/schemas/AuditRun_TagInventory_TagAccountsPresenceItem":{"id":"components/schemas/AuditRun_TagInventory_TagAccountsPresenceItem","kind":"json-schema","title":"AuditRun_TagInventory_TagAccountsPresenceItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_TagInventory_TagPresenceItemTrait"},{"type":"object","required":["tagAccount"],"properties":{"tagAccount":{"$ref":"#/components/schemas/TagAccount"}}}]}},"components/schemas/AuditRun_TagInventory_PagesDTO":{"id":"components/schemas/AuditRun_TagInventory_PagesDTO","kind":"json-schema","title":"AuditRun_TagInventory_PagesDTO","data":{"description":"Tag Inventory pages list data","type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagInventory_PagesItem"}}}}},"components/schemas/AuditRun_TagInventory_PagesSortColumn":{"id":"components/schemas/AuditRun_TagInventory_PagesSortColumn","kind":"json-schema","title":"AuditRun_TagInventory_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_load_time","page_status_code","final_page_status_code","tag_instance_count","unique_tag_count","broken_tag_count"]}},"components/schemas/AuditRun_TagInventory_PagesItem":{"id":"components/schemas/AuditRun_TagInventory_PagesItem","kind":"json-schema","title":"AuditRun_TagInventory_PagesItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["tagInstanceCount","uniqueTagCount","brokenTagCount"],"properties":{"tagInstanceCount":{"type":"integer","description":"Number of tag requests on a page"},"uniqueTagCount":{"type":"integer","description":"Number of unique tag vendors discovered on a page"},"brokenTagCount":{"type":"integer","description":"Number of broken tag requests on a page"}}}]}},"components/schemas/AuditRun_TagHealth_RequestDTO":{"id":"components/schemas/AuditRun_TagHealth_RequestDTO","kind":"json-schema","title":"AuditRun_TagHealth_RequestDTO","data":{"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"pageStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"primaryTagsOnly":{"type":"boolean","description":"if true then return only pages/tags with primary tags else return all pages/tags"},"tagLoadTime":{"$ref":"#/components/schemas/TagLoadTimeFilter"},"tagStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"tagRequestSize":{"$ref":"#/components/schemas/AuditRun_TagHealth_TagRequestSize"}}}]}},"components/schemas/AuditRun_TagHealth_FilteredRequestDTO":{"id":"components/schemas/AuditRun_TagHealth_FilteredRequestDTO","kind":"json-schema","title":"AuditRun_TagHealth_FilteredRequestDTO","data":{"description":"Request body for Tag Health report with filters present in path removed","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"pageStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"tagLoadTime":{"$ref":"#/components/schemas/TagLoadTimeFilter"},"tagStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"tagRequestSize":{"$ref":"#/components/schemas/AuditRun_TagHealth_TagRequestSize"}}}]}},"components/schemas/AuditRun_TagHealth_SummaryDTO":{"id":"components/schemas/AuditRun_TagHealth_SummaryDTO","kind":"json-schema","title":"AuditRun_TagHealth_SummaryDTO","data":{"description":"Slow tag - request loaded slower than 2 sec","type":"object","required":["totalPageCount","filteredPageCount","filteredTagRequestSizeAverage","filteredTagLoadTimeAverage","filteredSlowTagCount","filteredSlowTagPercentage","filteredBrokenTagCount","filteredBrokenTagPercentage","filteredTagInstanceCount","tagLoadTimeDistribution","tagStatusCodeDistribution"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"filteredTagLoadTimeAverage":{"$ref":"#/components/schemas/TagLoadTime"},"filteredTagRequestSizeAverage":{"$ref":"#/components/schemas/TagRequestSize"},"filteredSlowTagCount":{"type":"integer","description":"Number of tag request loadeded slower than 2 sec passing all applied filters"},"filteredSlowTagPercentage":{"type":"number","format":"double","description":"Percentage of tag requests loaded slower than 2 sec passing all applied filters"},"filteredBrokenTagCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of broken tag requests (0, 400+ or 500+ HTTP status code) passing all applied filters"},"children":[]}]}]}]},"filteredBrokenTagPercentage":{"type":"number","format":"double","description":"Percentage of tag requests loaded slower than 2 sec passing all applied filters"},"filteredTagInstanceCount":{"type":"integer","description":"Number of tag requests passing all applied filters"},"tagLoadTimeDistribution":{"$ref":"#/components/schemas/AuditRun_TagHealth_TagLoadTimeDistribution"},"tagStatusCodeDistribution":{"$ref":"#/components/schemas/AuditRun_TagHealth_TagStatusCodeDistribution"}}}},"components/schemas/AuditRun_TagHealth_TagLoadTimeDistribution":{"id":"components/schemas/AuditRun_TagHealth_TagLoadTimeDistribution","kind":"json-schema","title":"AuditRun_TagHealth_TagLoadTimeDistribution","data":{"type":"object","required":["below500","500to1000","1000to2000","above2000"],"properties":{"below500":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of tag requests with load time < 500 ms"},"children":[]}]}]}]},"500to1000":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of tag requests with 500 ms ≤ load time < 1000 ms"},"children":[]}]}]}]},"1000to2000":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of tag requests with 1000 ms ≤ load time < 2000 ms"},"children":[]}]}]}]},"above2000":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of tag requests with 2000 ms ≤ load time"},"children":[]}]}]}]}}}},"components/schemas/AuditRun_TagHealth_TagStatusCodeDistribution":{"id":"components/schemas/AuditRun_TagHealth_TagStatusCodeDistribution","kind":"json-schema","title":"AuditRun_TagHealth_TagStatusCodeDistribution","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StatusCodeEnum"},"children":[]}]}]}],"type":"object","required":["good","redirect","broken"],"properties":{"good":{"type":"integer","description":"Number of tag requests with \"good\" status code"},"redirect":{"type":"integer","description":"Number of tag requests with \"redirect\" status code"},"broken":{"type":"integer","description":"Number of tag requests with \"broken\" status code"}}}},"components/schemas/AuditRun_TagHealth_TrendsDTO":{"id":"components/schemas/AuditRun_TagHealth_TrendsDTO","kind":"json-schema","title":"AuditRun_TagHealth_TrendsDTO","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagHealth_TrendsItem"}}}}},"components/schemas/AuditRun_TagHealth_TrendsItem":{"id":"components/schemas/AuditRun_TagHealth_TrendsItem","kind":"json-schema","title":"AuditRun_TagHealth_TrendsItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalTagLoadTimeAverage","totalTagRequestSizeAverage","totalSlowTagCount","totalBrokenTagCount","totalTagInstanceCount"],"properties":{"totalTagLoadTimeAverage":{"$ref":"#/components/schemas/TagLoadTime"},"totalTagRequestSizeAverage":{"$ref":"#/components/schemas/TagRequestSize"},"totalSlowTagCount":{"type":"integer","description":"Total number of tag request loaded slower than 2 sec"},"slowTagPercentage":{"type":"number","format":"double","description":"Percentage of tag requests loaded slower than 2 sec"},"totalBrokenTagCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of broken tag requests (0, 400+ or 500+ HTTP status code)"},"children":[]}]}]}]},"brokenTagPercentage":{"type":"number","format":"double","description":"Percentage of tag requests loaded slower than 2 sec"},"totalTagInstanceCount":{"type":"integer","description":"Number of tag requests passing all applied filters"}}}]}},"components/schemas/AuditRun_TagHealth_TrendsEnum":{"id":"components/schemas/AuditRun_TagHealth_TrendsEnum","kind":"json-schema","title":"AuditRun_TagHealth_TrendsEnum","data":{"type":"string","x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"enum":["average_tag_load_time","average_tag_request_size","slow_tags","slow_tag_percentage","broken_tags","broken_tag_percentage","tag_requests"]}},"components/schemas/AuditRun_TagHealth_TagListDTO":{"id":"components/schemas/AuditRun_TagHealth_TagListDTO","kind":"json-schema","title":"AuditRun_TagHealth_TagListDTO","data":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagHealth_TagListItem"}}}}},"components/schemas/AuditRun_TagHealth_TagListItem":{"id":"components/schemas/AuditRun_TagHealth_TagListItem","kind":"json-schema","title":"AuditRun_TagHealth_TagListItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_TagHealth_TagListItemTrait"},{"type":"object","required":["filteredTagAccountCount"],"properties":{"filteredTagAccountCount":{"type":"integer","description":"Number of accounts of a tag passing all applied filters"}}}]}},"components/schemas/AuditRun_TagHealth_TagListItemTrait":{"id":"components/schemas/AuditRun_TagHealth_TagListItemTrait","kind":"json-schema","title":"AuditRun_TagHealth_TagListItemTrait","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"},{"type":"object","required":["tagInstanceCount","tagRequestSizeAverage","tagLoadTimeDistribution","tagStatusCodeDistribution"],"properties":{"tagInstanceCount":{"type":"integer","description":"Number of tag requests"},"tagRequestSizeAverage":{"$ref":"#/components/schemas/TagRequestSize"},"tagLoadTimeDistribution":{"$ref":"#/components/schemas/AuditRun_TagHealth_TagLoadTimeDistribution"},"tagStatusCodeDistribution":{"$ref":"#/components/schemas/AuditRun_TagHealth_TagStatusCodeDistribution"}}}]}},"components/schemas/AuditRun_TagHealth_TagAccountListDTO":{"id":"components/schemas/AuditRun_TagHealth_TagAccountListDTO","kind":"json-schema","title":"AuditRun_TagHealth_TagAccountListDTO","data":{"type":"object","required":["metadata","tagAccounts"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"tagAccounts":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagHealth_TagAccountListItem"}}}}},"components/schemas/AuditRun_TagHealth_TagAccountsSortColumn":{"id":"components/schemas/AuditRun_TagHealth_TagAccountsSortColumn","kind":"json-schema","title":"AuditRun_TagHealth_TagAccountsSortColumn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_loadtime_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lower and upper bounds are correspondingly inclusive and exclusive"},"children":[]}]}]}],"type":"string","enum":["tag_account","tag_instance_count","tag_request_size_average","tag_load_time_below_500","tag_load_time_from_500_to_1000","tag_load_time_from_1000_to_2000","tag_load_time_above_2000"]}},"components/schemas/AuditRun_TagHealth_TagAccountListItem":{"id":"components/schemas/AuditRun_TagHealth_TagAccountListItem","kind":"json-schema","title":"AuditRun_TagHealth_TagAccountListItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_TagHealth_TagListItemTrait"},{"type":"object","required":["tagAccount"],"properties":{"tagAccount":{"$ref":"#/components/schemas/TagAccount"}}}]}},"components/schemas/AuditRun_TagHealth_PageListDTO":{"id":"components/schemas/AuditRun_TagHealth_PageListDTO","kind":"json-schema","title":"AuditRun_TagHealth_PageListDTO","data":{"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagHealth_PageListItem"}}}}},"components/schemas/AuditRun_TagHealth_PageSortColumn":{"id":"components/schemas/AuditRun_TagHealth_PageSortColumn","kind":"json-schema","title":"AuditRun_TagHealth_PageSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_load_time","page_status_code","final_page_status_code","tag_load_time_average","tag_request_size_average","tag_instance_count","broken_tag_count"]}},"components/schemas/AuditRun_TagHealth_PageListItem":{"id":"components/schemas/AuditRun_TagHealth_PageListItem","kind":"json-schema","title":"AuditRun_TagHealth_PageListItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["filteredTagLoadTimeAverage","filteredTagRequestSizeAverage","filteredTagInstanceCount","filteredBrokenTagCount"],"properties":{"filteredTagLoadTimeAverage":{"$ref":"#/components/schemas/TagLoadTime"},"filteredTagRequestSizeAverage":{"$ref":"#/components/schemas/TagRequestSize"},"filteredTagInstanceCount":{"type":"integer","description":"Number of tag requests on a page passing all applied filters"},"filteredBrokenTagCount":{"type":"integer","description":"Number of broken tag requests on a page passing all applied filters"}}}]}},"components/schemas/AuditRun_TagHealth_TagRequestSize":{"id":"components/schemas/AuditRun_TagHealth_TagRequestSize","kind":"json-schema","title":"AuditRun_TagHealth_TagRequestSize","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag request size in bytes. Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties defined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exclusive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/IntegerRangeFilterTrait"}]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_RequestDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body with filters for Tag Duplicates & Multiples report"},"children":[]}]}]}],"type":"object","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"primaryTagsOnly":{"type":"boolean","description":"if true then return only pages/tags with primary tags else return all pages/tags"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"}}}]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_FilteredRequestDTO":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_FilteredRequestDTO","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_FilteredRequestDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body with filters for Tag Duplicates & Multiples report with filters present in path removed"},"children":[]}]}]}],"type":"object","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"tagAccount":{"$ref":"#/components/schemas/TagAccount"}}}]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_SummaryDTO":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_SummaryDTO","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_SummaryDTO","data":{"type":"object","required":["totalPageCount","filteredPageCount","filteredUniqueTagCount","totalTagInstanceCount","filteredTagInstanceCount","filteredTagDuplicateCount","filteredTagMultipleCount"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"filteredUniqueTagCount":{"type":"integer","description":"Number of unique tag vendors passing all applied filters"},"totalTagInstanceCount":{"type":"integer","description":"Total number of tag requests discovered"},"filteredTagInstanceCount":{"type":"integer","description":"Number of tag requests passing all applied filters"},"filteredTagDuplicateCount":{"type":"integer","description":"Number of duplicate tag requests passing all applied filters"},"filteredTagMultipleCount":{"type":"integer","description":"Number of tag request instances that are not exact copies of each other and have the same account"}}}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsDTO":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsDTO","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_TrendsDTO","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendItem"}}}}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendItem":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendItem","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_TrendItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalUniqueTagCount","totalTagInstanceCount","totalTagDuplicateCount","totalTagMultipleCount"],"properties":{"totalUniqueTagCount":{"type":"integer"},"totalTagInstanceCount":{"type":"integer"},"totalTagDuplicateCount":{"type":"integer"},"totalTagMultipleCount":{"type":"integer"}}}]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsEnum":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsEnum","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_TrendsEnum","data":{"type":"string","x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"enum":["unique_tags","tag_requests","tag_duplicates","tag_multiples"]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsDTO":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsDTO","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_TagsDTO","data":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsItem"}}}}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsItem":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsItem","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_TagsItem","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"},{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsItemTrait"}]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsItemTrait":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsItemTrait","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_TagsItemTrait","data":{"type":"object","required":["filteredTagDuplicateCount","filteredTagDuplicatePageCount","filteredTagMultipleCount","filteredTagMultiplePageCount","filteredTagInstanceCount"],"properties":{"filteredTagDuplicateCount":{"type":"integer"},"filteredTagDuplicatePageCount":{"type":"integer","description":"Number of pages containing duplicate tag requests passing all applied filters"},"filteredTagMultipleCount":{"type":"integer"},"filteredTagMultiplePageCount":{"type":"integer","description":"Number of pages containing \"multiple\" tag requests passing all applied filters"},"filteredTagInstanceCount":{"type":"integer","description":"Number of tag requests passing all applied filters"}}}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsSortColumn":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsSortColumn","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_TagAccountsSortColumn","data":{"type":"string","enum":["tag_account","tag_duplicates","duplicate_tag_pages","tag_multiples","multiple_tag_pages","tag_instance_count"]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsDTO":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsDTO","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_TagAccountsDTO","data":{"type":"object","required":["metadata","tagAccounts"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"tagAccounts":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsItem"}}}}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsItem":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsItem","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_TagAccountsItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_TagsItemTrait"},{"type":"object","required":["tagAccount"],"properties":{"tagAccount":{"$ref":"#/components/schemas/TagAccount"}}}]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesRequestDTO":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesRequestDTO","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_PagesRequestDTO","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO"},{"type":"object","properties":{"finalPageUrl":{"$ref":"#/components/schemas/PageUrlFilter"},"initialPageStatusCode":{"$ref":"#/components/schemas/IntegerFilter"},"finalPageStatusCode":{"$ref":"#/components/schemas/IntegerFilter"},"type":{"type":"string","enum":["tag_duplicates","tag_multiples"]}}}]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesDTO":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesDTO","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_PagesDTO","data":{"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesItem"}}}}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesSortColumn":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesSortColumn","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_load_time","page_status_code","final_page_status_code","tag_duplicates","tag_multiples"]}},"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesItem":{"id":"components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesItem","kind":"json-schema","title":"AuditRun_TagDuplicatesAndMultiples_PagesItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["filteredTagDuplicateCount","filteredTagMultipleCount"],"properties":{"filteredTagDuplicateCount":{"type":"integer"},"filteredTagMultipleCount":{"type":"integer"}}}]}},"components/schemas/AuditRun_VariableInventory_RequestDTO":{"id":"components/schemas/AuditRun_VariableInventory_RequestDTO","kind":"json-schema","title":"AuditRun_VariableInventory_RequestDTO","data":{"description":"Request body with filters for Variable Inventory report","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"primaryTagsOnly":{"type":"boolean","description":"if true then return only pages/tags with primary tags else return all pages/tags"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"}}}]}},"components/schemas/AuditRun_VariableInventory_FilteredRequestDTO":{"id":"components/schemas/AuditRun_VariableInventory_FilteredRequestDTO","kind":"json-schema","title":"AuditRun_VariableInventory_FilteredRequestDTO","data":{"description":"Request body for Variable Inventory report with filters present in path removed","type":"object","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"}]}},"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO":{"id":"components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO","kind":"json-schema","title":"AuditRun_VariableInventory_TagAccountRequestDTO","data":{"description":"Request body for Variable Inventory report","required":["tagId","tagAccount"],"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"tagId":{"$ref":"#/components/schemas/TagId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"}}}]}},"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO":{"id":"components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","kind":"json-schema","title":"AuditRun_VariableInventory_TagAccountVariableRequestDTO","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO"},{"type":"object","required":["variableName"],"properties":{"variableName":{"$ref":"#/components/schemas/VariableName"}}}]}},"components/schemas/AuditRun_VariableInventory_TagAccountVariableValueRequestDTO":{"id":"components/schemas/AuditRun_VariableInventory_TagAccountVariableValueRequestDTO","kind":"json-schema","title":"AuditRun_VariableInventory_TagAccountVariableValueRequestDTO","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO"},{"type":"object","required":["variableValue"],"properties":{"variableValue":{"$ref":"#/components/schemas/VariableValue"}}}]}},"components/schemas/AuditRun_VariableInventory_SummaryDTO":{"id":"components/schemas/AuditRun_VariableInventory_SummaryDTO","kind":"json-schema","title":"AuditRun_VariableInventory_SummaryDTO","data":{"description":"Variable Inventory report summary","type":"object","required":["totalPageCount","filteredPageCount","filteredUniqueTagCount","totalTagInstanceCount","filteredTagInstanceCount","totalUniqueVariableNameCount","filteredUniqueVariableNameCount","totalUniqueVariableValueCount","filteredUniqueVariableValueCount"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"filteredUniqueTagCount":{"type":"integer","description":"Number of unique tag vendors passing all applied filters"},"totalTagInstanceCount":{"type":"integer","description":"Total number of tag requests discovered"},"filteredTagInstanceCount":{"type":"integer","description":"Number of tag requests passing all applied filters"},"totalUniqueVariableNameCount":{"type":"integer","description":"Total number of unique variable names across all tags"},"filteredUniqueVariableNameCount":{"type":"integer","description":"Number of unique variable names across all tags passing all applied filters"},"totalUniqueVariableValueCount":{"type":"integer","description":"Total number of unique variable names across all tags"},"filteredUniqueVariableValueCount":{"type":"integer","description":"Number of unique variable names across all tags passing all applied filters"}}}},"components/schemas/AuditRun_VariableInventory_TrendsDTO":{"id":"components/schemas/AuditRun_VariableInventory_TrendsDTO","kind":"json-schema","title":"AuditRun_VariableInventory_TrendsDTO","data":{"description":"Variable Inventory trends overview (a.k.a. trendlines a.k.a. sparklines)","type":"object","required":["runs"],"properties":{"runs":{"type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/AuditRun_VariableInventory_TrendsItem"}}}}},"components/schemas/AuditRun_VariableInventory_TrendsItem":{"id":"components/schemas/AuditRun_VariableInventory_TrendsItem","kind":"json-schema","title":"AuditRun_VariableInventory_TrendsItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalUniqueTagCount","totalTagInstanceCount","totalUniqueVariableNameCount","totalUniqueVariableValueCount"],"properties":{"totalUniqueTagCount":{"type":"integer","description":"Total number of unique tag vendors discovered"},"totalTagInstanceCount":{"type":"integer","description":"Total number of tag requests discovered"},"totalUniqueVariableNameCount":{"type":"integer","description":"Total number of unique variable names across all tags"},"totalUniqueVariableValueCount":{"type":"integer","description":"Total number of unique variable names across all tags"}}}]}},"components/schemas/AuditRun_VariableInventory_TrendsEnum":{"id":"components/schemas/AuditRun_VariableInventory_TrendsEnum","kind":"json-schema","title":"AuditRun_VariableInventory_TrendsEnum","data":{"type":"string","x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"enum":["unique_tags","tag_requests","unique_variables","unique_values"]}},"components/schemas/AuditRun_VariableInventory_TagsDTO":{"id":"components/schemas/AuditRun_VariableInventory_TagsDTO","kind":"json-schema","title":"AuditRun_VariableInventory_TagsDTO","data":{"description":"Variable Inventory report tag accounts list","type":"object","required":["metadata","tags"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_VariableInventory_TagItem"}}}}},"components/schemas/AuditRun_VariableInventory_TagItem":{"id":"components/schemas/AuditRun_VariableInventory_TagItem","kind":"json-schema","title":"AuditRun_VariableInventory_TagItem","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"},{"type":"object","properties":{"tagAccounts":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_VariableInventory_TagAccountItem"}}}}]}},"components/schemas/AuditRun_VariableInventory_TagAccountItem":{"id":"components/schemas/AuditRun_VariableInventory_TagAccountItem","kind":"json-schema","title":"AuditRun_VariableInventory_TagAccountItem","data":{"type":"object","properties":{"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"totalPageCount":{"type":"integer","description":"Total number of pages"},"totalVariableCount":{"type":"integer","description":"Total number of variables in tag account"}}}},"components/schemas/AuditRun_VariableInventory_TagAccountVariablesDTO":{"id":"components/schemas/AuditRun_VariableInventory_TagAccountVariablesDTO","kind":"json-schema","title":"AuditRun_VariableInventory_TagAccountVariablesDTO","data":{"description":"Variable Inventory report tag account variables list. This list will include the top 500 variables with the highest variableSetPageCount.","type":"object","required":["variables"],"properties":{"variables":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_VariableInventory_VariableItem"}}}}},"components/schemas/AuditRun_VariableInventory_TagVariablesSortColumn":{"id":"components/schemas/AuditRun_VariableInventory_TagVariablesSortColumn","kind":"json-schema","title":"AuditRun_VariableInventory_TagVariablesSortColumn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"variable_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" still sorts variables by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"friendlyName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first"},"children":[]}]}]}],"type":"string","enum":["variable_name","unique_values","variable_set_pages","variable_not_set_pages"]}},"components/schemas/AuditRun_VariableInventory_VariableItem":{"id":"components/schemas/AuditRun_VariableInventory_VariableItem","kind":"json-schema","title":"AuditRun_VariableInventory_VariableItem","data":{"type":"object","required":["variableName","uniqueValueCount","variableNotSetPageCount","variableSetPageCount"],"properties":{"variableName":{"$ref":"#/components/schemas/VariableName"},"friendlyName":{"type":"string","description":"Human-readable variable name"},"uniqueValueCount":{"type":"integer","description":"Number of unique values of the variable"},"variableNotSetPageCount":{"type":"integer","description":"Number of pages where variable is not set"},"variableSetPageCount":{"type":"integer","description":"Number of pages where variable is set"}}}},"components/schemas/AuditRun_VariableInventory_PagesDTO":{"id":"components/schemas/AuditRun_VariableInventory_PagesDTO","kind":"json-schema","title":"AuditRun_VariableInventory_PagesDTO","data":{"description":"Tag Inventory pages list data","type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_VariableInventory_PagesItem"}}}}},"components/schemas/AuditRun_VariableInventory_PagesSortColumn":{"id":"components/schemas/AuditRun_VariableInventory_PagesSortColumn","kind":"json-schema","title":"AuditRun_VariableInventory_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_load_time","page_status_code","final_page_status_code","variable_count"]}},"components/schemas/AuditRun_VariableInventory_PagesItem":{"id":"components/schemas/AuditRun_VariableInventory_PagesItem","kind":"json-schema","title":"AuditRun_VariableInventory_PagesItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["variableCount"],"properties":{"variableCount":{"type":"integer","description":"Number of unique tag (account) variables on a page"}}}]}},"components/schemas/AuditRun_VariableInventory_VariableNotSetPagesDTO":{"id":"components/schemas/AuditRun_VariableInventory_VariableNotSetPagesDTO","kind":"json-schema","title":"AuditRun_VariableInventory_VariableNotSetPagesDTO","data":{"description":"Tag Inventory pages list data","type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_VariableInventory_VariableNotSetPagesItem"}}}}},"components/schemas/AuditRun_VariableInventory_VariableNotSetPagesItem":{"id":"components/schemas/AuditRun_VariableInventory_VariableNotSetPagesItem","kind":"json-schema","title":"AuditRun_VariableInventory_VariableNotSetPagesItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"}]}},"components/schemas/AuditRun_VariableInventory_VariableValuesSortColumn":{"id":"components/schemas/AuditRun_VariableInventory_VariableValuesSortColumn","kind":"json-schema","title":"AuditRun_VariableInventory_VariableValuesSortColumn","data":{"type":"string","enum":["variable_value","page_count"]}},"components/schemas/AuditRun_VariableInventory_UniqueVariableValuesDTO":{"id":"components/schemas/AuditRun_VariableInventory_UniqueVariableValuesDTO","kind":"json-schema","title":"AuditRun_VariableInventory_UniqueVariableValuesDTO","data":{"description":"Variable Inventory - unique variable values list data","type":"object","required":["metadata","variableValues"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"variableValues":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_VariableInventory_UniqueVariableValuesItem"}}}}},"components/schemas/AuditRun_VariableInventory_UniqueVariableValuesItem":{"id":"components/schemas/AuditRun_VariableInventory_UniqueVariableValuesItem","kind":"json-schema","title":"AuditRun_VariableInventory_UniqueVariableValuesItem","data":{"type":"object","properties":{"variableValue":{"$ref":"#/components/schemas/VariableValue"},"pageCount":{"type":"integer","description":"Number of pages containing specific variable value and passing all filters"},"tagWithVariableValueCount":{"type":"integer","description":"Number of tag requests containing this specific variable value and passing all filters"}}}},"components/schemas/AuditRun_VariableInventory_VariableValuePagesDTO":{"id":"components/schemas/AuditRun_VariableInventory_VariableValuePagesDTO","kind":"json-schema","title":"AuditRun_VariableInventory_VariableValuePagesDTO","data":{"description":"Variable Inventory - variable values pages list data","type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_VariableInventory_VariableValuePageItem"}}}}},"components/schemas/AuditRun_VariableInventory_VariableValuePageItem":{"id":"components/schemas/AuditRun_VariableInventory_VariableValuePageItem","kind":"json-schema","title":"AuditRun_VariableInventory_VariableValuePageItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["tagWithVariableValueCount"],"properties":{"tagWithVariableValueCount":{"type":"integer","default":"Number of tag requests with the variable value"}}}]}},"components/schemas/AuditRun_VariableInventory_VariableValuePageExportItem":{"id":"components/schemas/AuditRun_VariableInventory_VariableValuePageExportItem","kind":"json-schema","title":"AuditRun_VariableInventory_VariableValuePageExportItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_VariableInventory_VariableValuePageItem"},{"type":"object","required":["variableValue"],"properties":{"variableValue":{"type":"string"}}}]}},"components/schemas/AuditRun_CookieInventory_RequestDTO":{"id":"components/schemas/AuditRun_CookieInventory_RequestDTO","kind":"json-schema","title":"AuditRun_CookieInventory_RequestDTO","data":{"description":"Request body with filters for Cookie Inventory report","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"$ref":"#/components/schemas/CookieFiltersTrait"},{"type":"object","properties":{"cookieName":{"$ref":"#/components/schemas/StringInclusionFilter"},"cookieDomain":{"$ref":"#/components/schemas/StringInclusionFilter"},"partyType":{"$ref":"#/components/schemas/CookiePartyType"},"secure":{"type":"boolean"},"sameSite":{"$ref":"#/components/schemas/CookieSameSiteExtended"},"cookieSize":{"$ref":"#/components/schemas/AuditRun_CookieInventory_CookieSizeRangeFilter"},"allThirdPartyCookies":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflicts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partyType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but has higher priority"},"children":[]}]}]}]},"httpOnly":{"type":"boolean"},"expirationType":{"$ref":"#/components/schemas/CookieExpirationType"},"cookieDuration":{"$ref":"#/components/schemas/AuditRun_CookieInventory_CookieDurationRangeFilter"},"initiatorUrl":{"$ref":"#/components/schemas/StringInclusionFilter"},"initiatorUrlDomain":{"$ref":"#/components/schemas/StringInclusionFilter"},"anyRelatedTag":{"type":"boolean","description":"Show all cookies with any related tag"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"partitionKeyIsSet":{"type":"boolean"}}}]}},"components/schemas/AuditRun_CookieInventory_CookieSizeRangeFilter":{"id":"components/schemas/AuditRun_CookieInventory_CookieSizeRangeFilter","kind":"json-schema","title":"AuditRun_CookieInventory_CookieSizeRangeFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cookie size in bytes. Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties defined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exclusive"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/IntegerRangeFilterTrait"}]}},"components/schemas/AuditRun_CookieInventory_CookieDurationRangeFilter":{"id":"components/schemas/AuditRun_CookieInventory_CookieDurationRangeFilter","kind":"json-schema","title":"AuditRun_CookieInventory_CookieDurationRangeFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cookie duration in minutes. Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties defined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exclusive. Ignored when expirationType == \"session\""},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/IntegerRangeFilterTrait"}]}},"components/schemas/AuditRun_CookieInventory_SummaryDTO":{"id":"components/schemas/AuditRun_CookieInventory_SummaryDTO","kind":"json-schema","title":"AuditRun_CookieInventory_SummaryDTO","data":{"description":"Cookie Inventory report summary","type":"object","required":["totalPageCount","filteredPageCount","totalUniqueCookieCount","filteredUniqueCookieCount","totalFirstPartyCookieCount","filteredFirstPartyCookieCount","totalThirdPartyCookieCount","filteredThirdPartyCookieCount","filteredNonSecureCookieCount","filteredSameSiteEmptyCookieCount","totalUniqueCookieDomainCount","filteredUniqueCookieDomainCount"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"totalUniqueCookieCount":{"type":"integer","description":"Total number of unique cookies discovered"},"filteredUniqueCookieCount":{"type":"integer","description":"Number of unique cookies passing all applied filters"},"totalFirstPartyCookieCount":{"type":"integer","description":"Total number of first-party cookies discovered"},"filteredFirstPartyCookieCount":{"type":"integer","description":"Number of first-party cookies passing all applied filters"},"totalThirdPartyCookieCount":{"type":"integer","description":"Total number of third-party cookies discovered"},"filteredThirdPartyCookieCount":{"type":"integer","description":"Number of third-party cookies passing all applied filters"},"filteredNonSecureCookieCount":{"type":"integer","description":"Number of non-secure cookies passing all applied filters"},"filteredSameSiteEmptyCookieCount":{"type":"integer","description":"Number of cookies with empty same site attribute passing all applied filters"},"totalUniqueCookieDomainCount":{"type":"integer","description":"Total number of unique cookie domains discovered"},"filteredUniqueCookieDomainCount":{"type":"integer","description":"Number of unique cookie domains passing all applied filters"}}}},"components/schemas/AuditRun_CookieInventory_TrendsDTO":{"id":"components/schemas/AuditRun_CookieInventory_TrendsDTO","kind":"json-schema","title":"AuditRun_CookieInventory_TrendsDTO","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/AuditRun_CookieInventory_TrendsItem"}}}}},"components/schemas/AuditRun_CookieInventory_TrendsItem":{"id":"components/schemas/AuditRun_CookieInventory_TrendsItem","kind":"json-schema","title":"AuditRun_CookieInventory_TrendsItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalUniqueCookieCount","totalFirstPartyCookieCount","totalThirdPartyCookieCount","totalNonSecureCookieCount","totalSameSiteEmptyCookieCount"],"properties":{"totalUniqueCookieCount":{"type":"integer"},"totalFirstPartyCookieCount":{"type":"integer"},"totalThirdPartyCookieCount":{"type":"integer"},"totalNonSecureCookieCount":{"type":"integer"},"totalSameSiteEmptyCookieCount":{"type":"integer"}}}]}},"components/schemas/AuditRun_CookieInventory_TrendsEnum":{"id":"components/schemas/AuditRun_CookieInventory_TrendsEnum","kind":"json-schema","title":"AuditRun_CookieInventory_TrendsEnum","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"type":"string","enum":["unique_cookies","first_party","third_party","non_secure_count","same_site_empty"]}},"components/schemas/AuditRun_CookieInventory_PagesListDTO":{"id":"components/schemas/AuditRun_CookieInventory_PagesListDTO","kind":"json-schema","title":"AuditRun_CookieInventory_PagesListDTO","data":{"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_CookieInventory_PagesListItem"}}}}},"components/schemas/AuditRun_CookieInventory_PageSortColumn":{"id":"components/schemas/AuditRun_CookieInventory_PageSortColumn","kind":"json-schema","title":"AuditRun_CookieInventory_PageSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_status_code","final_page_status_code","page_load_time","cookie_count","total_cookie_size"]}},"components/schemas/AuditRun_CookieInventory_PagesListItem":{"id":"components/schemas/AuditRun_CookieInventory_PagesListItem","kind":"json-schema","title":"AuditRun_CookieInventory_PagesListItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["cookieCount","totalCookieSize"],"properties":{"cookieCount":{"type":"integer","description":"Number of cookies on a page"},"totalCookieSize":{"$ref":"#/components/schemas/CookieSize"}}}]}},"components/schemas/AuditRun_CookieInventory_CookiesListDTO":{"id":"components/schemas/AuditRun_CookieInventory_CookiesListDTO","kind":"json-schema","title":"AuditRun_CookieInventory_CookiesListDTO","data":{"type":"object","required":["metadata","cookies"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"cookies":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_CookieInventory_CookiesListItem"}}}}},"components/schemas/AuditRun_CookieInventory_CookiesSortColumn":{"id":"components/schemas/AuditRun_CookieInventory_CookiesSortColumn","kind":"json-schema","title":"AuditRun_CookieInventory_CookiesSortColumn","data":{"type":"string","enum":["page_count","name","domain","party_type","expiration_type","secure","same_site","http_only","avg_size","min_duration_in_minutes","max_duration_in_minutes","initiator_tag_count","unique_initiator_count","partition_key","cookie_changed_during"]}},"components/schemas/AuditRun_CookieInventory_CookiesListItem":{"id":"components/schemas/AuditRun_CookieInventory_CookiesListItem","kind":"json-schema","title":"AuditRun_CookieInventory_CookiesListItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_CookieInventory_CookiesListItemTrait"},{"$ref":"#/components/schemas/AggregatedCookieTrait"},{"type":"object","required":["averageSize","filteredPageCount"],"properties":{"averageSize":{"$ref":"#/components/schemas/CookieSize"},"filteredPageCount":{"type":"integer","description":"Number of pages this cookie was found on"},"minDurationInMinutes":{"type":"integer","description":"Minimum cookie duration in minutes"},"maxDurationInMinutes":{"type":"integer","description":"Maximum cookie duration in minutes"},"initiators":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_CookieInventory_CookieInitiatorItem"}},"initiatorTagIds":{"type":"array","description":"List of tag IDs, associated with initiators that set this cookie","minItems":0,"items":{"type":"integer"}},"initiatorTotalCount":{"type":"integer","description":"Total number of unique initiators that set this cookie"},"partitionKey":{"type":"string"}}}]}},"components/schemas/AuditRun_CookieInventory_CookieInitiatorItem":{"id":"components/schemas/AuditRun_CookieInventory_CookieInitiatorItem","kind":"json-schema","title":"AuditRun_CookieInventory_CookieInitiatorItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents unique initiator for the cookie, deduplicated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiatorType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlDomain"},"children":[]}]}]}],"required":["initiatorType","foundDuring","instanceCount"],"properties":{"initiatorType":{"$ref":"#/components/schemas/CookieInitiatorTypeEnum"},"tagId":{"$ref":"#/components/schemas/TagId"},"urlDomain":{"type":"string","description":"Domain part of initiator's URL"},"foundDuring":{"type":"array","description":"List of phases during which this initiator was observed","minItems":1,"items":{"$ref":"#/components/schemas/CookieOriginTypeEnum"}},"instanceCount":{"type":"integer","description":"Number of instances of this initiator across all pages"}}}},"components/schemas/AuditRun_CookieInventory_CookiesListItemTrait":{"id":"components/schemas/AuditRun_CookieInventory_CookiesListItemTrait","kind":"json-schema","title":"AuditRun_CookieInventory_CookiesListItemTrait","data":{"type":"object","required":["name","domain","partyType","expirationType","secure","httpOnly"],"properties":{"name":{"$ref":"#/components/schemas/CookieName"},"domain":{"$ref":"#/components/schemas/CookieDomain"},"partyType":{"$ref":"#/components/schemas/CookiePartyType"},"expirationType":{"$ref":"#/components/schemas/CookieExpirationType"},"sameSite":{"$ref":"#/components/schemas/CookieSameSite"},"secure":{"type":"boolean"},"httpOnly":{"type":"boolean"}}}},"components/schemas/CookieOriginDto":{"id":"components/schemas/CookieOriginDto","kind":"json-schema","title":"CookieOriginDto","data":{"type":"object","properties":{"originType":{"$ref":"#/components/schemas/CookieOriginTypeEnum"},"action":{"$ref":"#/components/schemas/CookieChangeTypeEnum"}}}},"components/schemas/AuditRun_CookieInventory_CookiePagesRequestDTO":{"id":"components/schemas/AuditRun_CookieInventory_CookiePagesRequestDTO","kind":"json-schema","title":"AuditRun_CookieInventory_CookiePagesRequestDTO","data":{"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"$ref":"#/components/schemas/CookieFiltersTrait"},{"type":"object","required":["cookie"],"properties":{"cookie":{"$ref":"#/components/schemas/AuditRun_CookieInventory_SelectedCookie"},"cookieSize":{"$ref":"#/components/schemas/AuditRun_CookieInventory_CookieSizeRangeFilter"},"initiatorUrl":{"$ref":"#/components/schemas/StringInclusionFilter"},"initiatorUrlDomain":{"$ref":"#/components/schemas/StringInclusionFilter"},"anyRelatedTag":{"type":"boolean","description":"Show all cookies with any related tag"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"}}}]}},"components/schemas/AuditRun_CookieInventory_SelectedCookie":{"id":"components/schemas/AuditRun_CookieInventory_SelectedCookie","kind":"json-schema","title":"AuditRun_CookieInventory_SelectedCookie","data":{"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partitionKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is absent — property is ignored for backward compatibility,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partitionKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partitionKey.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is absent — cookies in old runs without partition key and new runs with partition key set to null,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partitionKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partitionKey.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present — cookies in new runs with requested partition key"},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/AuditRun_CookieInventory_CookiesListItemTrait"},{"type":"object","properties":{"partitionKey":{"$ref":"#/components/schemas/CookiePartitionKey"}}}]}},"components/schemas/AuditRun_CookieInventory_DomainsListDTO":{"id":"components/schemas/AuditRun_CookieInventory_DomainsListDTO","kind":"json-schema","title":"AuditRun_CookieInventory_DomainsListDTO","data":{"type":"object","required":["metadata","domains"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"domains":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_CookieInventory_DomainsItem"}}}}},"components/schemas/AuditRun_CookieInventory_DomainsItem":{"id":"components/schemas/AuditRun_CookieInventory_DomainsItem","kind":"json-schema","title":"AuditRun_CookieInventory_DomainsItem","data":{"type":"object","required":["domain","partyType","pageCount"],"properties":{"domain":{"$ref":"#/components/schemas/CookieDomain"},"partyType":{"$ref":"#/components/schemas/CookiePartyType"},"pageCount":{"type":"integer"}}}},"components/schemas/AuditRun_CookieInventory_DomainSortColumn":{"id":"components/schemas/AuditRun_CookieInventory_DomainSortColumn","kind":"json-schema","title":"AuditRun_CookieInventory_DomainSortColumn","data":{"type":"string","enum":["domain","page_count","party_type"],"default":"domain"}},"components/schemas/AuditRun_BrowserLogs_RequestDTO":{"id":"components/schemas/AuditRun_BrowserLogs_RequestDTO","kind":"json-schema","title":"AuditRun_BrowserLogs_RequestDTO","data":{"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"pageStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"level":{"$ref":"#/components/schemas/BrowserLogMessageLevelEnum"},"messageText":{"$ref":"#/components/schemas/StringInclusionFilter"},"anyRelatedTag":{"type":"boolean","description":"Show all messages with any related tag"}}}]}},"components/schemas/AuditRun_BrowserLogs_SummaryDTO":{"id":"components/schemas/AuditRun_BrowserLogs_SummaryDTO","kind":"json-schema","title":"AuditRun_BrowserLogs_SummaryDTO","data":{"description":"Log counts are actually filtered","allOf":[{"$ref":"#/components/schemas/AuditRun_BrowserLogs_MessageCountTrait"},{"type":"object","required":["totalPageCount","filteredPageCount"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"}}}]}},"components/schemas/AuditRun_BrowserLogs_MessageCountTrait":{"id":"components/schemas/AuditRun_BrowserLogs_MessageCountTrait","kind":"json-schema","title":"AuditRun_BrowserLogs_MessageCountTrait","data":{"type":"object","required":["errorLogCount","warnLogCount","infoLogCount","debugLogCount","otherLogCount"],"properties":{"errorLogCount":{"type":"integer","description":"Number of error level messages"},"warnLogCount":{"type":"integer","description":"Number of warn level messages"},"infoLogCount":{"type":"integer","description":"Number of info level messages"},"debugLogCount":{"type":"integer","description":"Number of debug level messages"},"otherLogCount":{"type":"integer","description":"Number of other level messages"}}}},"components/schemas/AuditRun_BrowserLogs_TrendsDTO":{"id":"components/schemas/AuditRun_BrowserLogs_TrendsDTO","kind":"json-schema","title":"AuditRun_BrowserLogs_TrendsDTO","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_BrowserLogs_TrendsItem"}}}}},"components/schemas/AuditRun_BrowserLogs_TrendsItem":{"id":"components/schemas/AuditRun_BrowserLogs_TrendsItem","kind":"json-schema","title":"AuditRun_BrowserLogs_TrendsItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"$ref":"#/components/schemas/AuditRun_BrowserLogs_MessageCountTrait"}]}},"components/schemas/AuditRun_BrowserLogs_TrendsEnum":{"id":"components/schemas/AuditRun_BrowserLogs_TrendsEnum","kind":"json-schema","title":"AuditRun_BrowserLogs_TrendsEnum","data":{"type":"string","x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"enum":["error_logs","warn_logs","info_logs","debug_logs","other_logs"]}},"components/schemas/AuditRun_BrowserLogs_MessagesDTO":{"id":"components/schemas/AuditRun_BrowserLogs_MessagesDTO","kind":"json-schema","title":"AuditRun_BrowserLogs_MessagesDTO","data":{"type":"object","required":["messages","metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"messages":{"type":"array","description":"Browser log messages discovered during audit run.","items":{"$ref":"#/components/schemas/AuditRun_BrowserLogs_MessagesItem"}}}}},"components/schemas/AuditRun_BrowserLogs_MessagesItem":{"id":"components/schemas/AuditRun_BrowserLogs_MessagesItem","kind":"json-schema","title":"AuditRun_BrowserLogs_MessagesItem","data":{"type":"object","required":["level","message","logCount","pageCount"],"properties":{"level":{"$ref":"#/components/schemas/BrowserLogMessageLevelEnum"},"message":{"type":"string"},"logCount":{"type":"integer"},"pageCount":{"type":"integer"},"relatedTag":{"$ref":"#/components/schemas/AuditRun_BrowserLogs_Messages_TagItem"}}}},"components/schemas/AuditRun_BrowserLogs_Messages_TagItem":{"id":"components/schemas/AuditRun_BrowserLogs_Messages_TagItem","kind":"json-schema","title":"AuditRun_BrowserLogs_Messages_TagItem","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"}]}},"components/schemas/AuditRun_BrowserLogs_MessagesSortColumn":{"id":"components/schemas/AuditRun_BrowserLogs_MessagesSortColumn","kind":"json-schema","title":"AuditRun_BrowserLogs_MessagesSortColumn","data":{"type":"string","enum":["level","message","instances_count","pages_count","related_tag"]}},"components/schemas/AuditRun_BrowserLogs_PagesRequestDTO":{"id":"components/schemas/AuditRun_BrowserLogs_PagesRequestDTO","kind":"json-schema","title":"AuditRun_BrowserLogs_PagesRequestDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter is present, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"messageText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter will be ignored"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/AuditRun_BrowserLogs_RequestDTO"},{"type":"object","properties":{"message":{"$ref":"#/components/schemas/AuditRun_BrowserLogs_SelectedMessage"}}}]}},"components/schemas/AuditRun_BrowserLogs_SelectedMessage":{"id":"components/schemas/AuditRun_BrowserLogs_SelectedMessage","kind":"json-schema","title":"AuditRun_BrowserLogs_SelectedMessage","data":{"type":"object","required":["message","level"],"properties":{"message":{"type":"string","minLength":1},"level":{"$ref":"#/components/schemas/BrowserLogMessageLevelEnum"}}}},"components/schemas/AuditRun_BrowserLogs_PagesDTO":{"id":"components/schemas/AuditRun_BrowserLogs_PagesDTO","kind":"json-schema","title":"AuditRun_BrowserLogs_PagesDTO","data":{"description":"Browser Logs pages list data","type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_BrowserLogs_PagesItem"}}}}},"components/schemas/AuditRun_BrowserLogs_PagesSortColumn":{"id":"components/schemas/AuditRun_BrowserLogs_PagesSortColumn","kind":"json-schema","title":"AuditRun_BrowserLogs_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_load_time","page_status_code","final_page_status_code","error_log_count","warn_log_count","info_log_count","debug_log_count","other_log_count"]}},"components/schemas/AuditRun_BrowserLogs_PagesItem":{"id":"components/schemas/AuditRun_BrowserLogs_PagesItem","kind":"json-schema","title":"AuditRun_BrowserLogs_PagesItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"$ref":"#/components/schemas/AuditRun_BrowserLogs_MessageCountTrait"}]}},"components/schemas/AuditRun_FileChanges_RequestDTO":{"id":"components/schemas/AuditRun_FileChanges_RequestDTO","kind":"json-schema","title":"AuditRun_FileChanges_RequestDTO","data":{"description":"Request body with filters for File Changes report","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"pageStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"primaryTagsOnly":{"type":"boolean","description":"if true then return only pages/tags with primary tags else return all pages/tags"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"dateDifference":{"$ref":"#/components/schemas/AuditRun_FileChanges_DateDifferenceBounds"},"sizeDifference":{"$ref":"#/components/schemas/AuditRun_FileChanges_SizeDifferenceBounds"},"filename":{"$ref":"#/components/schemas/RequestFilename"},"changeType":{"$ref":"#/components/schemas/AuditRun_FileChanges_FileChangeType"},"anyRelatedTag":{"type":"boolean","description":"Show all files with any related tag"}}}]}},"components/schemas/AuditRun_FileChanges_DateDifferenceBounds":{"id":"components/schemas/AuditRun_FileChanges_DateDifferenceBounds","kind":"json-schema","title":"AuditRun_FileChanges_DateDifferenceBounds","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters absolute difference values, e.g. when min = 200 then -300 diff passes filter. Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties defined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exclusive."},"children":[]}]}]}],"properties":{"min":{"$ref":"#/components/schemas/AuditRun_FileChanges_DateDifferenceBoundInMinutes"},"max":{"$ref":"#/components/schemas/AuditRun_FileChanges_DateDifferenceBoundInMinutes"}}}},"components/schemas/AuditRun_FileChanges_DateDifferenceBoundInMinutes":{"id":"components/schemas/AuditRun_FileChanges_DateDifferenceBoundInMinutes","kind":"json-schema","title":"AuditRun_FileChanges_DateDifferenceBoundInMinutes","data":{"type":"integer","description":"date difference in minutes","minimum":1}},"components/schemas/AuditRun_FileChanges_SizeDifferenceBounds":{"id":"components/schemas/AuditRun_FileChanges_SizeDifferenceBounds","kind":"json-schema","title":"AuditRun_FileChanges_SizeDifferenceBounds","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters absolute difference values, e.g. when min = 200 then -300 diff passes filter. Should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties defined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exclusive."},"children":[]}]}]}],"properties":{"min":{"$ref":"#/components/schemas/AuditRun_FileChanges_SizeDifferenceBoundInBytes"},"max":{"$ref":"#/components/schemas/AuditRun_FileChanges_SizeDifferenceBoundInBytes"}}}},"components/schemas/AuditRun_FileChanges_SizeDifferenceBoundInBytes":{"id":"components/schemas/AuditRun_FileChanges_SizeDifferenceBoundInBytes","kind":"json-schema","title":"AuditRun_FileChanges_SizeDifferenceBoundInBytes","data":{"type":"integer","description":"File size change in number of bytes","minimum":1}},"components/schemas/AuditRun_FileChanges_SummaryDTO":{"id":"components/schemas/AuditRun_FileChanges_SummaryDTO","kind":"json-schema","title":"AuditRun_FileChanges_SummaryDTO","data":{"type":"object","required":["totalPageCount","filteredPageCount","totalChangedFileCount","filteredChangedFileCount","totalNewFileCount","filteredNewFileCount","totalFileDateDifferenceCount","filteredFileDateDifferenceCount","totalFileSizeDifferenceCount","filteredFileSizeDifferenceCount"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"totalChangedFileCount":{"type":"integer","description":"Total number of changed files discovered"},"filteredChangedFileCount":{"type":"integer","description":"Number of changed files passing all applied filters"},"totalNewFileCount":{"type":"integer","description":"Total number of new files discovered"},"filteredNewFileCount":{"type":"integer","description":"Number of new files discovered that pass all applied filters"},"totalFileDateDifferenceCount":{"type":"integer","description":"Total number of files with date change discovered"},"filteredFileDateDifferenceCount":{"type":"integer","description":"Number of files with date change passing all applied filters"},"totalFileSizeDifferenceCount":{"type":"integer","description":"Total number of files with size change discovered"},"filteredFileSizeDifferenceCount":{"type":"integer","description":"Number of files with size change passing all applied filters"}}}},"components/schemas/AuditRun_FileChanges_FilesSortColumn":{"id":"components/schemas/AuditRun_FileChanges_FilesSortColumn","kind":"json-schema","title":"AuditRun_FileChanges_FilesSortColumn","data":{"type":"string","enum":["largest_size_diff","page_count","tag","filename","change_type","domain","party_type","largest_date_diff"]}},"components/schemas/AuditRun_FileChanges_FilesDTO":{"id":"components/schemas/AuditRun_FileChanges_FilesDTO","kind":"json-schema","title":"AuditRun_FileChanges_FilesDTO","data":{"type":"object","required":["metadata","files"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"files":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_FileChanges_FileItem"}}}}},"components/schemas/AuditRun_FileChanges_FileItem":{"id":"components/schemas/AuditRun_FileChanges_FileItem","kind":"json-schema","title":"AuditRun_FileChanges_FileItem","data":{"description":"If only one of them is null then this property has \"unknown\" change","allOf":[{"$ref":"#/components/schemas/AuditRun_FileChanges_FileItemTrait"},{"type":"object","required":["pageCount"],"properties":{"tag":{"$ref":"#/components/schemas/AuditRun_FileChanges_FileItemTag"},"largestDateDifference":{"$ref":"#/components/schemas/AuditRun_FileChanges_DateDifferenceInMinutes"},"largestSizeDifference":{"$ref":"#/components/schemas/AuditRun_FileChanges_SizeDifferenceInBytes"},"pageCount":{"type":"integer"}}}]}},"components/schemas/AuditRun_FileChanges_FileChangeType":{"id":"components/schemas/AuditRun_FileChanges_FileChangeType","kind":"json-schema","title":"AuditRun_FileChanges_FileChangeType","data":{"type":"string","enum":["new_file","not_changed","changed_file","deleted_file","unknown"]}},"components/schemas/AuditRun_FileChanges_DateDifferenceInMinutes":{"id":"components/schemas/AuditRun_FileChanges_DateDifferenceInMinutes","kind":"json-schema","title":"AuditRun_FileChanges_DateDifferenceInMinutes","data":{"type":"integer","description":"Number of minutes for date difference between 2 file versions, can be negative"}},"components/schemas/AuditRun_FileChanges_SizeDifferenceInBytes":{"id":"components/schemas/AuditRun_FileChanges_SizeDifferenceInBytes","kind":"json-schema","title":"AuditRun_FileChanges_SizeDifferenceInBytes","data":{"type":"integer","description":"File size change in number of bytes between 2 file versions, can be negative"}},"components/schemas/AuditRun_FileChanges_FileItemTrait":{"id":"components/schemas/AuditRun_FileChanges_FileItemTrait","kind":"json-schema","title":"AuditRun_FileChanges_FileItemTrait","data":{"type":"object","required":["filename","requestDomain","partyType","fileChangeType"],"properties":{"filename":{"$ref":"#/components/schemas/RequestFilename"},"requestDomain":{"$ref":"#/components/schemas/RequestDomain"},"partyType":{"$ref":"#/components/schemas/NetworkRequestPartyType"},"fileChangeType":{"$ref":"#/components/schemas/AuditRun_FileChanges_FileChangeType"}}}},"components/schemas/NetworkRequestPartyType":{"id":"components/schemas/NetworkRequestPartyType","kind":"json-schema","title":"NetworkRequestPartyType","data":{"type":"string","description":"Indicates the level of similarity of network request URL domain and its page URL domain","enum":["1st_party","3rd_party"]}},"components/schemas/AuditRun_FileChanges_FileItemTag":{"id":"components/schemas/AuditRun_FileChanges_FileItemTag","kind":"json-schema","title":"AuditRun_FileChanges_FileItemTag","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"}]}},"components/schemas/AuditRun_FileChanges_FilePagesRequestDTO":{"id":"components/schemas/AuditRun_FileChanges_FilePagesRequestDTO","kind":"json-schema","title":"AuditRun_FileChanges_FilePagesRequestDTO","data":{"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","required":["file"],"properties":{"pageStatusCode":{"$ref":"#/components/schemas/StatusCodeEnum"},"dateDifference":{"$ref":"#/components/schemas/AuditRun_FileChanges_DateDifferenceBounds"},"sizeDifference":{"$ref":"#/components/schemas/AuditRun_FileChanges_SizeDifferenceBounds"},"file":{"$ref":"#/components/schemas/AuditRun_FileChanges_PagesRequestFile"},"changeType":{"$ref":"#/components/schemas/AuditRun_FileChanges_FileChangeType"}}}]}},"components/schemas/AuditRun_FileChanges_PagesRequestFile":{"id":"components/schemas/AuditRun_FileChanges_PagesRequestFile","kind":"json-schema","title":"AuditRun_FileChanges_PagesRequestFile","data":{"allOf":[{"$ref":"#/components/schemas/AuditRun_FileChanges_FileItemTrait"},{"type":"object","properties":{"tagId":{"$ref":"#/components/schemas/TagId"}}}]}},"components/schemas/AuditRun_FileChanges_PagesSortColumn":{"id":"components/schemas/AuditRun_FileChanges_PagesSortColumn","kind":"json-schema","title":"AuditRun_FileChanges_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_load_time","page_status_code","final_page_status_code"]}},"components/schemas/AuditRun_FileChanges_PagesDTO":{"id":"components/schemas/AuditRun_FileChanges_PagesDTO","kind":"json-schema","title":"AuditRun_FileChanges_PagesDTO","data":{"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_FileChanges_PageItem"}}}}},"components/schemas/AuditRun_FileChanges_PageItem":{"id":"components/schemas/AuditRun_FileChanges_PageItem","kind":"json-schema","title":"AuditRun_FileChanges_PageItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"}]}},"components/schemas/RunData_ItemTypeEnum":{"id":"components/schemas/RunData_ItemTypeEnum","kind":"json-schema","title":"RunData_ItemTypeEnum","data":{"type":"string","enum":["audit"]}},"components/schemas/RunData_RequestDTO":{"id":"components/schemas/RunData_RequestDTO","kind":"json-schema","title":"RunData_RequestDTO","data":{"type":"array","items":{"$ref":"#/components/schemas/RunData_RequestItemDTO"}}},"components/schemas/RunData_RequestItemDTO":{"id":"components/schemas/RunData_RequestItemDTO","kind":"json-schema","title":"RunData_RequestItemDTO","data":{"type":"object","required":["itemType","itemId","runId"],"properties":{"itemType":{"$ref":"#/components/schemas/RunData_ItemTypeEnum"},"itemId":{"type":"integer","format":"int64","example":107239},"runId":{"$ref":"#/components/schemas/RunId"}}}},"components/schemas/RunData_Tags_SortColumn":{"id":"components/schemas/RunData_Tags_SortColumn","kind":"json-schema","title":"RunData_Tags_SortColumn","data":{"type":"string","enum":["tag_name"]}},"components/schemas/RunData_Cookies_SortColumn":{"id":"components/schemas/RunData_Cookies_SortColumn","kind":"json-schema","title":"RunData_Cookies_SortColumn","data":{"type":"string","enum":["cookie_name","cookie_domain"]}},"components/schemas/RunData_Request_Domains_SortColumn":{"id":"components/schemas/RunData_Request_Domains_SortColumn","kind":"json-schema","title":"RunData_Request_Domains_SortColumn","data":{"type":"string","enum":["request_domain"]}},"components/schemas/RunData_TagItemDTO":{"id":"components/schemas/RunData_TagItemDTO","kind":"json-schema","title":"RunData_TagItemDTO","data":{"type":"object","properties":{"accounts":{"type":"array","maxItems":500,"uniqueItems":true,"items":{"$ref":"#/components/schemas/TagAccount"}},"tagId":{"$ref":"#/components/schemas/TagId"},"tagName":{"type":"string"}}}},"components/schemas/RunData_CookieItemDTO":{"id":"components/schemas/RunData_CookieItemDTO","kind":"json-schema","title":"RunData_CookieItemDTO","data":{"type":"object","properties":{"domain":{"type":"string"},"name":{"type":"string"}}}},"components/schemas/RunData_RequestDomainItemDTO":{"id":"components/schemas/RunData_RequestDomainItemDTO","kind":"json-schema","title":"RunData_RequestDomainItemDTO","data":{"type":"object","properties":{"domain":{"type":"string"},"countries":{"type":"array","items":{"$ref":"#/components/schemas/RunData_RequestDomainCountryDTO"}}}}},"components/schemas/RunData_RequestDomainCountryDTO":{"id":"components/schemas/RunData_RequestDomainCountryDTO","kind":"json-schema","title":"RunData_RequestDomainCountryDTO","data":{"type":"object","properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"countryName":{"type":"string"},"countryCodeId":{"type":"integer"},"continentId":{"type":"integer"},"continentName":{"type":"string"}}}},"components/schemas/RunData_TagsDTO":{"id":"components/schemas/RunData_TagsDTO","kind":"json-schema","title":"RunData_TagsDTO","data":{"type":"object","required":["metadata","tags"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/RunData_TagItemDTO"}}}}},"components/schemas/RunData_CookiesDTO":{"id":"components/schemas/RunData_CookiesDTO","kind":"json-schema","title":"RunData_CookiesDTO","data":{"type":"object","required":["metadata","cookies"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"cookies":{"type":"array","items":{"$ref":"#/components/schemas/RunData_CookieItemDTO"}}}}},"components/schemas/RunData_RequestDomains":{"id":"components/schemas/RunData_RequestDomains","kind":"json-schema","title":"RunData_RequestDomains","data":{"type":"object","required":["metadata","requestDomains"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"requestDomains":{"type":"array","items":{"$ref":"#/components/schemas/RunData_RequestDomainItemDTO"}}}}},"components/schemas/AuditRun_CookiePrivacy_RequestDTO":{"id":"components/schemas/AuditRun_CookiePrivacy_RequestDTO","kind":"json-schema","title":"AuditRun_CookiePrivacy_RequestDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body with filters for Cookie Privacy report. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consentCategorySnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is deprecated, need to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consentCategoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"$ref":"#/components/schemas/CookieFiltersTrait"},{"type":"object","properties":{"cookieName":{"$ref":"#/components/schemas/StringInclusionFilter"},"cookieDomain":{"$ref":"#/components/schemas/StringInclusionFilter"},"consentCategoryId":{"$ref":"#/components/schemas/ConsentCategoryId"},"consentCategorySnapshotId":{"$ref":"#/components/schemas/ConsentCategorySnapshotId"},"consentCategoryComplianceStatus":{"$ref":"#/components/schemas/ConsentCategoryComplianceStatus"}}}]}},"components/schemas/AuditRun_CookiePrivacy_SummaryDTO":{"id":"components/schemas/AuditRun_CookiePrivacy_SummaryDTO","kind":"json-schema","title":"AuditRun_CookiePrivacy_SummaryDTO","data":{"description":"Cookie Privacy report summary","type":"object","required":["totalPageCount","filteredPageCount","totalUniqueCookieCount","filteredUniqueCookieCount","totalApprovedCookieCount","filteredApprovedCookieCount","totalUnapprovedCookieCount","filteredUnapprovedCookieCount","filteredPageWithUnapprovedCookieCount","runHasNoConsentCategoriesAssigned"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"totalUniqueCookieCount":{"type":"integer","description":"Total number of unique cookies discovered. Cookie uniqueness determined by cookie name and domain"},"filteredUniqueCookieCount":{"type":"integer","description":"Number of unique cookies passing all applied filters"},"totalApprovedCookieCount":{"type":"integer","description":"Total number of approved cookies discovered"},"filteredApprovedCookieCount":{"type":"integer","description":"Number of approved cookies passing all applied filters"},"totalUnapprovedCookieCount":{"type":"integer","description":"Total number of unapproved cookies discovered"},"filteredUnapprovedCookieCount":{"type":"integer","description":"Number of unapproved cookies passing all applied filters"},"filteredPageWithUnapprovedCookieCount":{"type":"integer","description":"Number of pages with unapproved cookies passing all applied filters"},"runHasNoConsentCategoriesAssigned":{"$ref":"#/components/schemas/RunHasNoConsentCategoriesAssigned"}}}},"components/schemas/AuditRun_CookiePrivacy_TrendsDTO":{"id":"components/schemas/AuditRun_CookiePrivacy_TrendsDTO","kind":"json-schema","title":"AuditRun_CookiePrivacy_TrendsDTO","data":{"description":"Cookie Privacy report trends","required":["runs"],"properties":{"runs":{"type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/AuditRun_CookiePrivacy_TrendItem"}}}}},"components/schemas/AuditRun_CookiePrivacy_TrendItem":{"id":"components/schemas/AuditRun_CookiePrivacy_TrendItem","kind":"json-schema","title":"AuditRun_CookiePrivacy_TrendItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalUniqueCookieCount","totalApprovedCookieCount","totalUnapprovedCookieCount"],"properties":{"totalUniqueCookieCount":{"type":"integer","description":"Total number of unique cookies discovered. Cookie uniqueness determined same as in Cookie Inventory"},"totalApprovedCookieCount":{"type":"integer","description":"Total number of approved cookies found in audit run"},"totalUnapprovedCookieCount":{"type":"integer","description":"Total number of unapproved cookies found in audit run"}}}]}},"components/schemas/AuditRun_CookiePrivacy_TrendsEnum":{"id":"components/schemas/AuditRun_CookiePrivacy_TrendsEnum","kind":"json-schema","title":"AuditRun_CookiePrivacy_TrendsEnum","data":{"type":"string","x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"enum":["unique_cookies","approved_cookies","unapproved_cookies"]}},"components/schemas/AuditRun_CookiePrivacy_CookiesComplianceDTO":{"id":"components/schemas/AuditRun_CookiePrivacy_CookiesComplianceDTO","kind":"json-schema","title":"AuditRun_CookiePrivacy_CookiesComplianceDTO","data":{"description":"Cookie Compliance data","type":"object","required":["metadata","cookies"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"cookies":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_CookiePrivacy_CookieItem"}}}}},"components/schemas/AuditRun_CookiePrivacy_CookieItem":{"id":"components/schemas/AuditRun_CookiePrivacy_CookieItem","kind":"json-schema","title":"AuditRun_CookiePrivacy_CookieItem","data":{"allOf":[{"$ref":"#/components/schemas/AggregatedCookieTrait"},{"type":"object","required":["cookieName","cookieDomain","filteredPageCount"],"properties":{"cookieName":{"$ref":"#/components/schemas/CookieName"},"cookieDomain":{"$ref":"#/components/schemas/CookieDomain"},"consentCategoryComplianceStatus":{"$ref":"#/components/schemas/ConsentCategoryComplianceStatus"},"consentCategoryName":{"$ref":"#/components/schemas/ConsentCategoryName"},"consentCategorySnapshotId":{"$ref":"#/components/schemas/ConsentCategorySnapshotId"},"consentCategories":{"type":"array","description":"List of consent categories matching this cookie","minItems":0,"items":{"$ref":"#/components/schemas/AuditRunPrivacy_ConsentCategoryItem"}},"filteredPageCount":{"type":"integer"}}}]}},"components/schemas/AuditRunPrivacy_ConsentCategoryItem":{"id":"components/schemas/AuditRunPrivacy_ConsentCategoryItem","kind":"json-schema","title":"AuditRunPrivacy_ConsentCategoryItem","data":{"type":"object","required":["consentCategoryComplianceStatus","consentCategoryName","consentCategorySnapshotId"],"properties":{"consentCategoryComplianceStatus":{"$ref":"#/components/schemas/ConsentCategoryComplianceStatus"},"consentCategoryName":{"$ref":"#/components/schemas/ConsentCategoryName"},"consentCategorySnapshotId":{"$ref":"#/components/schemas/ConsentCategorySnapshotId"}}}},"components/schemas/AuditRun_CookiePrivacy_CookiesSortColumn":{"id":"components/schemas/AuditRun_CookiePrivacy_CookiesSortColumn","kind":"json-schema","title":"AuditRun_CookiePrivacy_CookiesSortColumn","data":{"type":"string","enum":["compliance_status","page_count","cookie_name","cookie_domain","consent_category_name","consent_categories","cookie_changed_during"]}},"components/schemas/AuditRun_CookiePrivacy_CookiePagesRequestDTO":{"id":"components/schemas/AuditRun_CookiePrivacy_CookiePagesRequestDTO","kind":"json-schema","title":"AuditRun_CookiePrivacy_CookiePagesRequestDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cookieName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cookieDomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are deprecated"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"$ref":"#/components/schemas/CookieFiltersTrait"},{"type":"object","properties":{"cookieName":{"deprecated":true,"type":"string","description":"Cookie name"},"cookieDomain":{"deprecated":true,"type":"string","description":"Cookie domain; preceding dot removed"},"cookie":{"type":"object","required":["name","domain"],"properties":{"name":{"$ref":"#/components/schemas/CookieName"},"domain":{"$ref":"#/components/schemas/CookieDomain"}}}}}]}},"components/schemas/AuditRun_CookiePrivacy_PagesDTO":{"id":"components/schemas/AuditRun_CookiePrivacy_PagesDTO","kind":"json-schema","title":"AuditRun_CookiePrivacy_PagesDTO","data":{"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_CookiePrivacy_PageItem"}}}}},"components/schemas/AuditRun_CookiePrivacy_PageItem":{"id":"components/schemas/AuditRun_CookiePrivacy_PageItem","kind":"json-schema","title":"AuditRun_CookiePrivacy_PageItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["cookieCount"],"properties":{"cookieCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of distinct cookie name+domain pairs on a page"},"children":[]}]}]}]}}}]}},"components/schemas/AuditRun_CookiePrivacy_PagesSortColumn":{"id":"components/schemas/AuditRun_CookiePrivacy_PagesSortColumn","kind":"json-schema","title":"AuditRun_CookiePrivacy_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_load_time","page_status_code","final_page_status_code","cookie_count"]}},"components/schemas/AuditRun_TagPrivacy_RequestDTO":{"id":"components/schemas/AuditRun_TagPrivacy_RequestDTO","kind":"json-schema","title":"AuditRun_TagPrivacy_RequestDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body with filters for Tag Privacy report. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consentCategorySnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is deprecated, need to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consentCategoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"type":"object","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"primaryTagsOnly":{"type":"boolean","description":"If true then return only pages/tags with primary tags else return all pages/tags"},"tagId":{"$ref":"#/components/schemas/TagId"},"tagCategoryId":{"$ref":"#/components/schemas/TagCategoryId"},"tagVendorId":{"$ref":"#/components/schemas/TagVendorId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"consentCategoryId":{"$ref":"#/components/schemas/ConsentCategoryId"},"consentCategorySnapshotId":{"$ref":"#/components/schemas/ConsentCategorySnapshotId"},"consentCategoryComplianceStatus":{"$ref":"#/components/schemas/ConsentCategoryComplianceStatus"}}}]}},"components/schemas/AuditRun_TagPrivacy_SummaryDTO":{"id":"components/schemas/AuditRun_TagPrivacy_SummaryDTO","kind":"json-schema","title":"AuditRun_TagPrivacy_SummaryDTO","data":{"description":"Tag Privacy report summary","type":"object","required":["totalPageCount","filteredPageCount","totalUniqueTagCount","filteredUniqueTagCount","totalApprovedTagCount","filteredApprovedTagCount","totalUnapprovedTagCount","filteredUnapprovedTagCount","filteredPageWithUnapprovedTagCount","runHasNoConsentCategoriesAssigned"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"totalUniqueTagCount":{"type":"integer","description":"Total number of unique tag vendors discovered"},"filteredUniqueTagCount":{"type":"integer","description":"Number of unique tag vendors passing all applied filters"},"totalApprovedTagCount":{"type":"integer","description":"Total number of approved tag vendors discovered"},"filteredApprovedTagCount":{"type":"integer","description":"Number of approved tags passing all applied filters"},"totalUnapprovedTagCount":{"type":"integer","description":"Total number of unapproved tag vendors discovered"},"filteredUnapprovedTagCount":{"type":"integer","description":"Number of unapproved tags passing all applied filters"},"filteredPageWithUnapprovedTagCount":{"type":"integer","description":"Number of pages with unapproved tags passing all applied filters"},"runHasNoConsentCategoriesAssigned":{"type":"boolean","description":"When TRUE, run did not have any consent categories assigned.\nWhen NOT specified or FALSE, it had at least one.\n"}}}},"components/schemas/AuditRun_TagPrivacy_TrendsDTO":{"id":"components/schemas/AuditRun_TagPrivacy_TrendsDTO","kind":"json-schema","title":"AuditRun_TagPrivacy_TrendsDTO","data":{"description":"Tag Privacy report trends","required":["runs"],"properties":{"runs":{"type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/AuditRun_TagPrivacy_TrendItem"}}}}},"components/schemas/AuditRun_TagPrivacy_TrendItem":{"id":"components/schemas/AuditRun_TagPrivacy_TrendItem","kind":"json-schema","title":"AuditRun_TagPrivacy_TrendItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalUniqueTagCount","totalApprovedTagCount","totalUnapprovedTagCount"],"properties":{"totalUniqueTagCount":{"type":"integer","description":"Total number of unique tag vendors discovered"},"totalApprovedTagCount":{"type":"integer","description":"Total number of approved tags found in audit run"},"totalUnapprovedTagCount":{"type":"integer","description":"Total number of unapproved tags found in audit run"}}}]}},"components/schemas/AuditRun_TagPrivacy_TrendsEnum":{"id":"components/schemas/AuditRun_TagPrivacy_TrendsEnum","kind":"json-schema","title":"AuditRun_TagPrivacy_TrendsEnum","data":{"type":"string","x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"enum":["unique_tags","approved_tags","unapproved_tags"]}},"components/schemas/AuditRun_TagPrivacy_TagsComplianceDTO":{"id":"components/schemas/AuditRun_TagPrivacy_TagsComplianceDTO","kind":"json-schema","title":"AuditRun_TagPrivacy_TagsComplianceDTO","data":{"description":"Tag Compliance data","type":"object","required":["metadata","tags"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagPrivacy_TagItem"}}}}},"components/schemas/AuditRun_TagPrivacy_TagItem":{"id":"components/schemas/AuditRun_TagPrivacy_TagItem","kind":"json-schema","title":"AuditRun_TagPrivacy_TagItem","data":{"allOf":[{"$ref":"#/components/schemas/TagInfoTrait"},{"type":"object","required":["tagAccount","filteredPageCount"],"properties":{"tagAccount":{"$ref":"#/components/schemas/TagAccount"},"consentCategoryComplianceStatus":{"$ref":"#/components/schemas/ConsentCategoryComplianceStatus"},"consentCategorySnapshotId":{"$ref":"#/components/schemas/ConsentCategorySnapshotId"},"consentCategoryName":{"$ref":"#/components/schemas/ConsentCategoryName"},"consentCategories":{"type":"array","description":"List of consent categories matching this tag","minItems":0,"items":{"$ref":"#/components/schemas/AuditRunPrivacy_ConsentCategoryItem"}},"filteredPageCount":{"type":"integer"}}}]}},"components/schemas/AuditRun_TagPrivacy_TagsSortColumn":{"id":"components/schemas/AuditRun_TagPrivacy_TagsSortColumn","kind":"json-schema","title":"AuditRun_TagPrivacy_TagsSortColumn","data":{"type":"string","enum":["compliance_status","page_count","tag_name","consent_category_name","consent_categories"]}},"components/schemas/AuditRun_TagPrivacy_PagesSortColumn":{"id":"components/schemas/AuditRun_TagPrivacy_PagesSortColumn","kind":"json-schema","title":"AuditRun_TagPrivacy_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_load_time","page_status_code","final_page_status_code","tag_count"]}},"components/schemas/AuditRun_TagPrivacy_TagPagesRequestDTO":{"id":"components/schemas/AuditRun_TagPrivacy_TagPagesRequestDTO","kind":"json-schema","title":"AuditRun_TagPrivacy_TagPagesRequestDTO","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","required":["tagId","tagAccount"],"properties":{"tagId":{"$ref":"#/components/schemas/TagId"},"tagAccount":{"$ref":"#/components/schemas/TagAccount"}}}]}},"components/schemas/AuditRun_TagPrivacy_PagesDTO":{"id":"components/schemas/AuditRun_TagPrivacy_PagesDTO","kind":"json-schema","title":"AuditRun_TagPrivacy_PagesDTO","data":{"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagPrivacy_PageItem"}}}}},"components/schemas/AuditRun_TagPrivacy_PageItem":{"id":"components/schemas/AuditRun_TagPrivacy_PageItem","kind":"json-schema","title":"AuditRun_TagPrivacy_PageItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["tagRequestCount"],"properties":{"tagRequestCount":{"type":"integer","description":"Number of tag requests on a page"}}}]}},"components/schemas/AuditRun_RequestPrivacy_RequestDTO":{"id":"components/schemas/AuditRun_RequestPrivacy_RequestDTO","kind":"json-schema","title":"AuditRun_RequestPrivacy_RequestDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body with filters for Request Privacy report. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consentCategorySnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is deprecated, need to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consentCategoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"type":"object","allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"requestDomain":{"$ref":"#/components/schemas/RequestDomain"},"consentCategoryId":{"$ref":"#/components/schemas/ConsentCategoryId"},"consentCategorySnapshotId":{"$ref":"#/components/schemas/ConsentCategorySnapshotId"},"consentCategoryComplianceStatus":{"$ref":"#/components/schemas/ConsentCategoryComplianceStatus"},"countryCode":{"$ref":"#/components/schemas/CountryCode"}}}]}},"components/schemas/AuditRun_RequestPrivacy_SummaryDTO":{"id":"components/schemas/AuditRun_RequestPrivacy_SummaryDTO","kind":"json-schema","title":"AuditRun_RequestPrivacy_SummaryDTO","data":{"description":"Request Privacy report summary","type":"object","required":["totalPageCount","filteredPageCount","totalRequestCount","filteredRequestCount","filteredUniqueRequestDomainCount","filteredUniqueRequestGeoCount","totalApprovedRequestCount","totalUniqueApprovedRequestDomainCount","filteredApprovedRequestCount","filteredUniqueApprovedRequestDomainCount","totalUnapprovedRequestCount","totalUniqueUnapprovedRequestDomainCount","filteredUnapprovedRequestCount","filteredUniqueUnapprovedRequestDomainCount","filteredPageWithUnapprovedRequestCount","runHasNoConsentCategoriesAssigned"],"properties":{"totalPageCount":{"type":"integer","description":"Total number of pages audited"},"filteredPageCount":{"type":"integer","description":"Number of pages passing all applied filters"},"totalRequestCount":{"type":"integer","description":"Total number of network requests discovered"},"filteredRequestCount":{"type":"integer","description":"Number of network request passing all applied filters"},"filteredUniqueRequestDomainCount":{"type":"integer","description":"Number of unique network request domains passing all applied filters"},"filteredUniqueRequestGeoCount":{"type":"integer","description":"Number of unique network request geolocations passing all applied filters"},"totalApprovedRequestCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of approved domain+geo pairs discovered"},"children":[]}]}]}],"deprecated":true},"totalUniqueApprovedRequestDomainCount":{"type":"integer","description":"Total number of unique approved request domains discovered"},"filteredApprovedRequestCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of approved domain+geo pairs passing all applied filters"},"children":[]}]}]}],"deprecated":true},"filteredUniqueApprovedRequestDomainCount":{"type":"integer","description":"Number of unique approved request domains passing all applied filters"},"totalUnapprovedRequestCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of unapproved domain+geo pairs discovered"},"children":[]}]}]}],"deprecated":true},"totalUniqueUnapprovedRequestDomainCount":{"type":"integer","description":"Total number of unique unapproved domains discovered"},"filteredUnapprovedRequestCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of unapproved domain+geo pairs passing all applied filters"},"children":[]}]}]}],"deprecated":true},"filteredUniqueUnapprovedRequestDomainCount":{"type":"integer","description":"Number of unique unapproved domains passing all applied filters"},"filteredPageWithUnapprovedRequestCount":{"type":"integer","description":"Number of pages with unapproved domains or geos passing all applied filters"},"runHasNoConsentCategoriesAssigned":{"$ref":"#/components/schemas/RunHasNoConsentCategoriesAssigned"}}}},"components/schemas/AuditRun_RequestPrivacy_TrendsDTO":{"id":"components/schemas/AuditRun_RequestPrivacy_TrendsDTO","kind":"json-schema","title":"AuditRun_RequestPrivacy_TrendsDTO","data":{"description":"Request Privacy report trends","required":["runs"],"properties":{"runs":{"type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/AuditRun_RequestPrivacy_TrendItem"}}}}},"components/schemas/AuditRun_RequestPrivacy_TrendItem":{"id":"components/schemas/AuditRun_RequestPrivacy_TrendItem","kind":"json-schema","title":"AuditRun_RequestPrivacy_TrendItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["totalRequestCount","totalUniqueRequestDomainCount","totalUniqueRequestGeoCount","totalApprovedRequestCount","totalUniqueApprovedRequestDomainCount","totalUnapprovedRequestCount","totalUniqueUnapprovedRequestDomainCount"],"properties":{"totalRequestCount":{"type":"integer","description":"Total number of network requests discovered"},"totalUniqueRequestDomainCount":{"type":"integer","description":"Total number of unique network request domains discovered"},"totalUniqueRequestGeoCount":{"type":"integer","description":"Total number of unique network request geolocations discovered"},"totalApprovedRequestCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of approved domain+geo pairs discovered"},"children":[]}]}]}],"deprecated":true},"totalUniqueApprovedRequestDomainCount":{"type":"integer","description":"Total number of unique approved request domains discovered"},"totalUnapprovedRequestCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of unapproved domain+geo pairs discovered"},"children":[]}]}]}],"deprecated":true},"totalUniqueUnapprovedRequestDomainCount":{"type":"integer","description":"Total number of unique unapproved domains discovered"}}}]}},"components/schemas/AuditRun_RequestPrivacy_TrendsEnum":{"id":"components/schemas/AuditRun_RequestPrivacy_TrendsEnum","kind":"json-schema","title":"AuditRun_RequestPrivacy_TrendsEnum","data":{"type":"string","x-implements":["com.observepoint.reportingapi.gen.interfaces.TrendEnumCompatibleWithRunsGrid"],"enum":["request_count","unique_domains","unique_geos","approved_requests","unique_approved_domains","unapproved_requests","unique_unapproved_domains"]}},"components/schemas/AuditRun_RequestPrivacy_RequestLocationsDTO":{"id":"components/schemas/AuditRun_RequestPrivacy_RequestLocationsDTO","kind":"json-schema","title":"AuditRun_RequestPrivacy_RequestLocationsDTO","data":{"type":"object","required":["locations"],"properties":{"locations":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestGeo.country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be repeated in different array elements and may have different "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"es with different consent categories"},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/AuditRun_RequestPrivacy_RequestLocationItem"}}}}},"components/schemas/AuditRun_RequestPrivacy_RequestLocationItem":{"id":"components/schemas/AuditRun_RequestPrivacy_RequestLocationItem","kind":"json-schema","title":"AuditRun_RequestPrivacy_RequestLocationItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consent category id & name are absent if location has not been matched by any consent category"},"children":[]}]}]}],"required":["requestGeo","requestCount"],"properties":{"requestGeo":{"$ref":"#/components/schemas/AuditRun_RequestPrivacy_GeoLocation"},"requestCount":{"type":"integer"},"status":{"$ref":"#/components/schemas/ConsentCategoryComplianceStatus"}}}},"components/schemas/AuditRun_RequestPrivacy_RequestsComplianceDTO":{"id":"components/schemas/AuditRun_RequestPrivacy_RequestsComplianceDTO","kind":"json-schema","title":"AuditRun_RequestPrivacy_RequestsComplianceDTO","data":{"description":"Request Compliance data","type":"object","required":["metadata","requests"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"requests":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_RequestPrivacy_RequestItem"}}}}},"components/schemas/AuditRun_RequestPrivacy_RequestsSortColumn":{"id":"components/schemas/AuditRun_RequestPrivacy_RequestsSortColumn","kind":"json-schema","title":"AuditRun_RequestPrivacy_RequestsSortColumn","data":{"type":"string","enum":["compliance_status","page_count","domain","geo","request_count","consent_category_name","consent_categories"]}},"components/schemas/AuditRun_RequestPrivacy_RequestItem":{"id":"components/schemas/AuditRun_RequestPrivacy_RequestItem","kind":"json-schema","title":"AuditRun_RequestPrivacy_RequestItem","data":{"type":"object","required":["requestDomain","requestCount","filteredPageCount"],"properties":{"requestDomain":{"$ref":"#/components/schemas/RequestDomain"},"requestGeo":{"$ref":"#/components/schemas/AuditRun_RequestPrivacy_GeoLocation"},"requestCount":{"type":"integer"},"consentCategoryComplianceStatus":{"$ref":"#/components/schemas/ConsentCategoryComplianceStatus"},"consentCategorySnapshotId":{"$ref":"#/components/schemas/ConsentCategorySnapshotId"},"consentCategoryName":{"$ref":"#/components/schemas/ConsentCategoryName"},"consentCategories":{"type":"array","description":"List of consent categories matching this request","minItems":0,"items":{"$ref":"#/components/schemas/AuditRunPrivacy_ConsentCategoryItem"}},"filteredPageCount":{"type":"integer"}}}},"components/schemas/AuditRun_RequestPrivacy_GeoLocation":{"id":"components/schemas/AuditRun_RequestPrivacy_GeoLocation","kind":"json-schema","title":"AuditRun_RequestPrivacy_GeoLocation","data":{"type":"object","required":["countryCode","countryName"],"properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"countryName":{"type":"string","example":"United States"}}}},"components/schemas/AuditRun_RequestPrivacy_RequestPagesRequestDTO":{"id":"components/schemas/AuditRun_RequestPrivacy_RequestPagesRequestDTO","kind":"json-schema","title":"AuditRun_RequestPrivacy_RequestPagesRequestDTO","data":{"type":"object","required":["requestDomain"],"allOf":[{"$ref":"#/components/schemas/PageFiltersTrait"},{"type":"object","properties":{"requestDomain":{"$ref":"#/components/schemas/RequestDomain"},"countryCode":{"$ref":"#/components/schemas/CountryCode"}}}]}},"components/schemas/AuditRun_RequestPrivacy_PagesDTO":{"id":"components/schemas/AuditRun_RequestPrivacy_PagesDTO","kind":"json-schema","title":"AuditRun_RequestPrivacy_PagesDTO","data":{"type":"object","required":["metadata","pages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_RequestPrivacy_PageItem"}}}}},"components/schemas/AuditRun_RequestPrivacy_PageItem":{"id":"components/schemas/AuditRun_RequestPrivacy_PageItem","kind":"json-schema","title":"AuditRun_RequestPrivacy_PageItem","data":{"allOf":[{"$ref":"#/components/schemas/AuditRunPageCommonColumnsWithFinalValuesTrait"},{"type":"object","required":["geoCount","requestCount"],"properties":{"geoCount":{"type":"integer","description":"Number of distinct geo locations on a page"},"requestCount":{"type":"integer","description":"Number of network requests discovered on a page"}}}]}},"components/schemas/AuditRun_RequestPrivacy_PagesSortColumn":{"id":"components/schemas/AuditRun_RequestPrivacy_PagesSortColumn","kind":"json-schema","title":"AuditRun_RequestPrivacy_PagesSortColumn","data":{"type":"string","enum":["page_url","final_page_url","page_load_time","page_status_code","final_page_status_code","geo_count","request_count"]}},"components/schemas/TagVariablesExportTagItem":{"id":"components/schemas/TagVariablesExportTagItem","kind":"json-schema","title":"TagVariablesExportTagItem","data":{"type":"object","required":["tagId","tagAccounts"],"properties":{"tagId":{"$ref":"#/components/schemas/TagId"},"allTagAccounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to export more than 100 accounts"},"children":[]}]}]}]},"tagAccounts":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contents ignored if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allTagAccounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxItems":100,"items":{"$ref":"#/components/schemas/TagAccount"}}}}},"components/schemas/ConsentCategory_ExportTypeEnum":{"id":"components/schemas/ConsentCategory_ExportTypeEnum","kind":"json-schema","title":"ConsentCategory_ExportTypeEnum","data":{"type":"string","description":"All supported consent category export types (non-related to runs)","enum":["ACCOUNT_CONSENT_CATEGORY_CONFIGS_EXPORT"]}},"components/schemas/ManualJourneyRun_ExportTypeEnum":{"id":"components/schemas/ManualJourneyRun_ExportTypeEnum","kind":"json-schema","title":"ManualJourneyRun_ExportTypeEnum","data":{"type":"string","description":"All supported manual journey run export types","enum":["FULL"]}},"components/schemas/ManualJourneyRun_ExportRequestDTO":{"id":"components/schemas/ManualJourneyRun_ExportRequestDTO","kind":"json-schema","title":"ManualJourneyRun_ExportRequestDTO","data":{"type":"object","properties":{"includeActions":{"type":"boolean"},"includeRequestLog":{"type":"boolean"},"includeRuleResults":{"type":"boolean"},"includeTagSummary":{"type":"boolean"},"includeTagDetails":{"type":"boolean"}}}},"components/schemas/WebJourneyRun_ExportTypeEnum":{"id":"components/schemas/WebJourneyRun_ExportTypeEnum","kind":"json-schema","title":"WebJourneyRun_ExportTypeEnum","data":{"type":"string","description":"All supported web journey run export types","enum":["ACTION_SUMMARY","ACTION_TAGS","ACTION_TAG_VARIABLES","RULE_SUMMARY","ACTION_COOKIES","ACTION_NETWORK_REQUESTS","ACTION_BROWSER_LOGS"]}},"components/schemas/WebJourneyRun_ExportTypeToFilterMapping":{"id":"components/schemas/WebJourneyRun_ExportTypeToFilterMapping","kind":"json-schema","title":"WebJourneyRun_ExportTypeToFilterMapping","data":{"description":"This mapping describes what export request filters are supported by different audit run export types","discriminator":{"propertyName":"export_type","mapping":{"ACTION_TAG_VARIABLES":"#/components/schemas/WebJourneyRun_ActionTagVariables_RequestDTO"}}}},"components/schemas/WebJourneyRun_ActionTagVariables_RequestDTO":{"id":"components/schemas/WebJourneyRun_ActionTagVariables_RequestDTO","kind":"json-schema","title":"WebJourneyRun_ActionTagVariables_RequestDTO","data":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagVariablesExportTagItem"}}}}},"components/schemas/AlertExportTypeEnum":{"id":"components/schemas/AlertExportTypeEnum","kind":"json-schema","title":"AlertExportTypeEnum","data":{"type":"string","description":"All supported alert export types","enum":["ACCOUNT_LEVEL_TRIGGERED_ALERTS_EXPORT"]}},"components/schemas/AlertExportTypeToFilterMapping":{"id":"components/schemas/AlertExportTypeToFilterMapping","kind":"json-schema","title":"AlertExportTypeToFilterMapping","data":{"description":"This mapping describes what export request filters are supported by different alert export types","discriminator":{"propertyName":"export_type","mapping":{"ACCOUNT_LEVEL_TRIGGERED_ALERTS_EXPORT":"#/components/schemas/AccountTriggeredAlertsRequestDTO"}}}},"components/schemas/AlertExportTypeToSortColumnMapping":{"id":"components/schemas/AlertExportTypeToSortColumnMapping","kind":"json-schema","title":"AlertExportTypeToSortColumnMapping","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This mapping describes what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column enums are supported by different alert export types"},"children":[]}]}]}],"discriminator":{"propertyName":"export_type","mapping":{"ACCOUNT_LEVEL_TRIGGERED_ALERTS_EXPORT":"#/components/schemas/GetAccountTriggeredAlertsSortColumn"}}}},"components/schemas/AccountUsageExportTypeEnum":{"id":"components/schemas/AccountUsageExportTypeEnum","kind":"json-schema","title":"AccountUsageExportTypeEnum","data":{"type":"string","description":"All supported usage export types","enum":["AUDIT_RUNS_EXPORT","WEB_JOURNEY_RUNS_EXPORT"]}},"components/schemas/AccountUsageExportTypeToFilterMapping":{"id":"components/schemas/AccountUsageExportTypeToFilterMapping","kind":"json-schema","title":"AccountUsageExportTypeToFilterMapping","data":{"description":"This mapping describes what export request filters are supported by different usage export types","discriminator":{"propertyName":"export_type","mapping":{"AUDIT_RUNS_EXPORT":"#/components/schemas/AccountUsageV2_ExportRequestDTO","WEB_JOURNEY_RUNS_EXPORT":"#/components/schemas/AccountUsageV2_ExportRequestDTO"}}}},"components/schemas/AuditRun_ExportTypeEnum":{"id":"components/schemas/AuditRun_ExportTypeEnum","kind":"json-schema","title":"AuditRun_ExportTypeEnum","data":{"type":"string","description":"All supported audit run export types","enum":["AUDIT_SUMMARY_DETECTED_TAGS","RULE_SUMMARY_PAGE_RESULTS","RULE_SUMMARY_PAGE_RULE_RESULTS","PAGE_SUMMARY_PAGES","PAGE_SUMMARY_BROKEN_SCANNED_LINKS","TAG_INVENTORY_PAGES","TAG_HEALTH_PAGES","TAG_DUPLICATES_AND_MULTIPLES_PAGES","VARIABLE_INVENTORY_TAG_ACCOUNT_PAGES","VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_PAGES","VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_NOT_SET_PAGES","VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_VALUE_PAGES","COOKIE_INVENTORY_PAGES","COOKIE_INVENTORY_COOKIE_PAGES","COOKIE_INVENTORY_COOKIES_AGGREGATED","BROWSER_LOGS_PAGES","TAG_PRIVACY_COMPLIANCE","TAG_PRIVACY_PAGES","TAG_PRIVACY_TAG_PAGES","COOKIE_PRIVACY_COMPLIANCE","COOKIE_PRIVACY_PAGES","COOKIE_PRIVACY_COOKIE_PAGES","REQUEST_PRIVACY_COMPLIANCE","REQUEST_PRIVACY_PAGES","REQUEST_PRIVACY_REQUEST_PAGES","FILE_CHANGES_PAGES","FILE_CHANGES_FILE_PAGES","TAG_METADATA","TAG_INVENTORY_PAGE_TAGS","COOKIE_INVENTORY_COOKIES","BROWSER_LOGS_PAGE_LOGS","NETWORK_REQUEST_LOG_PAGE_REQUESTS","RULE_SUMMARY_RULES","VARIABLE_INVENTORY_TAG_VARIABLES","ALERT_SUMMARY_ALERTS"]}},"components/schemas/AuditRun_ExportTypeToFilterMapping":{"id":"components/schemas/AuditRun_ExportTypeToFilterMapping","kind":"json-schema","title":"AuditRun_ExportTypeToFilterMapping","data":{"description":"This mapping describes what export request filters are supported by different audit run export types","discriminator":{"propertyName":"export_type","mapping":{"AUDIT_SUMMARY_DETECTED_TAGS":"#/components/schemas/AuditRun_AuditSummary_RequestDTO","RULE_SUMMARY_PAGE_RESULTS":"#/components/schemas/AuditRun_RuleSummary_AllRuleResultsRequestDTO","RULE_SUMMARY_PAGE_RULE_RESULTS":"#/components/schemas/AuditRun_RuleSummary_SpecificRulePagesExportRequestDTO","PAGE_SUMMARY_PAGES":"#/components/schemas/PageSummaryRequestDTO","TAG_INVENTORY_PAGES":"#/components/schemas/AuditRun_TagInventory_RequestDTO","TAG_INVENTORY_PAGE_TAGS":"#/components/schemas/AuditRun_TagInventory_PageTagsRequestDTO","TAG_HEALTH_PAGES":"#/components/schemas/AuditRun_TagHealth_RequestDTO","TAG_DUPLICATES_AND_MULTIPLES_PAGES":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesRequestDTO","VARIABLE_INVENTORY_TAG_ACCOUNT_PAGES":"#/components/schemas/AuditRun_VariableInventory_TagAccountRequestDTO","VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_PAGES":"#/components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_NOT_SET_PAGES":"#/components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_VALUE_PAGES":"#/components/schemas/AuditRun_VariableInventory_TagAccountVariableRequestDTO","COOKIE_INVENTORY_PAGES":"#/components/schemas/AuditRun_CookieInventory_RequestDTO","COOKIE_INVENTORY_COOKIE_PAGES":"#/components/schemas/AuditRun_CookieInventory_CookiePagesRequestDTO","COOKIE_INVENTORY_COOKIES_AGGREGATED":"#/components/schemas/AuditRun_CookieInventory_RequestDTO","BROWSER_LOGS_PAGES":"#/components/schemas/AuditRun_BrowserLogs_PagesRequestDTO","TAG_PRIVACY_COMPLIANCE":"#/components/schemas/AuditRun_TagPrivacy_RequestDTO","TAG_PRIVACY_PAGES":"#/components/schemas/AuditRun_TagPrivacy_RequestDTO","TAG_PRIVACY_TAG_PAGES":"#/components/schemas/AuditRun_TagPrivacy_TagPagesRequestDTO","COOKIE_PRIVACY_COMPLIANCE":"#/components/schemas/AuditRun_CookiePrivacy_RequestDTO","COOKIE_PRIVACY_PAGES":"#/components/schemas/AuditRun_CookiePrivacy_RequestDTO","COOKIE_PRIVACY_COOKIE_PAGES":"#/components/schemas/AuditRun_CookiePrivacy_CookiePagesRequestDTO","REQUEST_PRIVACY_COMPLIANCE":"#/components/schemas/AuditRun_RequestPrivacy_RequestDTO","REQUEST_PRIVACY_PAGES":"#/components/schemas/AuditRun_RequestPrivacy_RequestDTO","REQUEST_PRIVACY_REQUEST_PAGES":"#/components/schemas/AuditRun_RequestPrivacy_RequestPagesRequestDTO","FILE_CHANGES_PAGES":"#/components/schemas/AuditRun_FileChanges_RequestDTO","FILE_CHANGES_FILE_PAGES":"#/components/schemas/AuditRun_FileChanges_FilePagesRequestDTO","VARIABLE_INVENTORY_TAG_VARIABLES":"#/components/schemas/AuditRun_VariableInventory_TagVariablesExportRequestDTO","ALERT_SUMMARY_ALERTS":"#/components/schemas/AuditRun_AlertSummary_SummaryRequestDTO"}}}},"components/schemas/AuditRun_ExportTypeToSortColumnMapping":{"id":"components/schemas/AuditRun_ExportTypeToSortColumnMapping","kind":"json-schema","title":"AuditRun_ExportTypeToSortColumnMapping","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This mapping describes what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column enums are supported by different audit run export types"},"children":[]}]}]}],"discriminator":{"propertyName":"export_type","mapping":{"RULE_SUMMARY_PAGE_RESULTS":"#/components/schemas/AuditRun_RuleSummary_AllRules_PagesSortColumn","RULE_SUMMARY_PAGE_RULE_RESULTS":"#/components/schemas/AuditRun_RuleSummary_SpecificRule_PagesSortColumn","PAGE_SUMMARY_PAGES":"#/components/schemas/AuditRun_PageSummary_PagesSortColumn","TAG_INVENTORY_PAGES":"#/components/schemas/AuditRun_TagInventory_PagesSortColumn","TAG_HEALTH_PAGES":"#/components/schemas/AuditRun_TagHealth_PageSortColumn","TAG_DUPLICATES_AND_MULTIPLES_PAGES":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesSortColumn","VARIABLE_INVENTORY_TAG_ACCOUNT_PAGES":"#/components/schemas/AuditRun_VariableInventory_PagesSortColumn","VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_PAGES":"#/components/schemas/AuditRun_VariableInventory_PagesSortColumn","VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_NOT_SET_PAGES":"#/components/schemas/AuditRun_VariableInventory_PagesSortColumn","VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_VALUE_PAGES":"#/components/schemas/AuditRun_VariableInventory_PagesSortColumn","COOKIE_INVENTORY_PAGES":"#/components/schemas/AuditRun_CookieInventory_PageSortColumn","COOKIE_INVENTORY_COOKIE_PAGES":"#/components/schemas/AuditRun_CookieInventory_PageSortColumn","COOKIE_INVENTORY_COOKIES_AGGREGATED":"#/components/schemas/AuditRun_CookieInventory_CookiesSortColumn","BROWSER_LOGS_PAGES":"#/components/schemas/AuditRun_BrowserLogs_PagesSortColumn","TAG_PRIVACY_COMPLIANCE":"#/components/schemas/AuditRun_TagPrivacy_TagsSortColumn","TAG_PRIVACY_PAGES":"#/components/schemas/AuditRun_TagPrivacy_PagesSortColumn","TAG_PRIVACY_TAG_PAGES":"#/components/schemas/AuditRun_TagPrivacy_PagesSortColumn","COOKIE_PRIVACY_COMPLIANCE":"#/components/schemas/AuditRun_CookiePrivacy_CookiesSortColumn","COOKIE_PRIVACY_PAGES":"#/components/schemas/AuditRun_CookiePrivacy_PagesSortColumn","COOKIE_PRIVACY_COOKIE_PAGES":"#/components/schemas/AuditRun_CookiePrivacy_PagesSortColumn","REQUEST_PRIVACY_COMPLIANCE":"#/components/schemas/AuditRun_RequestPrivacy_RequestsSortColumn","REQUEST_PRIVACY_PAGES":"#/components/schemas/AuditRun_RequestPrivacy_PagesSortColumn","REQUEST_PRIVACY_REQUEST_PAGES":"#/components/schemas/AuditRun_RequestPrivacy_PagesSortColumn","FILE_CHANGES_PAGES":"#/components/schemas/AuditRun_FileChanges_PagesSortColumn","FILE_CHANGES_FILE_PAGES":"#/components/schemas/AuditRun_FileChanges_PagesSortColumn","ALERT_SUMMARY_ALERTS":"#/components/schemas/AuditRun_AuditSummary_AlertsSortColumn"}}}},"components/schemas/AuditRun_VariableInventory_TagVariablesExportRequestDTO":{"id":"components/schemas/AuditRun_VariableInventory_TagVariablesExportRequestDTO","kind":"json-schema","title":"AuditRun_VariableInventory_TagVariablesExportRequestDTO","data":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/TagVariablesExportTagItem"}}}}},"components/schemas/AuditRun_TagInventory_PageTagsRequestDTO":{"id":"components/schemas/AuditRun_TagInventory_PageTagsRequestDTO","kind":"json-schema","title":"AuditRun_TagInventory_PageTagsRequestDTO","data":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_TagInventory_PageTagsExportTagAccountItem"}}}}},"components/schemas/AuditRun_TagInventory_PageTagsExportTagAccountItem":{"id":"components/schemas/AuditRun_TagInventory_PageTagsExportTagAccountItem","kind":"json-schema","title":"AuditRun_TagInventory_PageTagsExportTagAccountItem","data":{"type":"object","required":["tagId","account"],"properties":{"tagId":{"$ref":"#/components/schemas/TagId"},"account":{"$ref":"#/components/schemas/TagAccount"}}}},"components/schemas/ExportResultDTO":{"id":"components/schemas/ExportResultDTO","kind":"json-schema","title":"ExportResultDTO","data":{"type":"object","required":["exportId"],"properties":{"exportId":{"$ref":"#/components/schemas/ExportId"}}}},"components/schemas/ExportTypeEnum":{"id":"components/schemas/ExportTypeEnum","kind":"json-schema","title":"ExportTypeEnum","data":{"type":"string","description":"Enumeration of all high-level export types","enum":["AUDIT_RUN_EXPORT","WEB_JOURNEY_RUN_EXPORT","MANUAL_JOURNEY_RUN_EXPORT","CONSENT_CATEGORY_EXPORT","ALERT_EXPORT","ACCOUNT_USAGE_EXPORT","GRID_DATA_EXPORT"]}},"components/schemas/AlertName":{"id":"components/schemas/AlertName","kind":"json-schema","title":"AlertName","data":{"type":"string","minLength":1,"description":"User-defined name of the alert"}},"components/schemas/AdHocAlertsRequestDTO":{"id":"components/schemas/AdHocAlertsRequestDTO","kind":"json-schema","title":"AdHocAlertsRequestDTO","data":{"type":"object","required":["alerts"],"properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AdHocAlertRequestItem"}}}}},"components/schemas/AdHocAlertRequestItem":{"id":"components/schemas/AdHocAlertRequestItem","kind":"json-schema","title":"AdHocAlertRequestItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alert is triggered when comparison holds: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <targetValueComparisonOperator> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetValue"},"children":[]}]}]}],"required":["name","metricType","targetValueComparator","filtersV0"],"properties":{"name":{"$ref":"#/components/schemas/AlertName"},"metricType":{"$ref":"#/components/schemas/AlertMetricTypeEnum"},"metricChangeType":{"$ref":"#/components/schemas/AlertMetricChangeTypeEnum"},"targetValueComparator":{"$ref":"#/components/schemas/AlertMetricValueComparator"},"filtersV0":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters to be applied before computing the alert. Exact type depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metricType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", see mapping in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlertMetricTypeToFilterMapping"},"children":[]}]}]}]}}}},"components/schemas/AlertMetricTypeEnum":{"id":"components/schemas/AlertMetricTypeEnum","kind":"json-schema","title":"AlertMetricTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated metric types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAGE_SUMMARY_FAILED_RULE_COUNT"},"children":[]}]}]}]}],"enum":["ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT","ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT","ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT","ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT","ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT","ACCOUNT_USAGE_V2_THIS_MONTH_AUDIT_PAGE_USAGE_PERCENTAGE","ACCOUNT_USAGE_V2_CURRENT_TERM_PAGE_USAGE_PERCENTAGE","ACCOUNT_USAGE_V2_CURRENT_TERM_WJ_RUN_USAGE_PERCENTAGE","ACCOUNT_USAGE_V2_THIS_MONTH_WJ_RUN_USAGE_PERCENTAGE","ACCOUNT_USAGE_V2_LAST_30_DAYS_LOGIN_USER_COUNT","SCORE_TOTAL","SCORE_TAG_PRESENCE","SCORE_TAG_PERFORMANCE","SCORE_RULES","SCORE_PAGE_PERFORMANCE","SCORE_COOKIE","PAGE_SUMMARY_PAGE_COUNT","PAGE_SUMMARY_AVG_PAGE_LOAD_TIME","PAGE_SUMMARY_BROKEN_INITIAL_PAGE_COUNT","PAGE_SUMMARY_BROKEN_FINAL_PAGE_COUNT","PAGE_SUMMARY_PAGE_WITH_BROKEN_LINKS_COUNT","PAGE_SUMMARY_FAILED_RULE_COUNT","PAGE_SUMMARY_WEB_VITALS_P75_LARGEST_CONTENTFUL_PAINT","PAGE_SUMMARY_WEB_VITALS_P75_FIRST_CONTENTFUL_PAINT","PAGE_SUMMARY_WEB_VITALS_P75_TIME_TO_FIRST_BYTE","PAGE_SUMMARY_WEB_VITALS_P75_CUMULATIVE_LAYOUT_SHIFT","TAG_INVENTORY_PAGE_COUNT","TAG_INVENTORY_UNIQUE_TAG_COUNT","TAG_INVENTORY_BROKEN_TAG_COUNT","TAG_INVENTORY_BROKEN_PAGE_COUNT","TAG_HEALTH_PAGE_COUNT","TAG_HEALTH_AVG_TAG_LOAD_TIME","TAG_HEALTH_AVG_TAG_REQUEST_SIZE","TAG_HEALTH_SLOW_TAG_PERCENTAGE","TAG_HEALTH_BROKEN_TAG_PERCENTAGE","TAG_HEALTH_TAG_REQUEST_COUNT","TAG_DUPLICATES_AND_MULTIPLES_PAGE_COUNT","TAG_DUPLICATES_AND_MULTIPLES_UNIQUE_TAG_COUNT","TAG_DUPLICATES_AND_MULTIPLES_TAG_REQUEST_COUNT","TAG_DUPLICATES_AND_MULTIPLES_TAG_DUPLICATE_COUNT","TAG_DUPLICATES_AND_MULTIPLES_TAG_MULTIPLE_COUNT","VARIABLE_INVENTORY_PAGE_COUNT","VARIABLE_INVENTORY_UNIQUE_TAG_COUNT","VARIABLE_INVENTORY_TAG_REQUEST_COUNT","VARIABLE_INVENTORY_UNIQUE_VARIABLE_COUNT","VARIABLE_INVENTORY_UNIQUE_VARIABLE_VALUE_COUNT","BROWSER_LOGS_PAGE_COUNT","BROWSER_LOGS_ERROR_LOG_COUNT","BROWSER_LOGS_WARN_LOG_COUNT","BROWSER_LOGS_INFO_LOG_COUNT","BROWSER_LOGS_DEBUG_LOG_COUNT","BROWSER_LOGS_OTHER_LOG_COUNT","COOKIE_INVENTORY_PAGE_COUNT","COOKIE_INVENTORY_UNIQUE_COOKIE_COUNT","COOKIE_INVENTORY_FIRST_PARTY_COOKIE_COUNT","COOKIE_INVENTORY_THIRD_PARTY_COOKIE_COUNT","COOKIE_INVENTORY_NON_SECURE_COOKIE_COUNT","COOKIE_INVENTORY_SAME_SITE_EMPTY_COOKIE_COUNT","PRIVACY_COOKIES_PAGE_COUNT","PRIVACY_COOKIES_PAGE_WITH_UNAPPROVED_COOKIES_COUNT","PRIVACY_COOKIES_UNIQUE_COOKIE_COUNT","PRIVACY_COOKIES_APPROVED_COOKIE_COUNT","PRIVACY_COOKIES_UNAPPROVED_COOKIE_COUNT","PRIVACY_TAGS_PAGE_COUNT","PRIVACY_TAGS_PAGE_WITH_UNAPPROVED_TAGS_COUNT","PRIVACY_TAGS_UNIQUE_TAG_COUNT","PRIVACY_TAGS_APPROVED_TAG_COUNT","PRIVACY_TAGS_UNAPPROVED_TAG_COUNT","PRIVACY_REQUESTS_PAGE_COUNT","PRIVACY_REQUESTS_PAGE_WITH_UNAPPROVED_REQUESTS_COUNT","PRIVACY_REQUESTS_REQUEST_COUNT","PRIVACY_REQUESTS_UNIQUE_DOMAIN_COUNT","PRIVACY_REQUESTS_UNIQUE_LOCATION_COUNT","PRIVACY_REQUESTS_APPROVED_REQUEST_COUNT","PRIVACY_REQUESTS_UNAPPROVED_REQUEST_COUNT","FILE_CHANGES_PAGE_COUNT","FILE_CHANGES_CHANGED_FILE_COUNT","FILE_CHANGES_NEW_FILE_COUNT","FILE_CHANGES_FILE_DATE_CHANGE_COUNT","FILE_CHANGES_FILE_SIZE_CHANGE_COUNT","RULE_RESULTS_PAGE_COUNT","RULE_RESULTS_RULE_COUNT","RULE_RESULTS_RULE_FAILURE_COUNT","RULE_RESULTS_FAILED_RULE_COUNT","RULE_RESULTS_PASSED_RULE_COUNT","RULE_RESULTS_NOT_APPLIED_RULE_COUNT","RULE_RESULTS_FAILED_RULE_PAGE_COUNT","RULE_RESULTS_PASSED_RULE_PAGE_COUNT","RULE_RESULTS_NOT_APPLIED_RULE_PAGE_COUNT"]}},"components/schemas/AlertMetricTypeToFilterMapping":{"id":"components/schemas/AlertMetricTypeToFilterMapping","kind":"json-schema","title":"AlertMetricTypeToFilterMapping","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This mapping describes what alert filters are supported by different alert metric types - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlertMetricTypeEnum"},"children":[]}]}]}],"discriminator":{"propertyName":"metricType","mapping":{"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT":"#/components/schemas/AccountUsage_RequestDTO","ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT":"#/components/schemas/AccountUsage_RequestDTO","ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT":"#/components/schemas/AccountUsage_RequestDTO","ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT":"#/components/schemas/AccountUsage_RequestDTO","ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT":"#/components/schemas/AccountUsage_RequestDTO","ACCOUNT_USAGE_V2_THIS_MONTH_AUDIT_PAGE_USAGE_PERCENTAGE":"#/components/schemas/AccountUsageV2_RequestDTO","ACCOUNT_USAGE_V2_CURRENT_TERM_PAGE_USAGE_PERCENTAGE":"#/components/schemas/AccountUsageV2_RequestDTO","ACCOUNT_USAGE_V2_CURRENT_TERM_WJ_RUN_USAGE_PERCENTAGE":"#/components/schemas/AccountUsageV2_RequestDTO","ACCOUNT_USAGE_V2_THIS_MONTH_WJ_RUN_USAGE_PERCENTAGE":"#/components/schemas/AccountUsageV2_RequestDTO","ACCOUNT_USAGE_V2_LAST_30_DAYS_LOGIN_USER_COUNT":"#/components/schemas/AccountUsageV2_RequestDTO","SCORE_TOTAL":"#/components/schemas/AuditRun_AuditSummary_RequestDTO","SCORE_TAG_PRESENCE":"#/components/schemas/AuditRun_AuditSummary_RequestDTO","SCORE_TAG_PERFORMANCE":"#/components/schemas/AuditRun_AuditSummary_RequestDTO","SCORE_RULES":"#/components/schemas/AuditRun_AuditSummary_RequestDTO","SCORE_PAGE_PERFORMANCE":"#/components/schemas/AuditRun_AuditSummary_RequestDTO","SCORE_COOKIE":"#/components/schemas/AuditRun_AuditSummary_RequestDTO","PAGE_SUMMARY_PAGE_COUNT":"#/components/schemas/PageSummaryRequestDTO","PAGE_SUMMARY_AVG_PAGE_LOAD_TIME":"#/components/schemas/PageSummaryRequestDTO","PAGE_SUMMARY_BROKEN_INITIAL_PAGE_COUNT":"#/components/schemas/PageSummaryRequestDTO","PAGE_SUMMARY_BROKEN_FINAL_PAGE_COUNT":"#/components/schemas/PageSummaryRequestDTO","PAGE_SUMMARY_PAGE_WITH_BROKEN_LINKS_COUNT":"#/components/schemas/PageSummaryRequestDTO","PAGE_SUMMARY_FAILED_RULE_COUNT":"#/components/schemas/PageSummaryRequestDTO","PAGE_SUMMARY_WEB_VITALS_P75_LARGEST_CONTENTFUL_PAINT":"#/components/schemas/PageSummaryRequestDTO","PAGE_SUMMARY_WEB_VITALS_P75_FIRST_CONTENTFUL_PAINT":"#/components/schemas/PageSummaryRequestDTO","PAGE_SUMMARY_WEB_VITALS_P75_TIME_TO_FIRST_BYTE":"#/components/schemas/PageSummaryRequestDTO","PAGE_SUMMARY_WEB_VITALS_P75_CUMULATIVE_LAYOUT_SHIFT":"#/components/schemas/PageSummaryRequestDTO","TAG_INVENTORY_PAGE_COUNT":"#/components/schemas/AuditRun_TagInventory_RequestDTO","TAG_INVENTORY_UNIQUE_TAG_COUNT":"#/components/schemas/AuditRun_TagInventory_RequestDTO","TAG_INVENTORY_BROKEN_TAG_COUNT":"#/components/schemas/AuditRun_TagInventory_RequestDTO","TAG_INVENTORY_BROKEN_PAGE_COUNT":"#/components/schemas/AuditRun_TagInventory_RequestDTO","TAG_HEALTH_PAGE_COUNT":"#/components/schemas/AuditRun_TagHealth_RequestDTO","TAG_HEALTH_AVG_TAG_LOAD_TIME":"#/components/schemas/AuditRun_TagHealth_RequestDTO","TAG_HEALTH_AVG_TAG_REQUEST_SIZE":"#/components/schemas/AuditRun_TagHealth_RequestDTO","TAG_HEALTH_SLOW_TAG_PERCENTAGE":"#/components/schemas/AuditRun_TagHealth_RequestDTO","TAG_HEALTH_BROKEN_TAG_PERCENTAGE":"#/components/schemas/AuditRun_TagHealth_RequestDTO","TAG_HEALTH_TAG_REQUEST_COUNT":"#/components/schemas/AuditRun_TagHealth_RequestDTO","TAG_DUPLICATES_AND_MULTIPLES_PAGE_COUNT":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","TAG_DUPLICATES_AND_MULTIPLES_UNIQUE_TAG_COUNT":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","TAG_DUPLICATES_AND_MULTIPLES_TAG_REQUEST_COUNT":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","TAG_DUPLICATES_AND_MULTIPLES_TAG_DUPLICATE_COUNT":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","TAG_DUPLICATES_AND_MULTIPLES_TAG_MULTIPLE_COUNT":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_RequestDTO","VARIABLE_INVENTORY_PAGE_COUNT":"#/components/schemas/AuditRun_VariableInventory_RequestDTO","VARIABLE_INVENTORY_UNIQUE_TAG_COUNT":"#/components/schemas/AuditRun_VariableInventory_RequestDTO","VARIABLE_INVENTORY_TAG_REQUEST_COUNT":"#/components/schemas/AuditRun_VariableInventory_RequestDTO","VARIABLE_INVENTORY_UNIQUE_VARIABLE_COUNT":"#/components/schemas/AuditRun_VariableInventory_RequestDTO","VARIABLE_INVENTORY_UNIQUE_VARIABLE_VALUE_COUNT":"#/components/schemas/AuditRun_VariableInventory_RequestDTO","BROWSER_LOGS_PAGE_COUNT":"#/components/schemas/AuditRun_BrowserLogs_RequestDTO","BROWSER_LOGS_ERROR_LOG_COUNT":"#/components/schemas/AuditRun_BrowserLogs_RequestDTO","BROWSER_LOGS_WARN_LOG_COUNT":"#/components/schemas/AuditRun_BrowserLogs_RequestDTO","BROWSER_LOGS_INFO_LOG_COUNT":"#/components/schemas/AuditRun_BrowserLogs_RequestDTO","BROWSER_LOGS_DEBUG_LOG_COUNT":"#/components/schemas/AuditRun_BrowserLogs_RequestDTO","BROWSER_LOGS_OTHER_LOG_COUNT":"#/components/schemas/AuditRun_BrowserLogs_RequestDTO","COOKIE_INVENTORY_PAGE_COUNT":"#/components/schemas/AuditRun_CookieInventory_RequestDTO","COOKIE_INVENTORY_UNIQUE_COOKIE_COUNT":"#/components/schemas/AuditRun_CookieInventory_RequestDTO","COOKIE_INVENTORY_FIRST_PARTY_COOKIE_COUNT":"#/components/schemas/AuditRun_CookieInventory_RequestDTO","COOKIE_INVENTORY_THIRD_PARTY_COOKIE_COUNT":"#/components/schemas/AuditRun_CookieInventory_RequestDTO","COOKIE_INVENTORY_NON_SECURE_COOKIE_COUNT":"#/components/schemas/AuditRun_CookieInventory_RequestDTO","COOKIE_INVENTORY_SAME_SITE_EMPTY_COOKIE_COUNT":"#/components/schemas/AuditRun_CookieInventory_RequestDTO","PRIVACY_COOKIES_PAGE_COUNT":"#/components/schemas/AuditRun_CookiePrivacy_RequestDTO","PRIVACY_COOKIES_PAGE_WITH_UNAPPROVED_COOKIES_COUNT":"#/components/schemas/AuditRun_CookiePrivacy_RequestDTO","PRIVACY_COOKIES_UNIQUE_COOKIE_COUNT":"#/components/schemas/AuditRun_CookiePrivacy_RequestDTO","PRIVACY_COOKIES_APPROVED_COOKIE_COUNT":"#/components/schemas/AuditRun_CookiePrivacy_RequestDTO","PRIVACY_COOKIES_UNAPPROVED_COOKIE_COUNT":"#/components/schemas/AuditRun_CookiePrivacy_RequestDTO","PRIVACY_TAGS_PAGE_COUNT":"#/components/schemas/AuditRun_TagPrivacy_RequestDTO","PRIVACY_TAGS_PAGE_WITH_UNAPPROVED_TAGS_COUNT":"#/components/schemas/AuditRun_TagPrivacy_RequestDTO","PRIVACY_TAGS_UNIQUE_TAG_COUNT":"#/components/schemas/AuditRun_TagPrivacy_RequestDTO","PRIVACY_TAGS_APPROVED_TAG_COUNT":"#/components/schemas/AuditRun_TagPrivacy_RequestDTO","PRIVACY_TAGS_UNAPPROVED_TAG_COUNT":"#/components/schemas/AuditRun_TagPrivacy_RequestDTO","PRIVACY_REQUESTS_PAGE_COUNT":"#/components/schemas/AuditRun_RequestPrivacy_RequestDTO","PRIVACY_REQUESTS_PAGE_WITH_UNAPPROVED_REQUESTS_COUNT":"#/components/schemas/AuditRun_RequestPrivacy_RequestDTO","PRIVACY_REQUESTS_REQUEST_COUNT":"#/components/schemas/AuditRun_RequestPrivacy_RequestDTO","PRIVACY_REQUESTS_UNIQUE_DOMAIN_COUNT":"#/components/schemas/AuditRun_RequestPrivacy_RequestDTO","PRIVACY_REQUESTS_UNIQUE_LOCATION_COUNT":"#/components/schemas/AuditRun_RequestPrivacy_RequestDTO","PRIVACY_REQUESTS_APPROVED_REQUEST_COUNT":"#/components/schemas/AuditRun_RequestPrivacy_RequestDTO","PRIVACY_REQUESTS_UNAPPROVED_REQUEST_COUNT":"#/components/schemas/AuditRun_RequestPrivacy_RequestDTO","FILE_CHANGES_PAGE_COUNT":"#/components/schemas/AuditRun_FileChanges_RequestDTO","FILE_CHANGES_CHANGED_FILE_COUNT":"#/components/schemas/AuditRun_FileChanges_RequestDTO","FILE_CHANGES_NEW_FILE_COUNT":"#/components/schemas/AuditRun_FileChanges_RequestDTO","FILE_CHANGES_FILE_DATE_CHANGE_COUNT":"#/components/schemas/AuditRun_FileChanges_RequestDTO","FILE_CHANGES_FILE_SIZE_CHANGE_COUNT":"#/components/schemas/AuditRun_FileChanges_RequestDTO","RULE_RESULTS_PAGE_COUNT":"#/components/schemas/AuditRun_RuleSummary_RequestDTO","RULE_RESULTS_RULE_COUNT":"#/components/schemas/AuditRun_RuleSummary_RequestDTO","RULE_RESULTS_RULE_FAILURE_COUNT":"#/components/schemas/AuditRun_RuleSummary_RequestDTO","RULE_RESULTS_FAILED_RULE_COUNT":"#/components/schemas/AuditRun_RuleSummary_RequestDTO","RULE_RESULTS_PASSED_RULE_COUNT":"#/components/schemas/AuditRun_RuleSummary_RequestDTO","RULE_RESULTS_NOT_APPLIED_RULE_COUNT":"#/components/schemas/AuditRun_RuleSummary_RequestDTO","RULE_RESULTS_FAILED_RULE_PAGE_COUNT":"#/components/schemas/AuditRun_RuleSummary_RequestDTO","RULE_RESULTS_PASSED_RULE_PAGE_COUNT":"#/components/schemas/AuditRun_RuleSummary_RequestDTO","RULE_RESULTS_NOT_APPLIED_RULE_PAGE_COUNT":"#/components/schemas/AuditRun_RuleSummary_RequestDTO"}}}},"components/schemas/AlertMetricChangeTypeEnum":{"id":"components/schemas/AlertMetricChangeTypeEnum","kind":"json-schema","title":"AlertMetricChangeTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behaviour per type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VALUE_CHANGE: current - previous"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VALUE_CHANGE_ABS: ABS(current - previous)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RELATIVE_VALUE_CHANGE: 100% * (current - previous) / previous"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RELATIVE_VALUE_CHANGE: ABS(100% * (current - previous) / previous)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Composite metric change operators shown on ObservePoint UI should be defined as described below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Changes by (∆)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = VALUE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Increases by (+)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = VALUE_CHANGE + GREATER_OR_EQUAL(positive number)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Decreases by (-)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = VALUE_CHANGE + LESS_OR_EQUAL(negative number)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Any change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = VALUE_CHANGE_ABS (or VALUE_CHANGE) + NOT_EQUAL(0)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Changes by (∆ %)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = RELATIVE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Increases by (+%)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = RELATIVE_CHANGE + GREATER_OR_EQUAL(positive number)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Decreases by (-%)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = RELATIVE_CHANGE + LESS_OR_EQUAL(negative number)"},"children":[]}]}]}]}],"enum":["VALUE_CHANGE","VALUE_CHANGE_ABS","RELATIVE_VALUE_CHANGE","RELATIVE_VALUE_CHANGE_ABS"]}},"components/schemas/AlertMetricValueComparator":{"id":"components/schemas/AlertMetricValueComparator","kind":"json-schema","title":"AlertMetricValueComparator","data":{"type":"object","description":"Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator\n","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/AlertMetricValueComparisonOperatorEnum"}},"discriminator":{"propertyName":"operator","mapping":{"GREATER":"#/components/schemas/AlertMetricSpecificValueComparator","GREATER_OR_EQUAL":"#/components/schemas/AlertMetricSpecificValueComparator","EQUAL":"#/components/schemas/AlertMetricSpecificValueComparator","NOT_EQUAL":"#/components/schemas/AlertMetricSpecificValueComparator","LESS_OR_EQUAL":"#/components/schemas/AlertMetricSpecificValueComparator","LESS":"#/components/schemas/AlertMetricSpecificValueComparator","BETWEEN":"#/components/schemas/AlertMetricValueInRangeComparator","NOT_BETWEEN":"#/components/schemas/AlertMetricValueNotInRangeComparator"}}}},"components/schemas/AlertMetricValueComparisonOperatorEnum":{"id":"components/schemas/AlertMetricValueComparisonOperatorEnum","kind":"json-schema","title":"AlertMetricValueComparisonOperatorEnum","data":{"type":"string","enum":["GREATER","GREATER_OR_EQUAL","EQUAL","NOT_EQUAL","LESS_OR_EQUAL","LESS","BETWEEN","NOT_BETWEEN"]}},"components/schemas/AlertMetricSpecificValueComparator":{"id":"components/schemas/AlertMetricSpecificValueComparator","kind":"json-schema","title":"AlertMetricSpecificValueComparator","data":{"allOf":[{"$ref":"#/components/schemas/AlertMetricValueComparator"},{"type":"object","required":["targetValue"],"properties":{"targetValue":{"type":"number","format":"float"}}}]}},"components/schemas/AlertMetricValueInRangeComparator":{"id":"components/schemas/AlertMetricValueInRangeComparator","kind":"json-schema","title":"AlertMetricValueInRangeComparator","data":{"allOf":[{"$ref":"#/components/schemas/AlertMetricValueComparator"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alert is triggered when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual >= min AND actual < max"},"children":[]}]}]}],"required":["minInclusive","maxExclusive"],"properties":{"minInclusive":{"type":"number","format":"float"},"maxExclusive":{"type":"number","format":"float"}}}]}},"components/schemas/AlertMetricValueNotInRangeComparator":{"id":"components/schemas/AlertMetricValueNotInRangeComparator","kind":"json-schema","title":"AlertMetricValueNotInRangeComparator","data":{"allOf":[{"$ref":"#/components/schemas/AlertMetricValueComparator"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alert is triggered when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual < min OR actual >= max"},"children":[]}]}]}],"required":["minExclusive","maxInclusive"],"properties":{"minExclusive":{"type":"number","format":"float"},"maxInclusive":{"type":"number","format":"float"}}}]}},"components/schemas/AdHocAlertResultsDTO":{"id":"components/schemas/AdHocAlertResultsDTO","kind":"json-schema","title":"AdHocAlertResultsDTO","data":{"type":"object","required":["alerts"],"properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AdHocAlertResultsItem"}}}}},"components/schemas/AdHocAlertResultsItem":{"id":"components/schemas/AdHocAlertResultsItem","kind":"json-schema","title":"AdHocAlertResultsItem","data":{"type":"object","required":["alert","result"],"properties":{"alert":{"$ref":"#/components/schemas/AdHocAlertRequestItem"},"result":{"$ref":"#/components/schemas/AdHocAlertResultDetails"}}}},"components/schemas/AdHocAlertResultDetails":{"id":"components/schemas/AdHocAlertResultDetails","kind":"json-schema","title":"AdHocAlertResultDetails","data":{"type":"object","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/AlertResultStatusEnum"},"actualValue":{"description":"Value of the computed metric or its change.","type":"number","format":"double"},"currentRunValue":{"description":"Value of computed metric for current run. Present when alert is configured on metric change, not on single run metric value","type":"number","format":"double"},"previousRunValue":{"description":"Value of computed metric for previous run. Present when alert is configured on metric change, not on single run metric value","type":"number","format":"double"},"affectedPageCount":{"description":"Number of pages that are affected by triggered alert. Present when alert is triggered and metric type supports it","type":"integer"},"filteredPageCount":{"description":"Total number of pages that were used to compute alert.","type":"integer"}}}},"components/schemas/AlertResultStatusEnum":{"id":"components/schemas/AlertResultStatusEnum","kind":"json-schema","title":"AlertResultStatusEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All statuses except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRIGGERED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_TRIGGERED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" mean that alert/metric could not be computed. Statuses:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNKNOWN_ERROR: data retrieval or alert computation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RUN_NOT_FOUND: requested run not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_VALUE: no data found for requested run (e.g. rules or consent categories were not applied)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PREVIOUS_RUN_NOT_FOUND: previous run not found for run-over-run metric change alert"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PREVIOUS_RUN_NO_VALUE: no data found for previous run for run-over-run metric change alert"},"children":[]}]}]}]}],"enum":["TRIGGERED","NOT_TRIGGERED","UNKNOWN_ERROR","RUN_NOT_FOUND","NO_VALUE","PREVIOUS_RUN_NOT_FOUND","PREVIOUS_RUN_NO_VALUE"]}},"components/schemas/AlertId":{"id":"components/schemas/AlertId","kind":"json-schema","title":"AlertId","data":{"type":"integer","format":"int64"}},"components/schemas/LabelId":{"id":"components/schemas/LabelId","kind":"json-schema","title":"LabelId","data":{"type":"integer","format":"int64","description":"Label identifier","example":223,"minimum":1}},"components/schemas/CreateAlertRequestDTO":{"id":"components/schemas/CreateAlertRequestDTO","kind":"json-schema","title":"CreateAlertRequestDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alert is triggered when comparison holds: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <targetValueComparisonOperator> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetValue"},"children":[]}]}]}],"required":["name","metricType","targetValueComparator","filtersV0"],"properties":{"name":{"$ref":"#/components/schemas/AlertName"},"labels":{"type":"array","description":"Passing null instead of this array while updating an entity will prevent API from changing associated labels","items":{"$ref":"#/components/schemas/LabelId"}},"metricType":{"$ref":"#/components/schemas/AlertMetricTypeEnum"},"metricChangeType":{"$ref":"#/components/schemas/AlertMetricChangeTypeEnum"},"targetValueComparator":{"$ref":"#/components/schemas/AlertMetricValueComparator"},"filtersV0":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters to be applied before computing the alert. Exact type depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metricType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", see mapping in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlertMetricTypeToFilterMapping"},"children":[]}]}]}]},"emails":{"type":"array","description":"List of email addresses that receive notifications when alert triggers. Will be replaced with Notification Profiles","items":{"$ref":"#/components/schemas/EmailAddress"}},"customAlertMessage":{"type":"string"},"notificationPolicy":{"$ref":"#/components/schemas/AlertNotificationPolicyEnum"},"isDefaultForNewDataSources":{"$ref":"#/components/schemas/AlertIsDefaultForNewDataSources"},"assignments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passing null instead of this array while updating an alert will prevent API from changing its assignments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To pass only updates of assignments (additions/removals) for existing alert use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v3/alerts/{alertId}/target-items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AlertAssignmentItem"}},"skipSendingAlertSharedWithYouEmail":{"type":"boolean","description":"When TRUE, \"Alert shared with you\" email will NOT be sent to newly added email addresses.\nWhen NOT specified or FALSE, it will be sent.\n"}}}},"components/schemas/AlertIsDefaultForNewDataSources":{"id":"components/schemas/AlertIsDefaultForNewDataSources","kind":"json-schema","title":"AlertIsDefaultForNewDataSources","data":{"type":"boolean","description":"Makes this alert selected by default in data-source (audit/WJ) creation UI.\nThis is a user-specific flag.\n"}},"components/schemas/AlertNotificationPolicyEnum":{"id":"components/schemas/AlertNotificationPolicyEnum","kind":"json-schema","title":"AlertNotificationPolicyEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behaviour per type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WHEN_NEWLY_TRIGGERED: ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") send alert when goes from \"ok\" to \"triggered\" (resets when no longer triggered)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALWAYS_WHEN_TRIGGERED: send alert notification each time it is triggered per run"},"children":[]}]}]}]}],"enum":["WHEN_NEWLY_TRIGGERED","ALWAYS_WHEN_TRIGGERED"]}},"components/schemas/AlertAssignmentItem":{"id":"components/schemas/AlertAssignmentItem","kind":"json-schema","title":"AlertAssignmentItem","data":{"type":"object","required":["itemType","itemId"],"properties":{"itemType":{"$ref":"#/components/schemas/AlertAssignmentItemTypeEnum"},"itemId":{"$ref":"#/components/schemas/AlertAssignmentItemId"}}}},"components/schemas/AlertAssignmentItemTypeEnum":{"id":"components/schemas/AlertAssignmentItemTypeEnum","kind":"json-schema","title":"AlertAssignmentItemTypeEnum","data":{"type":"string","enum":["AUDIT","WEB_JOURNEY"]}},"components/schemas/AlertAssignmentItemId":{"id":"components/schemas/AlertAssignmentItemId","kind":"json-schema","title":"AlertAssignmentItemId","data":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the item that can have assigned Alert(s) onto it. See also "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlertAssignmentTypeEnum"},"children":[]}]}]}]}},"components/schemas/CreateAlertResponseDTO":{"id":"components/schemas/CreateAlertResponseDTO","kind":"json-schema","title":"CreateAlertResponseDTO","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AlertId"}}}},"components/schemas/GetAlertDefinitionResponseDTO":{"id":"components/schemas/GetAlertDefinitionResponseDTO","kind":"json-schema","title":"GetAlertDefinitionResponseDTO","data":{"allOf":[{"$ref":"#/components/schemas/AlertConfigTrait"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alert is triggered when comparison holds: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <targetValueComparisonOperator> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetValue"},"children":[]}]}]}],"required":["id","labels","emails","notificationPolicy","isDefaultForNewDataSources"],"properties":{"id":{"$ref":"#/components/schemas/AlertId"},"labels":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/LabelId"}},"emails":{"type":"array","description":"List of email addresses that receive notifications when alert triggers. Will be replaced with Notification Profiles","minItems":0,"items":{"$ref":"#/components/schemas/EmailAddress"}},"customAlertMessage":{"type":"string"},"notificationPolicy":{"$ref":"#/components/schemas/AlertNotificationPolicyEnum"},"isDefaultForNewDataSources":{"$ref":"#/components/schemas/AlertIsDefaultForNewDataSources"}}}]}},"components/schemas/GetAlertsLibraryRequestDTO":{"id":"components/schemas/GetAlertsLibraryRequestDTO","kind":"json-schema","title":"GetAlertsLibraryRequestDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All filters are optional. All populated filters are combined via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" boolean operator"},"children":[]}]}]}],"properties":{"alertName":{"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when present works as \"alert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains give substring` filter"},"children":[]}]}]}]},"metricType":{"$ref":"#/components/schemas/AlertMetricTypeEnum"},"labels":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"createdByUserId":{"$ref":"#/components/schemas/UserId"},"isSubscribed":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then only those alerts will be returned that have Notification Profile of a requestor user assigned onto them"},"children":[]}]}]}]}}}},"components/schemas/GetAlertsLibrarySortColumn":{"id":"components/schemas/GetAlertsLibrarySortColumn","kind":"json-schema","title":"GetAlertsLibrarySortColumn","data":{"type":"string","enum":["ALERT_NAME","TARGET_ITEMS","REPORT_METRIC","UPDATED_AT","SUBSCRIBERS"]}},"components/schemas/GetAlertsLibraryResponseDTO":{"id":"components/schemas/GetAlertsLibraryResponseDTO","kind":"json-schema","title":"GetAlertsLibraryResponseDTO","data":{"type":"object","required":["metadata","alerts"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"alerts":{"type":"array","items":{"title":"GetAlertsLibraryItem","type":"object","required":["id","name","metricType","labels","updatedAt","targetItemCount","subscribedCount","isOwner"],"properties":{"id":{"$ref":"#/components/schemas/AlertId"},"name":{"$ref":"#/components/schemas/AlertName"},"metricType":{"$ref":"#/components/schemas/AlertMetricTypeEnum"},"labels":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/LabelId"}},"updatedAt":{"$ref":"#/components/schemas/DateAndTime"},"targetItemCount":{"type":"integer","description":"Number of audits/journeys that have this alert configured"},"subscribedCount":{"type":"integer","description":"Number of notification profiles configured for this alert"},"isOwner":{"type":"boolean","description":"Indicates whether the current user is the owner of this alert"}}}}}}},"components/schemas/GetAlertsByMetricSortColumn":{"id":"components/schemas/GetAlertsByMetricSortColumn","kind":"json-schema","title":"GetAlertsByMetricSortColumn","data":{"type":"string","enum":["ALERT_NAME","SUBSCRIBERS"]}},"components/schemas/GetAlertsByMetricResponseDTO":{"id":"components/schemas/GetAlertsByMetricResponseDTO","kind":"json-schema","title":"GetAlertsByMetricResponseDTO","data":{"type":"object","required":["metadata","alerts"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/GetAlertsByMetricItem"}}}}},"components/schemas/GetAlertsByMetricItem":{"id":"components/schemas/GetAlertsByMetricItem","kind":"json-schema","title":"GetAlertsByMetricItem","data":{"allOf":[{"$ref":"#/components/schemas/AlertConfigTrait"},{"type":"object","required":["id","emails"],"properties":{"id":{"$ref":"#/components/schemas/AlertId"},"emails":{"type":"array","description":"List of email addresses that receive notifications when alert triggers. Will be replaced with Notification Profiles","minItems":0,"items":{"$ref":"#/components/schemas/EmailAddress"}}}}]}},"components/schemas/AlertConfigTrait":{"id":"components/schemas/AlertConfigTrait","kind":"json-schema","title":"AlertConfigTrait","data":{"description":"Core parts of alert definition","type":"object","required":["name","metricType","targetValueComparator","filtersV0"],"properties":{"name":{"$ref":"#/components/schemas/AlertName"},"metricType":{"$ref":"#/components/schemas/AlertMetricTypeEnum"},"metricChangeType":{"$ref":"#/components/schemas/AlertMetricChangeTypeEnum"},"targetValueComparator":{"$ref":"#/components/schemas/AlertMetricValueComparator"},"filtersV0":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters to be applied before computing the alert. Exact type depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metricType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", see mapping in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlertMetricTypeToFilterMapping"},"children":[]}]}]}]}}}},"components/schemas/SearchAlertAssignmentsRequestDTO":{"id":"components/schemas/SearchAlertAssignmentsRequestDTO","kind":"json-schema","title":"SearchAlertAssignmentsRequestDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for searching for items that may have specific Alert assigned or not assigned."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alertId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAssigned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in response object will be set to true"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for items already assigned to alert with the specified ID"},"children":[]}]}]}]}],"properties":{"alertId":{"$ref":"#/components/schemas/AlertId"},"assignedToAlert":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alertId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is NOT specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignedToAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alertId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" IS specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignedToAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has 3 states:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when TRUE - only items assigned to the specified alert will be returned;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when FALSE - only NOT assigned;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when NOT specified or NULL - both assigned and not assigned items will be returned"},"children":[]}]}]}]},"itemName":{"type":"string","minLength":1,"description":"optional \"item name contains substring\" filter"},"itemId":{"$ref":"#/components/schemas/AlertAssignmentItemId"},"itemLabels":{"type":"array","description":"non-empty array of labels present on an item, works as \"item has all specified labels\" filter","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"folders":{"$ref":"#/components/schemas/FoldersFilter"}}}},"components/schemas/SearchAlertAssignmentsResponseDTO":{"id":"components/schemas/SearchAlertAssignmentsResponseDTO","kind":"json-schema","title":"SearchAlertAssignmentsResponseDTO","data":{"type":"object","required":["metadata","items"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"items":{"type":"array","items":{"title":"AlertAssignmentItem","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemLastRunAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property available only for audits and web-journeys."},"children":[]}]}]}],"required":["isAssigned","itemType","itemId","itemName"],"properties":{"isAssigned":{"type":"boolean","description":"TRUE if Alert is assigned to this item, FALSE otherwise"},"itemType":{"$ref":"#/components/schemas/AlertAssignmentItemTypeEnum"},"itemId":{"$ref":"#/components/schemas/AlertAssignmentItemId"},"itemName":{"type":"string","description":"Name of audit/WJ etc"},"itemLastRunAt":{"$ref":"#/components/schemas/DateAndTime"},"itemLabels":{"description":"may be absent if item does not support labels","type":"array","minItems":0,"items":{"$ref":"#/components/schemas/LabelId"}}}}}}}},"components/schemas/AlertAssignmentsSortColumn":{"id":"components/schemas/AlertAssignmentsSortColumn","kind":"json-schema","title":"AlertAssignmentsSortColumn","data":{"type":"string","enum":["IS_ASSIGNED","ITEM_NAME","RUN_DATE"]}},"components/schemas/SearchAlertsForAssignmentRequestDTO":{"id":"components/schemas/SearchAlertsForAssignmentRequestDTO","kind":"json-schema","title":"SearchAlertsForAssignmentRequestDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All included filters are optional. All populated filters are combined via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" boolean operator"},"children":[]}]}]}],"properties":{"targetItem":{"title":"SearchAlertsForAssignmentSpecificTargetItem","description":"Item (audit/journey) alerts are assigned or not assigned to","type":"object","required":["itemType","itemId","isAssigned"],"properties":{"itemType":{"$ref":"#/components/schemas/AlertAssignmentItemTypeEnum"},"itemId":{"$ref":"#/components/schemas/AlertAssignmentItemId"},"isAssigned":{"type":"boolean","description":"When TRUE it works as \"alert IS assigned to specified target item (audit/journey)\" and if false \"alert IS NOT assigned to specified target item"}}},"search":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When value is present it works as \"alert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains given substring\" filter"},"children":[]}]}]}]},"labels":{"type":"array","description":"non-empty array of labels present on an alert, works as \"alert has all specified labels\" filter","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"isDefaultForNewDataSources":{"$ref":"#/components/schemas/AlertIsDefaultForNewDataSources"}}}},"components/schemas/SearchAlertsForAssignmentResponseDTO":{"id":"components/schemas/SearchAlertsForAssignmentResponseDTO","kind":"json-schema","title":"SearchAlertsForAssignmentResponseDTO","data":{"type":"object","required":["metadata","alerts"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"alerts":{"type":"array","minItems":0,"items":{"title":"SearchAlertsForAssignmentAlertItem","type":"object","required":["id","name","metricType","labels"],"properties":{"id":{"$ref":"#/components/schemas/AlertId"},"name":{"$ref":"#/components/schemas/AlertName"},"metricType":{"$ref":"#/components/schemas/AlertMetricTypeEnum"},"labels":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/LabelId"}}}}}}}},"components/schemas/SearchAlertsForAssignmentSortColumn":{"id":"components/schemas/SearchAlertsForAssignmentSortColumn","kind":"json-schema","title":"SearchAlertsForAssignmentSortColumn","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behaviour per type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPORT_METRIC: sort by name of data/report type corresponding to alert's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metricType"},"children":[]}]}]}]}],"enum":["ALERT_NAME","REPORT_METRIC"]}},"components/schemas/UpdateSpecificItemAlertsRequestDTO":{"id":"components/schemas/UpdateSpecificItemAlertsRequestDTO","kind":"json-schema","title":"UpdateSpecificItemAlertsRequestDTO","data":{"type":"object","required":["assignmentUpdates"],"properties":{"assignmentUpdates":{"type":"array","items":{"title":"UpdateSpecificItemAlertAssignments_Item","type":"object","required":["alertId","operation"],"properties":{"alertId":{"$ref":"#/components/schemas/AlertId"},"operation":{"$ref":"#/components/schemas/AlertAssignmentUpdateOperationTypeEnum"}}}}}}},"components/schemas/UpdateSpecificAlertAssignmentsRequestDTO":{"id":"components/schemas/UpdateSpecificAlertAssignmentsRequestDTO","kind":"json-schema","title":"UpdateSpecificAlertAssignmentsRequestDTO","data":{"type":"object","required":["assignmentUpdates"],"properties":{"assignmentUpdates":{"type":"array","items":{"title":"UpdateSpecificAlertAssignments_Item","type":"object","required":["scope","itemType","itemId","operation"],"properties":{"scope":{"description":"For forward-compatibility","type":"string","enum":["SINGLE_ITEM"]},"itemType":{"$ref":"#/components/schemas/AlertAssignmentItemTypeEnum"},"itemId":{"$ref":"#/components/schemas/AlertAssignmentItemId"},"operation":{"$ref":"#/components/schemas/AlertAssignmentUpdateOperationTypeEnum"}}}}}}},"components/schemas/AlertAssignmentUpdateOperationTypeEnum":{"id":"components/schemas/AlertAssignmentUpdateOperationTypeEnum","kind":"json-schema","title":"AlertAssignmentUpdateOperationTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning by type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASSIGN: add (if not exist) or update (if already exists) alert assignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNASSIGN: remove alert assignment. Does nothing if assignment does not exist"},"children":[]}]}]}]}],"enum":["ASSIGN","UNASSIGN"]}},"components/schemas/AccountUsageV2_RequestDTO":{"id":"components/schemas/AccountUsageV2_RequestDTO","kind":"json-schema","title":"AccountUsageV2_RequestDTO","data":{"type":"object","description":"Filters for usage report","properties":{"dataSources":{"type":"array","description":"Non-empty array of data sources. Usage for selected data sources only will be shown","minItems":1,"items":{"$ref":"#/components/schemas/ItemId"}},"dataSourceCreators":{"type":"array","description":"Non-empty array of user IDs. Matches data sources that have been created by any of the specified users","minItems":1,"items":{"$ref":"#/components/schemas/UserId"}},"dataSourceFolders":{"$ref":"#/components/schemas/FoldersFilter"},"dataSourceLabels":{"type":"array","description":"Non-empty array of labels present on an item. Matches data sources that have all specified labels","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"runFrequencies":{"type":"array","description":"Non-empty array of frequency names. Matches data sources that have any of the specified frequencies","minItems":1,"items":{"$ref":"#/components/schemas/AccountUsageV2_RunFrequency"}},"contractTerm":{"$ref":"#/components/schemas/AccountUsageV2_ContractTermFilter"}}}},"components/schemas/AccountUsageV2_ExportRequestDTO":{"id":"components/schemas/AccountUsageV2_ExportRequestDTO","kind":"json-schema","title":"AccountUsageV2_ExportRequestDTO","data":{"description":"Filters for usage report exports","allOf":[{"$ref":"#/components/schemas/AccountUsageV2_RequestDTO"},{"type":"object","properties":{"runDateRange":{"$ref":"#/components/schemas/AccountUsageV2_RunDateRangeFilter"}}}]}},"components/schemas/AccountUsageV2_RunDateRangeFilter":{"id":"components/schemas/AccountUsageV2_RunDateRangeFilter","kind":"json-schema","title":"AccountUsageV2_RunDateRangeFilter","data":{"type":"object","required":["startDateInclusive","endDateExclusive"],"properties":{"startDateInclusive":{"$ref":"#/components/schemas/DateUtc"},"endDateExclusive":{"$ref":"#/components/schemas/DateUtc"}}}},"components/schemas/AccountUsageV2_DataSourcesFilterItem":{"id":"components/schemas/AccountUsageV2_DataSourcesFilterItem","kind":"json-schema","title":"AccountUsageV2_DataSourcesFilterItem","data":{"type":"object","required":["itemType","itemId"],"properties":{"itemType":{"$ref":"#/components/schemas/AccountUsageV2_ItemTypeEnum"},"itemId":{"$ref":"#/components/schemas/ItemId"}}}},"components/schemas/AccountUsageV2_ContractTermFilter":{"id":"components/schemas/AccountUsageV2_ContractTermFilter","kind":"json-schema","title":"AccountUsageV2_ContractTermFilter","data":{"type":"object","description":"Select specific contract term. Current term will be shown if omitted","required":["startDateInclusive","endDateInclusive"],"properties":{"startDateInclusive":{"$ref":"#/components/schemas/DateUtc"},"endDateInclusive":{"$ref":"#/components/schemas/DateUtc"}}}},"components/schemas/AccountUsageV2_Overview_ResponseDTO":{"id":"components/schemas/AccountUsageV2_Overview_ResponseDTO","kind":"json-schema","title":"AccountUsageV2_Overview_ResponseDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webJourneyUsage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be absent if web journeys are not included in contract."},"children":[]}]}]}],"required":["auditUsage","allowOverages"],"properties":{"auditUsage":{"$ref":"#/components/schemas/AccountUsageV2_Overview_SpecificItemTypeUsage"},"webJourneyUsage":{"$ref":"#/components/schemas/AccountUsageV2_Overview_SpecificItemTypeUsage"},"allowOverages":{"$ref":"#/components/schemas/AccountUsageV2_AllowOveragesFlag"}}}},"components/schemas/AccountUsageV2_Overview_SpecificItemTypeUsage":{"id":"components/schemas/AccountUsageV2_Overview_SpecificItemTypeUsage","kind":"json-schema","title":"AccountUsageV2_Overview_SpecificItemTypeUsage","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usagePercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be omitted if there is no limit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overLimitPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only visible to account admins."},"children":[]}]}]}],"required":["currentContractTerm","usageCount"],"properties":{"usageCount":{"type":"integer","format":"integer","description":"Number of pages scanned (for audits) or runs completed (for web journeys) to date"},"usageLimit":{"type":"integer","format":"integer","description":"Limit of pages scanned (for audits) or runs completed (for web journeys) for the current contract term"},"limitNoteType":{"$ref":"#/components/schemas/AccountUsageV2_LimitNoteTypeEnum"},"usagePercentage":{"type":"number","format":"float","description":"Percentage of usage relative to contract term limit"},"overLimitPrice":{"$ref":"#/components/schemas/AccountUsageV2_OverLimitPrice"},"currentContractTerm":{"$ref":"#/components/schemas/AccountUsageV2_ContractTerm"}}}},"components/schemas/AccountUsageV2_Summary_ResponseDTO":{"id":"components/schemas/AccountUsageV2_Summary_ResponseDTO","kind":"json-schema","title":"AccountUsageV2_Summary_ResponseDTO","data":{"type":"object","required":["usersUsage","contacts","allowOverages"],"properties":{"usersUsage":{"$ref":"#/components/schemas/AccountUsageV2_Summary_UsersUsage"},"contacts":{"type":"array","description":"List of people to contact for support","minItems":0,"items":{"$ref":"#/components/schemas/AccountUsageV2_Summary_SupportContact"}},"allowOverages":{"$ref":"#/components/schemas/AccountUsageV2_AllowOveragesFlag"}}}},"components/schemas/AccountUsageV2_Summary_SupportContact":{"id":"components/schemas/AccountUsageV2_Summary_SupportContact","kind":"json-schema","title":"AccountUsageV2_Summary_SupportContact","data":{"type":"object","required":["type","name","email"],"properties":{"type":{"$ref":"#/components/schemas/AccountUsageV2_Summary_SupportContactType"},"name":{"type":"string","description":"Name of the person to contact"},"email":{"type":"string"}}}},"components/schemas/AccountUsageV2_Summary_SupportContactType":{"id":"components/schemas/AccountUsageV2_Summary_SupportContactType","kind":"json-schema","title":"AccountUsageV2_Summary_SupportContactType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Account Executive"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CSM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Customer Success Manager"},"children":[]}]}]}],"enum":["AE","CSM"]}},"components/schemas/AccountUsageV2_Summary_UsersUsage":{"id":"components/schemas/AccountUsageV2_Summary_UsersUsage","kind":"json-schema","title":"AccountUsageV2_Summary_UsersUsage","data":{"type":"object","required":["totalUsers","usersLoggedInLast30Days"],"properties":{"totalUsers":{"description":"Number of users in account","type":"integer"},"usersLoggedInLast30Days":{"type":"array","description":"List of user IDs that logged in last 30 days","items":{"$ref":"#/components/schemas/UserId"}}}}},"components/schemas/AccountUsageV2_SpecificItemTypeSummary_ResponseDTO":{"id":"components/schemas/AccountUsageV2_SpecificItemTypeSummary_ResponseDTO","kind":"json-schema","title":"AccountUsageV2_SpecificItemTypeSummary_ResponseDTO","data":{"type":"object","required":["currentContractTerm","contractTerms","usage"],"properties":{"currentContractTerm":{"$ref":"#/components/schemas/AccountUsageV2_ContractTerm"},"contractTerms":{"type":"array","description":"Dates of contracts","minItems":0,"items":{"$ref":"#/components/schemas/AccountUsageV2_ContractTerm"}},"usage":{"$ref":"#/components/schemas/AccountUsageV2_SpecificItemTypeSummary_BaseUsage"}}}},"components/schemas/AccountUsageV2_SpecificItemTypeSummary_AuditUsage":{"id":"components/schemas/AccountUsageV2_SpecificItemTypeSummary_AuditUsage","kind":"json-schema","title":"AccountUsageV2_SpecificItemTypeSummary_AuditUsage","data":{"x-discriminator-value":"AUDIT","allOf":[{"$ref":"#/components/schemas/AccountUsageV2_SpecificItemTypeSummary_BaseUsage"}]}},"components/schemas/AccountUsageV2_SpecificItemTypeSummary_WebJourneyUsage":{"id":"components/schemas/AccountUsageV2_SpecificItemTypeSummary_WebJourneyUsage","kind":"json-schema","title":"AccountUsageV2_SpecificItemTypeSummary_WebJourneyUsage","data":{"x-discriminator-value":"WEB_JOURNEY","allOf":[{"$ref":"#/components/schemas/AccountUsageV2_SpecificItemTypeSummary_BaseUsage"},{"type":"object","required":["supportUsage"],"properties":{"supportUsage":{"$ref":"#/components/schemas/AccountUsageV2_SpecificItemTypeSummary_WebJourneySupportUsage"}}}]}},"components/schemas/AccountUsageV2_SpecificItemTypeSummary_WebJourneySupportUsage":{"id":"components/schemas/AccountUsageV2_SpecificItemTypeSummary_WebJourneySupportUsage","kind":"json-schema","title":"AccountUsageV2_SpecificItemTypeSummary_WebJourneySupportUsage","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxMonitoredWebJourneys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remainingWebJourneySupportRequests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be omitted if there is no limit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currentlyMonitoredWebJourneys#filtered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is no longer in use and will be omitted"},"children":[]}]}]}],"required":["currentlyMonitoredWebJourneys"],"properties":{"currentlyMonitoredWebJourneys":{"$ref":"#/components/schemas/AccountUsageV2_FilterableInteger"},"maxMonitoredWebJourneys":{"type":"integer"},"remainingWebJourneySupportRequests":{"type":"integer"}}}},"components/schemas/AccountUsageV2_SpecificItemTypeSummary_BaseUsage":{"id":"components/schemas/AccountUsageV2_SpecificItemTypeSummary_BaseUsage","kind":"json-schema","title":"AccountUsageV2_SpecificItemTypeSummary_BaseUsage","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subtypes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AccountUsageV2_SpecificItemTypeSummary_AuditUsage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AccountUsageV2_SpecificItemTypeSummary_WebJourneyUsage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cumulativeTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - number of pages scanned (for audits) or runs completed (for web journeys) to date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cumulativePacing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be omitted if there is no limit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overLimitPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only visible to account admins."},"children":[]}]}]}],"required":["itemType","cumulativeTotal"],"properties":{"itemType":{"$ref":"#/components/schemas/AccountUsageV2_ItemTypeEnum"},"cumulativeTotal":{"$ref":"#/components/schemas/AccountUsageV2_FilterableInteger"},"termLimit":{"$ref":"#/components/schemas/AccountUsageV2_TermLimit"},"limitNoteType":{"$ref":"#/components/schemas/AccountUsageV2_LimitNoteTypeEnum"},"cumulativePacing":{"$ref":"#/components/schemas/AccountUsageV2_CumulativePacing"},"overLimitPrice":{"$ref":"#/components/schemas/AccountUsageV2_OverLimitPrice"}},"discriminator":{"propertyName":"itemType","mapping":{"AUDIT":"#/components/schemas/AccountUsageV2_SpecificItemTypeSummary_AuditUsage","WEB_JOURNEY":"#/components/schemas/AccountUsageV2_SpecificItemTypeSummary_WebJourneyUsage"}}}},"components/schemas/AccountUsageV2_Trends_ResponseDTO":{"id":"components/schemas/AccountUsageV2_Trends_ResponseDTO","kind":"json-schema","title":"AccountUsageV2_Trends_ResponseDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthlyPacing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be omitted if there is no limit"},"children":[]}]}]}],"required":["pastPeriods","futurePeriods"],"properties":{"pastPeriods":{"type":"array","description":"Represents all past months","items":{"$ref":"#/components/schemas/AccountUsageV2_Trends_PastPeriod"}},"currentPeriod":{"$ref":"#/components/schemas/AccountUsageV2_Trends_CurrentPeriod"},"futurePeriods":{"type":"array","description":"Represents future months, with projected values","items":{"$ref":"#/components/schemas/AccountUsageV2_Trends_FuturePeriod"}},"termLimit":{"$ref":"#/components/schemas/AccountUsageV2_TermLimit"},"limitNoteType":{"$ref":"#/components/schemas/AccountUsageV2_LimitNoteTypeEnum"},"monthlyPacing":{"$ref":"#/components/schemas/AccountUsageV2_MonthlyPacing"}}}},"components/schemas/AccountUsageV2_Trends_PastPeriod":{"id":"components/schemas/AccountUsageV2_Trends_PastPeriod","kind":"json-schema","title":"AccountUsageV2_Trends_PastPeriod","data":{"allOf":[{"$ref":"#/components/schemas/AccountUsageV2_Trends_BasePeriodTrait"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cumulativeTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can represent either pages scanned (for audits) or runs completed (for web journeys)"},"children":[]}]}]}],"required":["periodTotal","cumulativeTotal"],"properties":{"periodTotal":{"$ref":"#/components/schemas/AccountUsageV2_FilterableInteger"},"cumulativeTotal":{"$ref":"#/components/schemas/AccountUsageV2_FilterableInteger"}}}]}},"components/schemas/AccountUsageV2_Trends_FuturePeriod":{"id":"components/schemas/AccountUsageV2_Trends_FuturePeriod","kind":"json-schema","title":"AccountUsageV2_Trends_FuturePeriod","data":{"allOf":[{"$ref":"#/components/schemas/AccountUsageV2_Trends_BasePeriodTrait"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodProjectedTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cumulativeProjectedTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can represent either pages scanned (for audits) or runs completed (for web journeys)"},"children":[]}]}]}],"required":["periodProjectedTotal","cumulativeProjectedTotal"],"properties":{"periodProjectedTotal":{"$ref":"#/components/schemas/AccountUsageV2_FilterableProjectedUsage"},"cumulativeProjectedTotal":{"$ref":"#/components/schemas/AccountUsageV2_FilterableProjectedUsage"}}}]}},"components/schemas/AccountUsageV2_Trends_CurrentPeriod":{"id":"components/schemas/AccountUsageV2_Trends_CurrentPeriod","kind":"json-schema","title":"AccountUsageV2_Trends_CurrentPeriod","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cumulativeTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calculated for completed runs in current period, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodProjectedTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cumulativeProjectedTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" estimated for future runs"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/AccountUsageV2_Trends_PastPeriod"},{"$ref":"#/components/schemas/AccountUsageV2_Trends_FuturePeriod"}]}},"components/schemas/AccountUsageV2_Trends_BasePeriodTrait":{"id":"components/schemas/AccountUsageV2_Trends_BasePeriodTrait","kind":"json-schema","title":"AccountUsageV2_Trends_BasePeriodTrait","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDateInclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateExclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" define period of time for which usage is shown"},"children":[]}]}]}],"required":["startDateInclusive","endDateExclusive"],"properties":{"startDateInclusive":{"$ref":"#/components/schemas/DateUtc"},"endDateExclusive":{"$ref":"#/components/schemas/DateUtc"}}}},"components/schemas/AccountUsageV2_DailyTrends_ResponseDTO":{"id":"components/schemas/AccountUsageV2_DailyTrends_ResponseDTO","kind":"json-schema","title":"AccountUsageV2_DailyTrends_ResponseDTO","data":{"type":"object","required":["dailyUsageItems"],"properties":{"dailyUsageItems":{"type":"array","description":"Runs completed per day in the last 3 days, today and scheduled in the next 3 days","items":{"$ref":"#/components/schemas/AccountUsageV2_DailyTrends_Usage"}}}}},"components/schemas/AccountUsageV2_DailyTrends_Usage":{"id":"components/schemas/AccountUsageV2_DailyTrends_Usage","kind":"json-schema","title":"AccountUsageV2_DailyTrends_Usage","data":{"type":"object","description":"Scheduled items are shown only for today and dates in the future","required":["day"],"properties":{"day":{"$ref":"#/components/schemas/DateUtc"},"noOfCompletedRuns":{"type":"integer"},"noOfScheduledRuns":{"type":"integer"},"completedItems":{"type":"array","description":"100 items per day in the account","maxItems":100,"items":{"$ref":"#/components/schemas/AccountUsageV2_DailyTrends_ItemInfoWithRunDetails"}},"scheduledItems":{"type":"array","description":"100 items per day in the account","maxItems":100,"items":{"$ref":"#/components/schemas/AccountUsageV2_DailyTrends_ScheduledItemInfoWithRunDetails"}},"noOfPagesScanned":{"description":"used for Audits only","type":"integer"},"noOfPagesScheduledToScan":{"description":"used for Audits only","type":"integer"}}}},"components/schemas/AccountUsageV2_DailyTrends_ItemInfoWithRunDetails":{"id":"components/schemas/AccountUsageV2_DailyTrends_ItemInfoWithRunDetails","kind":"json-schema","title":"AccountUsageV2_DailyTrends_ItemInfoWithRunDetails","data":{"allOf":[{"$ref":"#/components/schemas/AccountUsageV2_DailyTrends_ItemInfo"},{"type":"object","properties":{"lastRunId":{"$ref":"#/components/schemas/RunId"},"lastRunCompletedAt":{"$ref":"#/components/schemas/DateAndTime"},"noOfRunsCompleted":{"type":"integer"}}}]}},"components/schemas/AccountUsageV2_DailyTrends_ScheduledItemInfoWithRunDetails":{"id":"components/schemas/AccountUsageV2_DailyTrends_ScheduledItemInfoWithRunDetails","kind":"json-schema","title":"AccountUsageV2_DailyTrends_ScheduledItemInfoWithRunDetails","data":{"allOf":[{"$ref":"#/components/schemas/AccountUsageV2_DailyTrends_ItemInfo"},{"type":"object","properties":{"nextScheduledRunDateTime":{"$ref":"#/components/schemas/DateAndTime"},"noOfRunsScheduled":{"type":"integer"},"noOfPagesScheduledToScan":{"type":"integer"}}}]}},"components/schemas/AccountUsageV2_DailyTrends_ItemInfo":{"id":"components/schemas/AccountUsageV2_DailyTrends_ItemInfo","kind":"json-schema","title":"AccountUsageV2_DailyTrends_ItemInfo","data":{"type":"object","required":["frequency","itemName","itemId"],"properties":{"frequency":{"$ref":"#/components/schemas/AccountUsageV2_RunFrequency"},"description":{"description":"Schedule description or value of frequency if no schedule is present","type":"string"},"itemName":{"description":"Audit name or Web Journey name","type":"string"},"itemId":{"description":"Audit ID or Web Journey ID","type":"integer"}}}},"components/schemas/AccountUsageV2_FilterableInteger":{"id":"components/schemas/AccountUsageV2_FilterableInteger","kind":"json-schema","title":"AccountUsageV2_FilterableInteger","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filtered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property can be omitted if filters were not applied"},"children":[]}]}]}],"required":["total"],"properties":{"total":{"type":"integer"},"filtered":{"type":"integer"}}}},"components/schemas/AccountUsageV2_ProjectedUsage":{"id":"components/schemas/AccountUsageV2_ProjectedUsage","kind":"json-schema","title":"AccountUsageV2_ProjectedUsage","data":{"type":"object","required":["scheduledUsageEstimate","historicalUsageEstimate"],"properties":{"scheduledUsageEstimate":{"description":"Based on scheduled runs","type":"integer"},"historicalUsageEstimate":{"description":"Based on historical averages","type":"integer"}}}},"components/schemas/AccountUsageV2_FilterableProjectedUsage":{"id":"components/schemas/AccountUsageV2_FilterableProjectedUsage","kind":"json-schema","title":"AccountUsageV2_FilterableProjectedUsage","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicates "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountUsageV2_ProjectedUsage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filtered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values for each estimate"},"children":[]}]}]}],"required":["scheduledUsageEstimate","historicalUsageEstimate"],"properties":{"scheduledUsageEstimate":{"$ref":"#/components/schemas/AccountUsageV2_FilterableInteger"},"historicalUsageEstimate":{"$ref":"#/components/schemas/AccountUsageV2_FilterableInteger"}}}},"components/schemas/AccountUsageV2_ItemTypeEnum":{"id":"components/schemas/AccountUsageV2_ItemTypeEnum","kind":"json-schema","title":"AccountUsageV2_ItemTypeEnum","data":{"type":"string","enum":["AUDIT","WEB_JOURNEY"]}},"components/schemas/AccountUsageV2_TermLimit":{"id":"components/schemas/AccountUsageV2_TermLimit","kind":"json-schema","title":"AccountUsageV2_TermLimit","data":{"type":"integer","description":"Limit of pages scanned (for audits) or runs completed (for web journeys) for the contract term"}},"components/schemas/AccountUsageV2_LimitNoteTypeEnum":{"id":"components/schemas/AccountUsageV2_LimitNoteTypeEnum","kind":"json-schema","title":"AccountUsageV2_LimitNoteTypeEnum","data":{"type":"string","enum":["UNLIMITED","LIMIT_UNDETERMINED"]}},"components/schemas/AccountUsageV2_CumulativePacing":{"id":"components/schemas/AccountUsageV2_CumulativePacing","kind":"json-schema","title":"AccountUsageV2_CumulativePacing","data":{"type":"integer","description":"Shows how many pages should be scanned to date to hit the limit by the end of the contract term"}},"components/schemas/AccountUsageV2_MonthlyPacing":{"id":"components/schemas/AccountUsageV2_MonthlyPacing","kind":"json-schema","title":"AccountUsageV2_MonthlyPacing","data":{"type":"integer","description":"Shows how many pages should be scanned per month to hit the limit by the end of the contract term"}},"components/schemas/AccountUsageV2_OverLimitPrice":{"id":"components/schemas/AccountUsageV2_OverLimitPrice","kind":"json-schema","title":"AccountUsageV2_OverLimitPrice","data":{"description":"Price of a page scan (for audits) or a run (for web journeys) over the limit","allOf":[{"$ref":"#/components/schemas/MonetaryAmount"}]}},"components/schemas/AccountUsageV2_AllowOveragesFlag":{"id":"components/schemas/AccountUsageV2_AllowOveragesFlag","kind":"json-schema","title":"AccountUsageV2_AllowOveragesFlag","data":{"type":"boolean","description":"When TRUE, account is allowed to go over the limit and will be charged for overages.\nWhen FALSE, account will be blocked from running audits and web journeys that will go over the limit.\n"}},"components/schemas/AccountUsageV2_ContractTerm":{"id":"components/schemas/AccountUsageV2_ContractTerm","kind":"json-schema","title":"AccountUsageV2_ContractTerm","data":{"type":"object","description":"Contract start and end dates","required":["startDateInclusive","endDateInclusive"],"properties":{"startDateInclusive":{"$ref":"#/components/schemas/DateUtc"},"endDateInclusive":{"$ref":"#/components/schemas/DateUtc"}}}},"components/schemas/AccountUsageV2_RunFrequency":{"id":"components/schemas/AccountUsageV2_RunFrequency","kind":"json-schema","title":"AccountUsageV2_RunFrequency","data":{"type":"string","description":"combination of journey and audit frequency","enum":["paused","once","15 minutes","1 hour","6 hours","12 hours","daily","weekly","biweekly","monthly","quarterly","semiannually","yearly","custom","unscheduled"]}},"components/schemas/NotificationCenter_GetEmails_RequestDTO":{"id":"components/schemas/NotificationCenter_GetEmails_RequestDTO","kind":"json-schema","title":"NotificationCenter_GetEmails_RequestDTO","data":{"type":"object","description":"Filters for searching for emails","required":["itemType","itemIds"],"properties":{"itemType":{"$ref":"#/components/schemas/NotificationCenter_EmailSubscriptionItemTypeEnum"},"itemIds":{"type":"array","description":"Non-empty array of item IDs. Emails for selected items only will be shown","minItems":1,"items":{"$ref":"#/components/schemas/ItemId"}}}}},"components/schemas/NotificationCenter_EmailSubscriptionItemTypeEnum":{"id":"components/schemas/NotificationCenter_EmailSubscriptionItemTypeEnum","kind":"json-schema","title":"NotificationCenter_EmailSubscriptionItemTypeEnum","data":{"type":"string","enum":["AUDIT"]}},"components/schemas/NotificationCenter_GetEmails_ResponseDTO":{"id":"components/schemas/NotificationCenter_GetEmails_ResponseDTO","kind":"json-schema","title":"NotificationCenter_GetEmails_ResponseDTO","data":{"type":"object","description":"All emails in an account","required":["emails"],"properties":{"emails":{"type":"array","minItems":0,"items":{"title":"NotificationCenter_EmailItem","type":"object","required":["email","usage"],"properties":{"email":{"type":"string"},"usage":{"$ref":"#/components/schemas/NotificationCenter_EmailUsage"}}}}}}},"components/schemas/NotificationCenter_EmailUsage":{"id":"components/schemas/NotificationCenter_EmailUsage","kind":"json-schema","title":"NotificationCenter_EmailUsage","data":{"type":"object","required":["auditCount","webJourneyCount","ruleCount","alertCount","emailInboxMessageReceivedCount","emailInboxMessageProcessedCount"],"properties":{"auditCount":{"type":"integer"},"webJourneyCount":{"type":"integer"},"ruleCount":{"type":"integer"},"alertCount":{"type":"integer","description":"Number of alerts excluding usage alerts"},"usageAlertCount":{"type":"integer"},"emailInboxMessageReceivedCount":{"type":"integer"},"emailInboxMessageProcessedCount":{"type":"integer"},"scheduledExportCount":{"type":"integer"}}}},"components/schemas/NotificationCenter_SearchForAssignments_RequestDTO":{"id":"components/schemas/NotificationCenter_SearchForAssignments_RequestDTO","kind":"json-schema","title":"NotificationCenter_SearchForAssignments_RequestDTO","data":{"type":"object","description":"Filters for searching for items that may have specific email assigned or not assigned","required":["email"],"properties":{"email":{"type":"string","minLength":1,"description":"email to search for"},"itemName":{"type":"string","minLength":1,"description":"optional \"item name contains substring\" filter"},"itemLabels":{"type":"array","description":"non-empty array of labels present on an item. When multiple labels specified, target item is expected to have all of them (condition works as \"AND\" for all labels specified)","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"isAssigned":{"type":"boolean","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when TRUE - only target items with the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currently assigned will be returned;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when FALSE - only target items with the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currently NOT assigned will be returned;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when UNDEFINED or NULL - flag is ignored."},"children":[]}]}]}]}]}}}},"components/schemas/NotificationCenter_SearchForAssignments_ResponseDTO":{"id":"components/schemas/NotificationCenter_SearchForAssignments_ResponseDTO","kind":"json-schema","title":"NotificationCenter_SearchForAssignments_ResponseDTO","data":{"type":"object","required":["metadata","items"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"items":{"type":"array","items":{"title":"NotificationCenter_AssignmentItem","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemLastRunAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property available only for audits and web-journeys."},"children":[]}]}]}],"required":["isAssigned","isEditable","itemType","itemId","itemName"],"properties":{"isAssigned":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRUE if specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assigned to this item, FALSE otherwise"},"children":[]}]}]}]},"isEditable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRUE if specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be assigned or unassigned from this item, FALSE otherwise"},"children":[]}]}]}]},"itemType":{"$ref":"#/components/schemas/NotificationCenter_AssignmentItemTypeEnum"},"itemId":{"$ref":"#/components/schemas/ItemId"},"itemName":{"type":"string","description":"Name of audit/WJ/rule/alert etc"},"itemLastRunAt":{"$ref":"#/components/schemas/DateAndTime"},"itemLabels":{"description":"may be absent if item does not support labels","type":"array","minItems":0,"items":{"$ref":"#/components/schemas/LabelId"}}}}}}}},"components/schemas/NotificationCenter_AssignmentItemTypeEnum":{"id":"components/schemas/NotificationCenter_AssignmentItemTypeEnum","kind":"json-schema","title":"NotificationCenter_AssignmentItemTypeEnum","data":{"type":"string","enum":["AUDIT","WEB_JOURNEY","RULE","ALERT","USAGE_ALERT","EMAIL_INBOX_MESSAGE_RECEIVED","EMAIL_INBOX_MESSAGE_PROCESSED","SCHEDULED_EXPORT"]}},"components/schemas/NotificationCenter_AssignmentsSortColumn":{"id":"components/schemas/NotificationCenter_AssignmentsSortColumn","kind":"json-schema","title":"NotificationCenter_AssignmentsSortColumn","data":{"type":"string","enum":["IS_ASSIGNED","ITEM_NAME","RUN_DATE"]}},"components/schemas/ReportFilterValidation_RegexRequestDTO":{"id":"components/schemas/ReportFilterValidation_RegexRequestDTO","kind":"json-schema","title":"ReportFilterValidation_RegexRequestDTO","data":{"type":"object","required":["regex"],"properties":{"regex":{"type":"string"}}}},"components/schemas/ReportFilterValidation_RegexResponseDTO":{"id":"components/schemas/ReportFilterValidation_RegexResponseDTO","kind":"json-schema","title":"ReportFilterValidation_RegexResponseDTO","data":{"type":"object","required":["isValid","allUnsupportedSequences"],"properties":{"isValid":{"type":"boolean"},"unsupportedSequence":{"type":"string","description":"First unsupported by ObservePoint sequence found in regex"},"allUnsupportedSequences":{"type":"array","description":"list of all unsupported by ObservePoint regex features/sequences","items":{"type":"string"}}}}},"components/schemas/TimestampFormatPreview_RequestDTO":{"id":"components/schemas/TimestampFormatPreview_RequestDTO","kind":"json-schema","title":"TimestampFormatPreview_RequestDTO","data":{"type":"object","required":["format"],"properties":{"timestamp":{"type":"string","format":"date-time","description":"Optional ISO 8601 timestamp. If not provided, current timestamp will be used.\nExample: \"2025-12-08T13:39:30.966Z\"\n"},"format":{"type":"string","description":"Snowflake date-time format string (e.g., \"mon dd, yyyy\")","example":"mon dd, yyyy"}}}},"components/schemas/TimestampFormatPreview_ResponseDTO":{"id":"components/schemas/TimestampFormatPreview_ResponseDTO","kind":"json-schema","title":"TimestampFormatPreview_ResponseDTO","data":{"type":"object","required":["timestamp","format","formattedTimestamp"],"properties":{"timestamp":{"type":"string","format":"date-time","description":"The timestamp that was formatted"},"format":{"type":"string","description":"The format string that was applied"},"formattedTimestamp":{"type":"string","description":"The formatted result","example":"dec 17, 2025"}}}},"components/schemas/AuditRun_PageSummary_WebVitals_LargestContentfulPaintFilter":{"id":"components/schemas/AuditRun_PageSummary_WebVitals_LargestContentfulPaintFilter","kind":"json-schema","title":"AuditRun_PageSummary_WebVitals_LargestContentfulPaintFilter","data":{"type":"object","description":"Common trait for integer min max filter","properties":{"min":{"type":"integer","minimum":0},"max":{"type":"integer"}}}},"components/schemas/AuditRun_PageSummary_WebVitals_FirstContentfulPaintFilter":{"id":"components/schemas/AuditRun_PageSummary_WebVitals_FirstContentfulPaintFilter","kind":"json-schema","title":"AuditRun_PageSummary_WebVitals_FirstContentfulPaintFilter","data":{"type":"object","description":"Common trait for integer min max filter","properties":{"min":{"type":"integer","minimum":0},"max":{"type":"integer"}}}},"components/schemas/AuditRun_PageSummary_WebVitals_TimeToFirstByteFilter":{"id":"components/schemas/AuditRun_PageSummary_WebVitals_TimeToFirstByteFilter","kind":"json-schema","title":"AuditRun_PageSummary_WebVitals_TimeToFirstByteFilter","data":{"type":"object","description":"Common trait for integer min max filter","properties":{"min":{"type":"integer","minimum":0},"max":{"type":"integer"}}}},"components/schemas/AuditRun_PageSummary_WebVitals_CumulativeLayoutShiftFilter":{"id":"components/schemas/AuditRun_PageSummary_WebVitals_CumulativeLayoutShiftFilter","kind":"json-schema","title":"AuditRun_PageSummary_WebVitals_CumulativeLayoutShiftFilter","data":{"type":"object","description":"Common trait for double min max filter","properties":{"min":{"type":"number","format":"double","minimum":0},"max":{"type":"number","format":"double"}}}},"components/schemas/AuditRun_PageSummary_AggregatedRunWebVitals":{"id":"components/schemas/AuditRun_PageSummary_AggregatedRunWebVitals","kind":"json-schema","title":"AuditRun_PageSummary_AggregatedRunWebVitals","data":{"type":"object","description":"Web Vitals aggregated on run level","required":["medianLargestContentfulPaint","medianFirstContentfulPaint","medianTimeToFirstByte","medianCumulativeLayoutShift","p75LargestContentfulPaint","p75FirstContentfulPaint","p75TimeToFirstByte","p75CumulativeLayoutShift"],"properties":{"medianLargestContentfulPaint":{"type":"number","format":"double","minimum":0,"description":"median LCP time in milliseconds. This field is deprecated and will be removed in the future. Use 75th percentile LCP time instead.","deprecated":true},"medianFirstContentfulPaint":{"type":"number","format":"double","minimum":0,"description":"median FCP time in milliseconds. This field is deprecated and will be removed in the future. Use 75th percentile FCP time instead.","deprecated":true},"medianTimeToFirstByte":{"type":"number","format":"double","minimum":0,"description":"median TTFB time in milliseconds. This field is deprecated and will be removed in the future. Use 75th percentile TTFB time instead.","deprecated":true},"medianCumulativeLayoutShift":{"type":"number","format":"double","minimum":0,"description":"median unitless measurement of CLS. This field is deprecated and will be removed in the future. Use 75th percentile CLS instead.","deprecated":true},"p75LargestContentfulPaint":{"type":"number","format":"double","minimum":0,"description":"75th percentile LCP time in milliseconds"},"p75FirstContentfulPaint":{"type":"number","format":"double","minimum":0,"description":"75th percentile FCP time in milliseconds"},"p75TimeToFirstByte":{"type":"number","format":"double","minimum":0,"description":"75th percentile TTFB time in milliseconds"},"p75CumulativeLayoutShift":{"type":"number","format":"double","minimum":0,"description":"75th percentile CLS, unitless measurement."}}}},"components/schemas/AuditRun_WebVitalsTrends_Enum":{"id":"components/schemas/AuditRun_WebVitalsTrends_Enum","kind":"json-schema","title":"AuditRun_WebVitalsTrends_Enum","data":{"type":"string","enum":["largest_contentful_paint","first_contentful_paint","time_to_first_byte","cumulative_layout_shift"]}},"components/schemas/AuditRun_PageDetails_WebVitalsTrends_Response":{"id":"components/schemas/AuditRun_PageDetails_WebVitalsTrends_Response","kind":"json-schema","title":"AuditRun_PageDetails_WebVitalsTrends_Response","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_PageDetails_WebVitalsTrendsItem"}}}}},"components/schemas/AuditRun_PageDetails_WebVitalsTrendsItem":{"id":"components/schemas/AuditRun_PageDetails_WebVitalsTrendsItem","kind":"json-schema","title":"AuditRun_PageDetails_WebVitalsTrendsItem","data":{"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"$ref":"#/components/schemas/AuditRun_PageWebVitals"}]}},"components/schemas/AuditRun_PageDetails_SpecificWebVitalsTrend_Response":{"id":"components/schemas/AuditRun_PageDetails_SpecificWebVitalsTrend_Response","kind":"json-schema","title":"AuditRun_PageDetails_SpecificWebVitalsTrend_Response","data":{"type":"object","required":["stats","runs"],"properties":{"stats":{"$ref":"#/components/schemas/AuditRun_PageDetails_WebVitalsTrends_Stats"},"runs":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["trendValue"],"properties":{"trendValue":{"type":"number","format":"double"}}}]}}}}},"components/schemas/AuditRun_PageDetails_WebVitalsTrends_Stats":{"id":"components/schemas/AuditRun_PageDetails_WebVitalsTrends_Stats","kind":"json-schema","title":"AuditRun_PageDetails_WebVitalsTrends_Stats","data":{"type":"object","description":"Web Vitals trends statistics (min, max, average, median)","required":["min","max","average","median"],"properties":{"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"average":{"type":"number","format":"double"},"median":{"type":"number","format":"double"}}}},"components/schemas/AuditRun_PageSummary_WebVitalsTrends_Response":{"id":"components/schemas/AuditRun_PageSummary_WebVitalsTrends_Response","kind":"json-schema","title":"AuditRun_PageSummary_WebVitalsTrends_Response","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitalsTrendsItem"}}}}},"components/schemas/AuditRun_PageSummary_WebVitalsTrendsItem":{"id":"components/schemas/AuditRun_PageSummary_WebVitalsTrendsItem","kind":"json-schema","title":"AuditRun_PageSummary_WebVitalsTrendsItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["largestContentfulPaintStats","firstContentfulPaintStats","timeToFirstByteStats","cumulativeLayoutShiftStats"],"properties":{"largestContentfulPaintStats":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitalsTrends_Stats"},"firstContentfulPaintStats":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitalsTrends_Stats"},"timeToFirstByteStats":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitalsTrends_Stats"},"cumulativeLayoutShiftStats":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitalsTrends_Stats"}}}]}},"components/schemas/AuditRun_PageSummary_SpecificWebVitalsTrend_Response":{"id":"components/schemas/AuditRun_PageSummary_SpecificWebVitalsTrend_Response","kind":"json-schema","title":"AuditRun_PageSummary_SpecificWebVitalsTrend_Response","data":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_PageSummary_SpecificWebVitalsTrend_ResponseItem"}}}}},"components/schemas/AuditRun_PageSummary_SpecificWebVitalsTrend_ResponseItem":{"id":"components/schemas/AuditRun_PageSummary_SpecificWebVitalsTrend_ResponseItem","kind":"json-schema","title":"AuditRun_PageSummary_SpecificWebVitalsTrend_ResponseItem","data":{"x-implements":["com.observepoint.reportingapi.gen.interfaces.ItemRunTrendsItemTraitInterface"],"allOf":[{"$ref":"#/components/schemas/ItemRunTrendsItemTrait"},{"type":"object","required":["stats","distribution"],"properties":{"distribution":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitalsTrends_RunItem_PagesDistribution"},"stats":{"$ref":"#/components/schemas/AuditRun_PageSummary_WebVitalsTrends_Stats"}}}]}},"components/schemas/AuditRun_PageSummary_WebVitalsTrends_RunItem_PagesDistribution":{"id":"components/schemas/AuditRun_PageSummary_WebVitalsTrends_RunItem_PagesDistribution","kind":"json-schema","title":"AuditRun_PageSummary_WebVitalsTrends_RunItem_PagesDistribution","data":{"type":"object","description":"Distribution of pages by buckets of web vitals values","required":["good","needsImprovement","poor"],"properties":{"good":{"type":"integer"},"needsImprovement":{"type":"integer"},"poor":{"type":"integer"}}}},"components/schemas/AuditRun_PageSummary_WebVitalsTrends_Stats":{"id":"components/schemas/AuditRun_PageSummary_WebVitalsTrends_Stats","kind":"json-schema","title":"AuditRun_PageSummary_WebVitalsTrends_Stats","data":{"type":"object","description":"Web Vitals trends statistics (min, max, average, median, 25th and 75th percentiles)","required":["min","max","average","median","p25","p75"],"properties":{"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"average":{"type":"number","format":"double"},"median":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"}}}},"components/schemas/WebVitalsLargestContentfulPaint":{"id":"components/schemas/WebVitalsLargestContentfulPaint","kind":"json-schema","title":"WebVitalsLargestContentfulPaint","data":{"type":"number","format":"double","description":"LCP time in milliseconds"}},"components/schemas/AuditRun_PageWebVitals":{"id":"components/schemas/AuditRun_PageWebVitals","kind":"json-schema","title":"AuditRun_PageWebVitals","data":{"type":"object","description":"Web Vitals for a single page","properties":{"largestContentfulPaint":{"$ref":"#/components/schemas/WebVitalsLargestContentfulPaint"},"firstContentfulPaint":{"type":"number","format":"double","description":"FCP time in milliseconds"},"timeToFirstByte":{"type":"number","format":"double","description":"TTFB time in milliseconds"},"cumulativeLayoutShift":{"type":"number","format":"double","description":"unitless measurement of CLS"}}}},"components/schemas/ReceivedEmailMessageId":{"id":"components/schemas/ReceivedEmailMessageId","kind":"json-schema","title":"ReceivedEmailMessageId","data":{"type":"integer"}},"components/schemas/EmailInboxMessageAlertsRequestDTO":{"id":"components/schemas/EmailInboxMessageAlertsRequestDTO","kind":"json-schema","title":"EmailInboxMessageAlertsRequestDTO","data":{"type":"object","required":["emailInboxId","messageIds"],"properties":{"emailInboxId":{"type":"integer"},"messageIds":{"type":"array","description":"Message IDs list cannot be empty","minItems":1,"maxItems":200,"items":{"$ref":"#/components/schemas/ReceivedEmailMessageId"}}}}},"components/schemas/EmailInboxMessageAlertsResponseDTO":{"id":"components/schemas/EmailInboxMessageAlertsResponseDTO","kind":"json-schema","title":"EmailInboxMessageAlertsResponseDTO","data":{"type":"object","required":["messages"],"properties":{"messages":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/EmailInboxMessageAlertsResponse_MessageItem"}}}}},"components/schemas/EmailInboxMessageAlertsResponse_MessageItem":{"id":"components/schemas/EmailInboxMessageAlertsResponse_MessageItem","kind":"json-schema","title":"EmailInboxMessageAlertsResponse_MessageItem","data":{"type":"object","required":["messageId","audits"],"properties":{"messageId":{"$ref":"#/components/schemas/ReceivedEmailMessageId"},"audits":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/EmailInboxMessageAlertsResponse_AuditItem"}}}}},"components/schemas/EmailInboxMessageAlertsResponse_AuditItem":{"id":"components/schemas/EmailInboxMessageAlertsResponse_AuditItem","kind":"json-schema","title":"EmailInboxMessageAlertsResponse_AuditItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignedAlertCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the number of alerts computed for completed run,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number of alerts assigned to audit for not completed run."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If audit is not completed then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggeredAlertCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property will be absent."},"children":[]}]}]}],"required":["auditId","auditName","isCompleted","runId","assignedAlertCount"],"properties":{"auditId":{"$ref":"#/components/schemas/AuditId"},"auditName":{"type":"string"},"isCompleted":{"type":"boolean"},"runId":{"$ref":"#/components/schemas/RunId"},"assignedAlertCount":{"type":"integer"},"triggeredAlertCount":{"type":"integer"}}}},"components/schemas/InvokeAuditLiveResultsResponseDTO":{"id":"components/schemas/InvokeAuditLiveResultsResponseDTO","kind":"json-schema","title":"InvokeAuditLiveResultsResponseDTO","data":{"type":"object","required":["requestId"],"properties":{"requestId":{"type":"string"}}}},"components/schemas/PagesLiveResultsSortColumn":{"id":"components/schemas/PagesLiveResultsSortColumn","kind":"json-schema","title":"PagesLiveResultsSortColumn","data":{"type":"string","default":"pageId","enum":["finalUrl","finalStatusCode","uniqueTagCount","uniqueCookieCount","dataLayerCount","consoleErrorCount","pageId","lcpSeconds"]}},"components/schemas/TagsLiveResultsSortColumn":{"id":"components/schemas/TagsLiveResultsSortColumn","kind":"json-schema","title":"TagsLiveResultsSortColumn","data":{"type":"string","default":"tagId","enum":["tagName","tagId","tagVendorName","tagCategory","pagesTagged","pagesNotTagged"]}},"components/schemas/CookiesLiveResultsSortColumn":{"id":"components/schemas/CookiesLiveResultsSortColumn","kind":"json-schema","title":"CookiesLiveResultsSortColumn","data":{"type":"string","default":"domain","enum":["name","domain","pagesWithCookie","partyType","partitionKey","durationMinutes","sameSite","secure","httpOnly","origin"]}},"components/schemas/AccessibilityIssuesLiveResultsSortColumn":{"id":"components/schemas/AccessibilityIssuesLiveResultsSortColumn","kind":"json-schema","title":"AccessibilityIssuesLiveResultsSortColumn","data":{"type":"string","default":"impact","enum":["issueType","wcagVersionAndConformanceLevel","impact","affectedPages","totalCount"]}},"components/schemas/AthenaQueryResultStatus":{"id":"components/schemas/AthenaQueryResultStatus","kind":"json-schema","title":"AthenaQueryResultStatus","data":{"type":"string","enum":["COMPLETE","PENDING","ERROR"]}},"components/schemas/AuditLiveResultsBaseResponseDTO":{"id":"components/schemas/AuditLiveResultsBaseResponseDTO","kind":"json-schema","title":"AuditLiveResultsBaseResponseDTO","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response for page live results. Will only contain results object when status is COMPLETE. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statusMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is populated when status is ERROR."},"children":[]}]}]}],"type":"object","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/AthenaQueryResultStatus"},"statusMessage":{"type":"string"},"results":{"type":"object"}}}},"components/schemas/AuditLiveResultsPagesResponseDTO":{"id":"components/schemas/AuditLiveResultsPagesResponseDTO","kind":"json-schema","title":"AuditLiveResultsPagesResponseDTO","data":{"allOf":[{"$ref":"#/components/schemas/AuditLiveResultsBaseResponseDTO"},{"type":"object","properties":{"results":{"$ref":"#/components/schemas/AuditLiveResultsPageEntriesDTO"}}}]}},"components/schemas/AuditLiveResultsTagsResponseDTO":{"id":"components/schemas/AuditLiveResultsTagsResponseDTO","kind":"json-schema","title":"AuditLiveResultsTagsResponseDTO","data":{"allOf":[{"$ref":"#/components/schemas/AuditLiveResultsBaseResponseDTO"},{"type":"object","properties":{"results":{"$ref":"#/components/schemas/AuditLiveResultsTagEntriesDTO"}}}]}},"components/schemas/AuditLiveResultsCookiesResponseDTO":{"id":"components/schemas/AuditLiveResultsCookiesResponseDTO","kind":"json-schema","title":"AuditLiveResultsCookiesResponseDTO","data":{"allOf":[{"$ref":"#/components/schemas/AuditLiveResultsBaseResponseDTO"},{"type":"object","properties":{"results":{"$ref":"#/components/schemas/AuditLiveResultsCookieEntriesDTO"}}}]}},"components/schemas/AuditLiveResultsAccessibilityIssuesResponseDTO":{"id":"components/schemas/AuditLiveResultsAccessibilityIssuesResponseDTO","kind":"json-schema","title":"AuditLiveResultsAccessibilityIssuesResponseDTO","data":{"allOf":[{"$ref":"#/components/schemas/AuditLiveResultsBaseResponseDTO"},{"type":"object","properties":{"results":{"$ref":"#/components/schemas/AuditLiveResultsAccessibilityIssuesEntriesDTO"}}}]}},"components/schemas/AuditLiveResultsPageEntriesDTO":{"id":"components/schemas/AuditLiveResultsPageEntriesDTO","kind":"json-schema","title":"AuditLiveResultsPageEntriesDTO","data":{"description":"Object containing all of the LiveResults(TM) data for the page query.","type":"object","required":["pageEntries"],"properties":{"pageEntries":{"type":"array","items":{"$ref":"#/components/schemas/AuditLiveResultsPageEntryDTO"}}}}},"components/schemas/AuditLiveResultsPageEntryDTO":{"id":"components/schemas/AuditLiveResultsPageEntryDTO","kind":"json-schema","title":"AuditLiveResultsPageEntryDTO","data":{"type":"object","description":"One page's worth of LiveResults(TM) data.","required":["pageId","finalUrl","finalStatusCode","uniqueTagCount","uniqueCookieCount","dataLayerCount","consoleErrorCount","lcpSeconds"],"properties":{"pageId":{"$ref":"#/components/schemas/PageId"},"finalUrl":{"$ref":"#/components/schemas/PageUrl"},"finalStatusCode":{"$ref":"#/components/schemas/PageStatusCode"},"uniqueTagCount":{"type":"number","description":"Number of unique tags found on the page."},"uniqueCookieCount":{"type":"number","description":"Number of unique cookies found on the page."},"dataLayerCount":{"type":"number","description":"Number of data layers found on the page."},"consoleErrorCount":{"type":"number","description":"Number of console error messages on the page."},"lcpSeconds":{"$ref":"#/components/schemas/WebVitalsLargestContentfulPaint"},"accessibilityScores":{"$ref":"#/components/schemas/PageAccessibilityScores"}}}},"components/schemas/AuditLiveResultsTagEntriesDTO":{"id":"components/schemas/AuditLiveResultsTagEntriesDTO","kind":"json-schema","title":"AuditLiveResultsTagEntriesDTO","data":{"description":"Object containing all of the LiveResults(TM) data for the tag query.","type":"object","required":["tagEntries"],"properties":{"tagEntries":{"type":"array","items":{"$ref":"#/components/schemas/AuditLiveResultsTagEntryDTO"}}}}},"components/schemas/AuditLiveResultsTagEntryDTO":{"id":"components/schemas/AuditLiveResultsTagEntryDTO","kind":"json-schema","title":"AuditLiveResultsTagEntryDTO","data":{"type":"object","description":"One tag's worth of LiveResults(TM) data.","required":["tagName","tagId","tagVendorName","tagCategory","pagesTagged","pagesNotTagged"],"properties":{"tagName":{"type":"string"},"tagId":{"type":"number"},"tagVendorName":{"type":"string"},"tagCategory":{"type":"string"},"pagesTagged":{"type":"number"},"pagesNotTagged":{"type":"number"}}}},"components/schemas/AuditLiveResultsCookieEntriesDTO":{"id":"components/schemas/AuditLiveResultsCookieEntriesDTO","kind":"json-schema","title":"AuditLiveResultsCookieEntriesDTO","data":{"description":"Object containing all of the LiveResults(TM) data for the cookies query.","type":"object","required":["cookieEntries"],"properties":{"cookieEntries":{"type":"array","items":{"$ref":"#/components/schemas/AuditLiveResultsCookieEntryDTO"}}}}},"components/schemas/AuditLiveResultsCookieEntryDTO":{"id":"components/schemas/AuditLiveResultsCookieEntryDTO","kind":"json-schema","title":"AuditLiveResultsCookieEntryDTO","data":{"type":"object","description":"One cookie's worth of LiveResults(TM) data.","required":["name","domain","pagesWithCookie","partyType","partitionKey","durationMinutes","sameSite","secure","httpOnly","origin"],"properties":{"name":{"type":"string"},"domain":{"type":"string"},"partitionKey":{"type":"string"},"pagesWithCookie":{"type":"number"},"partyType":{"type":"array","items":{"type":"string"}},"durationMinutes":{"type":"array","items":{"type":"number"}},"sameSite":{"type":"array","items":{"type":"string"}},"secure":{"type":"array","items":{"type":"boolean"}},"httpOnly":{"type":"array","items":{"type":"boolean"}},"origin":{"type":"array","items":{"type":"string"}}}}},"components/schemas/AuditLiveResultsAccessibilityIssuesEntriesDTO":{"id":"components/schemas/AuditLiveResultsAccessibilityIssuesEntriesDTO","kind":"json-schema","title":"AuditLiveResultsAccessibilityIssuesEntriesDTO","data":{"description":"Object containing all of the LiveResults(TM) data for the accessibility issues query.","type":"object","required":["accessibilityIssues"],"properties":{"accessibilityIssues":{"type":"array","items":{"$ref":"#/components/schemas/AuditLiveResultsAccessibilityIssuesEntryDTO"}}}}},"components/schemas/AuditLiveResultsAccessibilityIssuesEntryDTO":{"id":"components/schemas/AuditLiveResultsAccessibilityIssuesEntryDTO","kind":"json-schema","title":"AuditLiveResultsAccessibilityIssuesEntryDTO","data":{"type":"object","description":"One accessibility issue's worth of LiveResults(TM) data.","required":["issueType","affectedPages","totalCount","wcagVersionAndConformanceLevel","impact"],"properties":{"issueType":{"type":"string"},"affectedPages":{"type":"number"},"totalCount":{"type":"number"},"wcagVersionAndConformanceLevel":{"type":"string"},"impact":{"type":"string"}}}},"components/schemas/EmailInboxMessageDetailsResponseDTO":{"id":"components/schemas/EmailInboxMessageDetailsResponseDTO","kind":"json-schema","title":"EmailInboxMessageDetailsResponseDTO","data":{"type":"object","required":["subject","sendingPlatform","sendingEmail","linksScanned","headers","screenshot","screenshotThumb","emailRawHtml","linksScannedValues"],"properties":{"subject":{"type":"string"},"receivedAt":{"type":"string"},"sendingPlatform":{"type":"string"},"sendingEmail":{"type":"string"},"linksScanned":{"type":"integer"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/EmailMessageDetailsHeaderDTO"}},"screenshot":{"type":"string"},"screenshotThumb":{"type":"string"},"emailRawHtml":{"type":"string"},"linksScannedValues":{"description":"All links found in the email message","type":"array","items":{"type":"string"}}}}},"components/schemas/EmailMessageDetailsHeaderDTO":{"id":"components/schemas/EmailMessageDetailsHeaderDTO","kind":"json-schema","title":"EmailMessageDetailsHeaderDTO","data":{"type":"object","required":["name","value","isId","vendor","description"],"properties":{"name":{"type":"string"},"value":{"type":"string"},"isId":{"type":"boolean"},"vendor":{"type":"string"},"description":{"type":"string"}}}},"components/schemas/ErrorModel":{"id":"components/schemas/ErrorModel","kind":"json-schema","title":"ErrorModel","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"message":{"type":"string"},"details":{"type":"string"},"validationReport":{"type":"object"}}}},"components/schemas/PaginationMetadata":{"id":"components/schemas/PaginationMetadata","kind":"json-schema","title":"PaginationMetadata","data":{"type":"object","required":["totalCount","totalPageCount","pageSize","currentPageSize","currentPageNumber"],"properties":{"totalCount":{"description":"Total number of items available from all result pages combined","type":"integer"},"totalPageCount":{"description":"Total number of pages available","type":"integer"},"pageSize":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page size - number of items per result page configured by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter or default page size"},"children":[]}]}]}],"type":"integer"},"currentPageSize":{"description":"Number of items in current result page","type":"integer"},"currentPageNumber":{"description":"Current page number/ordinal","type":"integer"}}}},"components/schemas/ConsoleLogDto":{"id":"components/schemas/ConsoleLogDto","kind":"json-schema","title":"ConsoleLogDto","data":{"type":"object","properties":{"message":{"type":"string","description":"The console message"},"count":{"type":"integer","minimum":1,"description":"The number of times this exact console message was encountered in the given context"},"level":{"type":"string","enum":["SEVERE","WARNING","INFO","FINE"],"description":"The console log level"},"timestamp":{"type":"integer","format":"int64","description":"Timestamp when the log occurred"},"source":{"type":"string","description":"The file that triggered the console log, if it can be determined"}}}},"components/schemas/WebJourneyNotificationConfig":{"id":"components/schemas/WebJourneyNotificationConfig","kind":"json-schema","title":"WebJourneyNotificationConfig","data":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"},"description":"List of email addresses for notifications"},"alerts":{"type":"boolean","description":"Whether alerts are enabled"},"webHookUrl":{"type":"string","description":"Webhook URL for notifications"}}}},"components/schemas/WebJourneyRunStatusObject":{"id":"components/schemas/WebJourneyRunStatusObject","kind":"json-schema","title":"WebJourneyRunStatusObject","data":{"type":"object","properties":{"status":{"type":"integer","description":"The numeric status value of the web journey run"}}}},"components/schemas/WebJourneyAndActionRules":{"id":"components/schemas/WebJourneyAndActionRules","kind":"json-schema","title":"WebJourneyAndActionRules","data":{"type":"object","properties":{"webJourneyRules":{"type":"array","items":{"$ref":"#/components/schemas/Rule"},"description":"List of rules for the web journey"},"actionRules":{"type":"array","items":{"$ref":"#/components/schemas/WebJourneyActionRules"},"description":"List of action-specific rules"}}}},"components/schemas/WebJourneyActionRules":{"id":"components/schemas/WebJourneyActionRules","kind":"json-schema","title":"WebJourneyActionRules","data":{"type":"object","properties":{"actionId":{"type":"integer","format":"int64","description":"The ID of the action"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/Rule"},"description":"List of rules for this action"}}}},"components/schemas/WebJourneyAndActionRulesRequest":{"id":"components/schemas/WebJourneyAndActionRulesRequest","kind":"json-schema","title":"WebJourneyAndActionRulesRequest","data":{"type":"object","properties":{"webJourneyRules":{"type":"array","items":{"type":"integer"},"uniqueItems":true,"description":"Set of web journey rule IDs"},"actionRules":{"type":"array","items":{"$ref":"#/components/schemas/WebJourneyActionRulesRequest"},"description":"List of action rule requests"}}}},"components/schemas/WebJourneyActionRulesRequest":{"id":"components/schemas/WebJourneyActionRulesRequest","kind":"json-schema","title":"WebJourneyActionRulesRequest","data":{"type":"object","properties":{"actionId":{"type":"integer","format":"int64","description":"The ID of the action"},"rules":{"type":"array","items":{"type":"integer"},"uniqueItems":true,"description":"Set of rule IDs for this action"}}}},"components/schemas/AuditRun":{"id":"components/schemas/AuditRun","kind":"json-schema","title":"AuditRun","data":{"type":"object","properties":{"runId":{"$ref":"#/components/schemas/RunId"},"completedAt":{"type":"string","format":"date-time"}}}},"components/schemas/ActionSetDto":{"id":"components/schemas/ActionSetDto","kind":"json-schema","title":"ActionSetDto","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the action set","nullable":false,"minLength":1},"actions":{"type":"array","items":{"$ref":"#/components/schemas/ActionSetActionDto"},"description":"List of actions in the action set","nullable":false,"minItems":1},"updatedAt":{"type":"string","format":"local-date-time","readOnly":true,"description":"Timestamp when the action set was last updated"},"createdAt":{"type":"string","format":"local-date-time","readOnly":true,"description":"Timestamp when the action set was created"},"accountId":{"type":"integer","readOnly":true,"description":"ID of the account the action set belongs to"},"userId":{"type":"integer","readOnly":true,"description":"ID of the user the action set belongs to"}},"required":["name","actions"]}},"components/schemas/SequencedAction":{"id":"components/schemas/SequencedAction","kind":"json-schema","title":"SequencedAction","data":{"type":"object","properties":{"sequence":{"type":"integer","description":"Sequence number of the action","nullable":false},"id":{"type":"integer","format":"int64","readOnly":true,"description":"ID of the action"},"description":{"type":"string","description":"Description of the action. Present for all actionTypes except: actionSet"},"actionType":{"type":"string","enum":["click","input","maskedinput","select","check","uncheck","enteriframe","navto","watch","clearcookies","execute","exitiframe","privacyoptin","privacyoptout","actionset"],"description":"Type of the user action","nullable":false},"waitDuration":{"type":"integer","description":"Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut"},"selectors":{"type":"array","items":{"$ref":"#/components/schemas/WebActionSelector"},"description":"List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame"},"preventNavigation":{"type":"boolean","description":"Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput"},"value":{"type":"string","description":"Value field with different meanings per actionType. For input/select: input value. For navTo: URL. For privacyOptIn/privacyOptOut: URL. For execute: JavaScript code. Present for actionTypes: input, select, navTo, privacyOptIn, privacyOptOut, execute"},"maskedValue":{"type":"string","description":"Masked value for secure input actions. Present for actionType: maskedInput"},"js":{"type":"string","description":"JavaScript code to execute. Present for actionType: execute"},"url":{"type":"string","description":"URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut"},"seconds":{"type":"integer","description":"Number of seconds to watch/wait. Present for actionType: watch"},"isRequired":{"type":"boolean","description":"Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut"}},"required":["sequence","actionType"]}},"components/schemas/AuditLoginSequencedAction":{"id":"components/schemas/AuditLoginSequencedAction","kind":"json-schema","title":"AuditLoginSequencedAction","data":{"allOf":[{"$ref":"#/components/schemas/SequencedAction"},{"type":"object","properties":{"actionSetId":{"type":"integer","format":"int64","description":"ID of the action set to reference. Present for actionType: actionset"}}}]}},"components/schemas/ActionSetActionDto":{"id":"components/schemas/ActionSetActionDto","kind":"json-schema","title":"ActionSetActionDto","data":{"allOf":[{"$ref":"#/components/schemas/SequencedAction"},{"type":"object","properties":{"actionSetId":{"type":"integer","format":"int64","description":"ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID"},"pageFilter":{"type":"string","description":"Page filter pattern for the action"}}}]}},"components/schemas/WebActionSelector":{"id":"components/schemas/WebActionSelector","kind":"json-schema","title":"WebActionSelector","data":{"type":"object","properties":{"selectorType":{"$ref":"#/components/schemas/WebActionSelectorType"},"value":{"description":"Selector value - string for simple selectors (CSS, XPath, id, name) or AttributeSelectorValue object for htmlattributes selector type"}},"required":["selectorType","value"]}},"components/schemas/WebActionSelectorType":{"id":"components/schemas/WebActionSelectorType","kind":"json-schema","title":"WebActionSelectorType","data":{"type":"string","enum":["id","name","css","xpath","htmlattributes"]}},"components/schemas/ElementAttribute":{"id":"components/schemas/ElementAttribute","kind":"json-schema","title":"ElementAttribute","data":{"type":"object","properties":{"name":{"type":"string","description":"Attribute name"},"value":{"type":"string","description":"Attribute value"}},"required":["name","value"]}},"components/schemas/EngineActionDTO":{"id":"components/schemas/EngineActionDTO","kind":"json-schema","title":"EngineActionDTO","data":{"type":"object","description":"Engine action DTO for internal services - represents an action to be executed by the chrome-engine","properties":{"elementSelectors":{"type":"array","items":{"$ref":"#/components/schemas/EngineActionSelectorDTO"},"description":"List of element selectors for the action","default":[]},"filter":{"type":"string","description":"CSS selector filter"},"input":{"type":"string","description":"Input value for the action"},"label":{"type":"string","description":"Label/description of the action"},"secretInput":{"type":"string","description":"Encrypted/secret input value"},"preventNavigation":{"type":"boolean","description":"Whether to prevent navigation after the action"},"actionType":{"type":"integer","description":"Type of action to perform"},"sequenceId":{"type":"integer","description":"Sequence identifier"},"snapshotId":{"type":"integer","description":"Snapshot identifier"},"value":{"type":"integer","description":"Value associated with the action"},"waitDuration":{"type":"integer","description":"Wait duration in milliseconds"},"id":{"type":"integer","format":"int64","description":"Action identifier"},"isRequired":{"type":"boolean","description":"Whether the action is required"}}}},"components/schemas/AuditActionsSnapshotDTO":{"id":"components/schemas/AuditActionsSnapshotDTO","kind":"json-schema","title":"AuditActionsSnapshotDTO","data":{"type":"object","description":"Snapshot of audit actions including pre-audit and on-page actions","properties":{"preAuditActions":{"type":"array","items":{"$ref":"#/components/schemas/EngineActionDTO"},"description":"Actions to execute before the audit","default":[]},"onPageAuditActions":{"type":"array","items":{"$ref":"#/components/schemas/EngineActionDTO"},"description":"Actions to execute on each page during the audit","default":[]}}}},"components/schemas/EngineActionSelectorDTO":{"id":"components/schemas/EngineActionSelectorDTO","kind":"json-schema","title":"EngineActionSelectorDTO","data":{"description":"Polymorphic selector for engine actions - can be simple (string) or attribute-based","discriminator":{"propertyName":"jsonType","mapping":{"simple":"#/components/schemas/EngineActionSimpleSelectorDTO","attribute":"#/components/schemas/EngineActionAttributeSelectorDTO"}},"oneOf":[{"$ref":"#/components/schemas/EngineActionSimpleSelectorDTO"},{"$ref":"#/components/schemas/EngineActionAttributeSelectorDTO"}]}},"components/schemas/EngineActionSimpleSelectorDTO":{"id":"components/schemas/EngineActionSimpleSelectorDTO","kind":"json-schema","title":"EngineActionSimpleSelectorDTO","data":{"type":"object","description":"Simple selector using a string value (e.g., CSS selector)","required":["jsonType","strategy","value"],"properties":{"jsonType":{"type":"string","enum":["simple"],"description":"Selector type discriminator - must be 'simple'"},"strategy":{"type":"integer","description":"Selector strategy identifier"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selector value (e.g., CSS selector like '#submit-button')"},"children":[]}]}]}]}}}},"components/schemas/EngineActionAttributeSelectorDTO":{"id":"components/schemas/EngineActionAttributeSelectorDTO","kind":"json-schema","title":"EngineActionAttributeSelectorDTO","data":{"type":"object","description":"Attribute-based selector using element attributes","required":["jsonType","strategy","value"],"properties":{"jsonType":{"type":"string","enum":["attribute"],"description":"Selector type discriminator - must be 'attribute'"},"strategy":{"type":"integer","description":"Selector strategy identifier"},"value":{"$ref":"#/components/schemas/AttributeSelectorValue"}}}},"components/schemas/AttributeSelectorValue":{"id":"components/schemas/AttributeSelectorValue","kind":"json-schema","title":"AttributeSelectorValue","data":{"type":"object","properties":{"tagName":{"type":"string","description":"HTML tag name"},"innerHTML":{"type":"string","description":"Inner HTML content"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/ElementAttribute"},"description":"List of element attributes"}}}},"components/schemas/WebJourneyRunRequestDTO":{"id":"components/schemas/WebJourneyRunRequestDTO","kind":"json-schema","title":"WebJourneyRunRequestDTO","data":{"type":"object","description":"Complete configuration snapshot for a web journey run","properties":{"runId":{"type":"integer","format":"int64","description":"Run identifier"},"id":{"type":"integer","format":"int64","description":"Web journey identifier"},"accountId":{"type":"integer","format":"int64","description":"Account identifier"},"propertyId":{"type":"integer","format":"int64","description":"Property/domain identifier"},"userAgentId":{"type":"integer","description":"User agent identifier"},"awsRegion":{"type":"string","description":"AWS region for execution"},"tagMask":{"type":"string","description":"Tag mask configuration"},"proxy":{"type":"string","description":"Proxy server configuration"},"options":{"$ref":"#/components/schemas/WebJourneyOptionsDTO"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/EngineActionDTO"},"description":"List of actions to execute"},"vpnEnabled":{"type":"boolean","description":"Whether VPN is enabled"},"gpcEnabled":{"type":"boolean","description":"Whether Global Privacy Control is enabled"},"blockThirdPartyCookies":{"type":"boolean","description":"Whether to block third-party cookies"},"rfmConfigs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RemoteFileMappingConfigDTO"},"description":"Remote file mapping configurations keyed by mapping ID"},"customHeaderGroup":{"type":"array","items":{"$ref":"#/components/schemas/CustomHeaderGroupSnapshot"},"description":"Custom header groups for the journey"},"browserName":{"type":"string","description":"Browser name used for the journey run"},"browserVersion":{"type":"string","description":"Browser version used for the journey run"},"userAgentString":{"type":"string","description":"Full user agent string used for the journey run"}}}},"components/schemas/WebJourneyOptionsDTO":{"id":"components/schemas/WebJourneyOptionsDTO","kind":"json-schema","title":"WebJourneyOptionsDTO","data":{"type":"object","description":"Browser and execution options for web journey","properties":{"loadVideos":{"type":"boolean","description":"Whether to load videos"},"browserWidth":{"type":"integer","description":"Browser viewport width in pixels"},"browserHeight":{"type":"integer","description":"Browser viewport height in pixels"},"dataLayer":{"type":"string","description":"Data layer name for analytics"}}}},"components/schemas/RemoteFileMappingConfigDTO":{"id":"components/schemas/RemoteFileMappingConfigDTO","kind":"json-schema","title":"RemoteFileMappingConfigDTO","data":{"type":"object","description":"Configuration for remote file mapping","properties":{"s3File":{"$ref":"#/components/schemas/S3FileDTO"},"fileUrl":{"type":"string","description":"URL of the replacement file"},"matchType":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match type (1=equals, 2=regex, etc.)"},"children":[]}]}]}]},"matchValue":{"type":"string","description":"Value to match against"}}}},"components/schemas/S3FileDTO":{"id":"components/schemas/S3FileDTO","kind":"json-schema","title":"S3FileDTO","data":{"type":"object","description":"S3 file reference","properties":{"bucket":{"type":"string","description":"S3 bucket name"},"key":{"type":"string","description":"S3 object key (full path)"}}}},"components/schemas/WebJourneyStartReason":{"id":"components/schemas/WebJourneyStartReason","kind":"json-schema","title":"WebJourneyStartReason","data":{"type":"integer","description":"Reason for starting the web journey run","enum":[1,2],"x-enum-varnames":["SCHEDULE","RUN_NOW"]}},"components/schemas/PossibleMigrations":{"id":"components/schemas/PossibleMigrations","kind":"json-schema","title":"PossibleMigrations","data":{"type":"object","properties":{"auditsWithMatchedActions":{"type":"array","items":{"$ref":"#/components/schemas/ActionSetLibraryItem"},"description":"Audits that have actions matching the action set"},"auditsWithMatchedLoginActions":{"type":"array","items":{"$ref":"#/components/schemas/ActionSetLibraryItem"},"description":"Audits that have login actions matching the action set"},"journeys":{"type":"array","items":{"$ref":"#/components/schemas/ActionSetLibraryItem"},"description":"Web journeys that can use this action set"}}}},"components/schemas/ActionSetLibraryItem":{"id":"components/schemas/ActionSetLibraryItem","kind":"json-schema","title":"ActionSetLibraryItem","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the audit or journey"},"name":{"type":"string","description":"Name of the audit or journey"},"access":{"type":"boolean","description":"Whether the user has access to this audit or journey"}},"required":["id","name","access"]}},"components/schemas/PreSignedUrlResponse":{"id":"components/schemas/PreSignedUrlResponse","kind":"json-schema","title":"PreSignedUrlResponse","data":{"type":"object","properties":{"putPresignedUrl":{"type":"string"},"getPresignedUrl":{"type":"string"}},"required":["putPresignedUrl","getPresignedUrl"]}},"components/schemas/DataSourcesResult":{"id":"components/schemas/DataSourcesResult","kind":"json-schema","title":"DataSourcesResult","data":{"type":"object","required":["metadata","dataSources"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"dataSources":{"type":"array","items":{"$ref":"#/components/schemas/DataSource"}}}}},"components/schemas/DataSourceItemTypeCap":{"id":"components/schemas/DataSourceItemTypeCap","kind":"json-schema","title":"DataSourceItemTypeCap","data":{"description":"Type of data source item.","type":"string","enum":["AUDIT","WEB_JOURNEY"]}},"components/schemas/DataSourceItemType":{"id":"components/schemas/DataSourceItemType","kind":"json-schema","title":"DataSourceItemType","data":{"description":"Type of data source item.","type":"string","enum":["audit","web-journey"]}},"components/schemas/DataSource":{"id":"components/schemas/DataSource","kind":"json-schema","title":"DataSource","data":{"type":"object","required":["itemType","itemId","labels"],"properties":{"itemType":{"$ref":"#/components/schemas/DataSourceItemType"},"itemId":{"type":"integer"},"itemName":{"type":"string"},"lastCompletedRun":{"$ref":"#/components/schemas/AuditRun"},"consentCategoryType":{"$ref":"#/components/schemas/ConsentCategory_TypeEnum"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"}}}}},"components/schemas/UndeleteWebAuditRequest":{"id":"components/schemas/UndeleteWebAuditRequest","kind":"json-schema","title":"UndeleteWebAuditRequest","data":{"type":"object","required":["id","folderId","subFolderId"],"properties":{"id":{"type":"integer","format":"int32"},"folderId":{"type":"integer","format":"int32"},"subFolderId":{"type":"integer","format":"int32"}}}},"components/schemas/UndeleteWebJourneyRequest":{"id":"components/schemas/UndeleteWebJourneyRequest","kind":"json-schema","title":"UndeleteWebJourneyRequest","data":{"type":"object","required":["id","folderId","subFolderId"],"properties":{"id":{"type":"integer","format":"int64"},"folderId":{"type":"integer","format":"int32"},"subFolderId":{"type":"integer","format":"int32"}}}},"components/schemas/UndeleteWebAuditResponse":{"id":"components/schemas/UndeleteWebAuditResponse","kind":"json-schema","title":"UndeleteWebAuditResponse","data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/UndeleteStatus"},"folderId":{"type":"integer","format":"int32"},"subFolderId":{"type":"integer","format":"int32"},"code":{"$ref":"#/components/schemas/UndeleteFailureCode"},"reason":{"type":"string"}}}},"components/schemas/UndeleteWebJourneyResponse":{"id":"components/schemas/UndeleteWebJourneyResponse","kind":"json-schema","title":"UndeleteWebJourneyResponse","data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"integer","format":"int64"},"status":{"$ref":"#/components/schemas/UndeleteStatus"},"folderId":{"type":"integer","format":"int32"},"subFolderId":{"type":"integer","format":"int32"},"code":{"$ref":"#/components/schemas/UndeleteFailureCode"},"reason":{"type":"string"}}}},"components/schemas/UndeleteStatus":{"id":"components/schemas/UndeleteStatus","kind":"json-schema","title":"UndeleteStatus","data":{"type":"string","enum":["restored","failed"]}},"components/schemas/UndeleteFailureCode":{"id":"components/schemas/UndeleteFailureCode","kind":"json-schema","title":"UndeleteFailureCode","data":{"type":"string","enum":["destination_gone","already_restored","error"]}},"components/schemas/DataSourceSortByEnum":{"id":"components/schemas/DataSourceSortByEnum","kind":"json-schema","title":"DataSourceSortByEnum","data":{"type":"string","default":"lastRun","enum":["itemName","itemType","lastRun"]}},"components/schemas/UserEventsResult":{"id":"components/schemas/UserEventsResult","kind":"json-schema","title":"UserEventsResult","data":{"type":"object","required":["metadata","userEvents"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"userEvents":{"type":"array","items":{"$ref":"#/components/schemas/UserEvent"}}}}},"components/schemas/InstallationId":{"id":"components/schemas/InstallationId","kind":"json-schema","title":"InstallationId","data":{"type":"integer","format":"int64","description":"ID of a GitHub App installation","example":123456789}},"components/schemas/GitHubAppInstallationRecordId":{"id":"components/schemas/GitHubAppInstallationRecordId","kind":"json-schema","title":"GitHubAppInstallationRecordId","data":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database record ID from github_app_installations table. This is NOT GitHub's installation_id."},"children":[]}]}]}],"example":42}},"components/schemas/GitHubAppSetupActionEnum":{"id":"components/schemas/GitHubAppSetupActionEnum","kind":"json-schema","title":"GitHubAppSetupActionEnum","data":{"type":"string","enum":["install","update","request"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action that triggered the GitHub App setup callback:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"install: User installed the app"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update: User updated the app permissions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request: User requested installation approval"},"children":[]}]}]}]}]}},"components/schemas/ConsentCategoriesUploadRequest":{"id":"components/schemas/ConsentCategoriesUploadRequest","kind":"json-schema","title":"ConsentCategoriesUploadRequest","data":{"type":"object","required":["fileId","consentCategories"],"properties":{"fileId":{"type":"string"},"consentCategories":{"type":"array","default":[],"items":{"$ref":"#/components/schemas/ConsentCategoryUploadWithLabels"}}}}},"components/schemas/ConsentCategoryUploadWithLabels":{"id":"components/schemas/ConsentCategoryUploadWithLabels","kind":"json-schema","title":"ConsentCategoryUploadWithLabels","data":{"type":"object","required":["labels"],"properties":{"consentCategoryName":{"type":"string"},"labels":{"type":"array","default":[],"items":{"type":"integer"}},"consentCategoryId":{"$ref":"#/components/schemas/ConsentCategoryId"}}}},"components/schemas/ConsentCategoryUploadPreviewResult":{"id":"components/schemas/ConsentCategoryUploadPreviewResult","kind":"json-schema","title":"ConsentCategoryUploadPreviewResult","data":{"type":"object","required":["results"],"properties":{"fileId":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategoryFoundResult"}}}}},"components/schemas/ConsentCategoryFoundResult":{"id":"components/schemas/ConsentCategoryFoundResult","kind":"json-schema","title":"ConsentCategoryFoundResult","data":{"type":"object","required":["consentCategoryName","noOfNewCookies","consentCategoryId"],"properties":{"consentCategoryName":{"type":"string"},"noOfNewCookies":{"type":"integer"},"noOfNewTags":{"type":"integer"},"noOfNewRequests":{"type":"integer"},"consentCategoryId":{"$ref":"#/components/schemas/ConsentCategoryId"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"}}}}},"components/schemas/ConsentCategoryLabel":{"id":"components/schemas/ConsentCategoryLabel","kind":"json-schema","title":"ConsentCategoryLabel","data":{"description":"DTO for label assigned to a Consent Category","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"components/schemas/EmailInboxId":{"id":"components/schemas/EmailInboxId","kind":"json-schema","title":"EmailInboxId","data":{"type":"integer"}},"components/schemas/CensusId":{"id":"components/schemas/CensusId","kind":"json-schema","title":"CensusId","data":{"type":"integer","format":"int64"}},"components/schemas/InitiatorHierarchyNodeDTO":{"id":"components/schemas/InitiatorHierarchyNodeDTO","kind":"json-schema","title":"InitiatorHierarchyNodeDTO","data":{"allOf":[{"$ref":"#/components/schemas/InitiatorRelationshipStrength"},{"type":"object","properties":{"aggregatedLoadTime":{"type":"integer"},"name":{"type":"string"},"size":{"type":"integer"},"relationshipStrength":{"$ref":"#/components/schemas/InitiatorRelationshipStrength"},"tagName":{"type":"string"},"tagId":{"type":"integer"},"url":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/InitiatorHierarchyNodeDTO"}},"substitution":{"$ref":"#/components/schemas/Substitution"},"requestBlocking":{"$ref":"#/components/schemas/RequestBlocking"}}}]}},"components/schemas/LocationData":{"id":"components/schemas/LocationData","kind":"json-schema","title":"LocationData","data":{"type":"object","required":["country"],"properties":{"country":{"type":"string"}}}},"components/schemas/TagProperties":{"id":"components/schemas/TagProperties","kind":"json-schema","title":"TagProperties","data":{"type":"object","description":"Tag information object containing category and tag details","properties":{"tagCategoryId":{"type":"integer","description":"Tag category ID"},"tagCategoryName":{"type":"string","description":"Tag category name"},"tagId":{"type":"integer","description":"Tag ID"},"tagName":{"type":"string","description":"Tag name"}}}},"components/schemas/WebJourneyActionRequestResponse":{"id":"components/schemas/WebJourneyActionRequestResponse","kind":"json-schema","title":"WebJourneyActionRequestResponse","data":{"type":"object","properties":{"pageref":{"type":"string"},"startedDateTime":{"type":"string","format":"date-time","description":"The full date and time, according to ISO-8601 (e. g. 2020-08-25T21:15:43Z)"},"time":{"type":"integer","minimum":0,"description":"Request's duration in milliseconds"},"request":{"$ref":"#/components/schemas/HarRequest"},"response":{"$ref":"#/components/schemas/HarResponse"},"cache":{"$ref":"#/components/schemas/HarCache"},"timings":{"$ref":"#/components/schemas/HarEntryTimings"},"serverIPAddress":{"type":"string"},"connection":{"type":"string"},"comment":{"type":"string"},"resourceType":{"type":"string","description":"Resource type (script, xhr, image, document, font, ping, etc.)"},"locationData":{"$ref":"#/components/schemas/LocationData"},"tag":{"$ref":"#/components/schemas/TagProperties"},"tagId":{"type":"integer"}}}},"components/schemas/InitiatorRelationshipStrength":{"id":"components/schemas/InitiatorRelationshipStrength","kind":"json-schema","title":"InitiatorRelationshipStrength","data":{"type":"string","enum":["low","medium","high"]}},"components/schemas/InitiatorsPageRequest":{"id":"components/schemas/InitiatorsPageRequest","kind":"json-schema","title":"InitiatorsPageRequest","data":{"required":["runId"],"properties":{"pageId":{"$ref":"#/components/schemas/PageId"},"runId":{"$ref":"#/components/schemas/RunId"},"url":{"type":"string"}}}},"components/schemas/Frequency":{"id":"components/schemas/Frequency","kind":"json-schema","title":"Frequency","data":{"type":"string","description":"combination of journey and audit frequency","enum":["paused","once","15 minutes","1 hour","6 hours","12 hours","daily","weekly","biweekly","monthly","quarterly","semiannually","yearly"]}},"components/schemas/BaseScheduleForCreation":{"id":"components/schemas/BaseScheduleForCreation","kind":"json-schema","title":"BaseScheduleForCreation","data":{"required":["dtStart","tzId","recurrenceRule","isPaused"],"properties":{"dtStart":{"type":"string","description":"Date of first desired start (if in range of recurrence rule)."},"tzId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timezone identifier compliant with tz database (ex. America/New_York). https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"},"children":[]}]}]}]},"recurrenceRule":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string."},"children":[]}]}]}]},"isPaused":{"type":"boolean","description":"Whether the schedule is paused or not."}}}},"components/schemas/ScheduleWithExceptionsAndDescription":{"id":"components/schemas/ScheduleWithExceptionsAndDescription","kind":"json-schema","title":"ScheduleWithExceptionsAndDescription","data":{"required":["description"],"type":"object","description":"Schedule object with exception dates for the calendar endpoint.","allOf":[{"$ref":"#/components/schemas/ScheduleWithExceptions"},{"type":"object","properties":{"description":{"type":"string","description":"A description of the schedule."}}}]}},"components/schemas/ScheduleWithExceptions":{"id":"components/schemas/ScheduleWithExceptions","kind":"json-schema","title":"ScheduleWithExceptions","data":{"required":["dtStart","tzId","recurrenceRule","isPaused","exceptions"],"type":"object","description":"Schedule object with exception dates for the calendar endpoint.","allOf":[{"$ref":"#/components/schemas/BaseScheduleForCreation"},{"type":"object","properties":{"exceptions":{"description":"List of dates to skip when scheduling.","type":"array","items":{"$ref":"#/components/schemas/ISO8601LocalDateTime"}}}}]}},"components/schemas/Schedule":{"id":"components/schemas/Schedule","kind":"json-schema","title":"Schedule","data":{"type":"object","required":["dtStart","tzId","recurrenceRule","isPaused","description","presetType"],"allOf":[{"$ref":"#/components/schemas/BaseScheduleForCreation"},{"type":"object","properties":{"description":{"type":"string","description":"A description of the schedule."},"presetType":{"type":"string","description":"The preset type of the schedule.","enum":["12_HOUR","BIWEEKLY","SEMI_ANNUALLY","YEARLY","RUN_ONCE","15_MIN","HOURLY","6_HOUR","DAILY","WEEKLY","MONTHLY","QUARTERLY","CUSTOM","UNSCHEDULED"]}}}]}},"components/schemas/SchedulePreset":{"id":"components/schemas/SchedulePreset","kind":"json-schema","title":"SchedulePreset","data":{"type":"object","required":["freqId","friendlyName","rule","groupId"],"properties":{"freqId":{"type":"string","description":"The preset's frequency ID","example":"15_MIN"},"friendlyName":{"type":"string","description":"The preset's user-friendly name","example":"Every 15 Minutes"},"rule":{"type":"string","description":"The preset's recurrence rule","example":"FREQ=MINUTELY;INTERVAL=15"},"groupId":{"type":"string","description":"The membership ID for the group"}}}},"components/schemas/ScheduleRuleDescriptionRequest":{"id":"components/schemas/ScheduleRuleDescriptionRequest","kind":"json-schema","title":"ScheduleRuleDescriptionRequest","data":{"type":"object","required":["recurrenceRule"],"properties":{"recurrenceRule":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string."},"children":[]}]}]}]}}}},"components/schemas/ScheduleRuleDescriptionResponse":{"id":"components/schemas/ScheduleRuleDescriptionResponse","kind":"json-schema","title":"ScheduleRuleDescriptionResponse","data":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"A description of the schedule."}}}},"components/schemas/MonthFullString":{"id":"components/schemas/MonthFullString","kind":"json-schema","title":"MonthFullString","data":{"type":"string","enum":["January","February","March","April","May","June","July","August","September","October","November","December"]}},"components/schemas/UserEvents_ResponseDTO":{"id":"components/schemas/UserEvents_ResponseDTO","kind":"json-schema","title":"UserEvents_ResponseDTO","data":{"type":"object","properties":{"nextPage":{"type":"boolean","description":"true if there are more pages of data to return"},"userEvents":{"items":{"$ref":"#/components/schemas/UserEvent_ItemDTO"}}}}},"components/schemas/UserEvent_ItemDTO":{"id":"components/schemas/UserEvent_ItemDTO","kind":"json-schema","title":"UserEvent_ItemDTO","data":{"description":"event log by user","type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"userName":{"type":"string"},"eventType":{"$ref":"#/components/schemas/UserEventTypeApi"},"itemType":{"$ref":"#/components/schemas/UserEventItemTypeApi"},"itemId":{"type":"integer"},"itemName":{"type":"string"},"eventTimeStamp":{"type":"string","format":"date-time"}}}},"components/schemas/UserEvent":{"id":"components/schemas/UserEvent","kind":"json-schema","title":"UserEvent","data":{"description":"event log by user","type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"userName":{"type":"string"},"eventType":{"$ref":"#/components/schemas/UserEventTypeApi"},"itemType":{"$ref":"#/components/schemas/UserEventItemTypeApi"},"itemId":{"type":"integer"},"itemName":{"type":"string"},"eventTimeStamp":{"type":"string","format":"date-time"}}}},"components/schemas/UserEventTypeApi":{"id":"components/schemas/UserEventTypeApi","kind":"json-schema","title":"UserEventTypeApi","data":{"type":"string","enum":["created","deleted","run-requested","uploaded","edited","overage-enabled","overage-disabled","undeleted"]}},"components/schemas/UserEventItemTypeApi":{"id":"components/schemas/UserEventItemTypeApi","kind":"json-schema","title":"UserEventItemTypeApi","data":{"type":"string","enum":["audit","web-journey","mobile-journey","mobile-app-file","folder","subfolder","consent-category","account","email-inbox","grid-saved-report","custom-http-header-group"]}},"components/schemas/UserEventSortByEnum":{"id":"components/schemas/UserEventSortByEnum","kind":"json-schema","title":"UserEventSortByEnum","data":{"type":"string","enum":["userId","userName","eventType","itemId","itemName","eventTimeStamp"],"default":"eventTimeStamp"}},"components/schemas/PatchDocument_RequestDTO":{"id":"components/schemas/PatchDocument_RequestDTO","kind":"json-schema","title":"PatchDocument_RequestDTO","data":{"type":"array","items":{"$ref":"#/components/schemas/PatchDocument_ItemDTO"}}},"components/schemas/PatchDocument_ItemDTO":{"id":"components/schemas/PatchDocument_ItemDTO","kind":"json-schema","title":"PatchDocument_ItemDTO","data":{"description":"A JSONPatch document as defined by RFC 6902","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"]},"path":{"type":"string","description":"A JSON-Pointer"},"value":{"type":"object","description":"The value to be used within the operations."},"from":{"type":"string","description":"A string containing a JSON Pointer value."}}}},"components/schemas/AttachmentPatchDocument_RequestDTO":{"id":"components/schemas/AttachmentPatchDocument_RequestDTO","kind":"json-schema","title":"AttachmentPatchDocument_RequestDTO","data":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentPatchDocument_ItemDTO"}}},"components/schemas/AttachmentPatchDocument_ItemDTO":{"id":"components/schemas/AttachmentPatchDocument_ItemDTO","kind":"json-schema","title":"AttachmentPatchDocument_ItemDTO","data":{"description":"A JSONPatch document for modifying consent preference attachments","properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove"]},"path":{"type":"string"},"value":{"type":"integer","description":"id of the item to assign"}},"example":[{"op":"add","path":"/-","value":1},{"op":"remove","path":"/","value":2}]}},"components/schemas/ConsentCategory_TypeEnum":{"id":"components/schemas/ConsentCategory_TypeEnum","kind":"json-schema","title":"ConsentCategory_TypeEnum","data":{"type":"string","enum":["approved","unapproved"]}},"components/schemas/ConsentCategory_Cmp_Data":{"id":"components/schemas/ConsentCategory_Cmp_Data","kind":"json-schema","title":"ConsentCategory_Cmp_Data","data":{"type":"object","required":["cmpVendor","oneTrustCookieGroupDomain","oneTrustCookieGroupId","oneTrustCookieGroupGeo"],"properties":{"cmpVendor":{"$ref":"#/components/schemas/ConsentCategory_VendorTypeEnum"},"oneTrustCookieGroupDescription":{"type":"string","description":"The OneTrust provided description of the group"},"oneTrustCookieGroupDomain":{"type":"string","description":"The domain reported by OneTrust for which the consent group applies","example":"observepoint.com"},"oneTrustCookieGroupId":{"type":"string","description":"The OneTrust ID for the group","example":"C001"},"oneTrustCookieGroupGeo":{"type":"string","description":"The geographic location for which the consent group applies","example":"us, ut"},"sourceUrl":{"type":"string","description":"The full URL of the page where the CMP import was run","example":"https://example.com"}}}},"components/schemas/ConsentCategory_VendorTypeEnum":{"id":"components/schemas/ConsentCategory_VendorTypeEnum","kind":"json-schema","title":"ConsentCategory_VendorTypeEnum","data":{"type":"string","enum":["ONE_TRUST"]}},"components/schemas/ConsentCategory_updatedType":{"id":"components/schemas/ConsentCategory_updatedType","kind":"json-schema","title":"ConsentCategory_updatedType","data":{"type":"string","enum":["ONETRUST_IMPORT","FILE_IMPORT","APP_CREATE"]}},"components/schemas/ConsentCategory_CreateRequestDTO":{"id":"components/schemas/ConsentCategory_CreateRequestDTO","kind":"json-schema","title":"ConsentCategory_CreateRequestDTO","data":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","minLength":1},"notes":{"type":"string"},"type":{"$ref":"#/components/schemas/ConsentCategory_TypeEnum"},"isDefaultCC":{"type":"boolean","description":"If true, this is the default consent category"},"cmpData":{"$ref":"#/components/schemas/ConsentCategory_Cmp_Data"}}}},"components/schemas/ConsentCategory_UpdateRequestDTO":{"id":"components/schemas/ConsentCategory_UpdateRequestDTO","kind":"json-schema","title":"ConsentCategory_UpdateRequestDTO","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1},"notes":{"type":"string"},"isDefaultCC":{"type":"boolean","description":"If true, this is the default consent category"},"cmpData":{"$ref":"#/components/schemas/ConsentCategory_Cmp_Data"}}}},"components/schemas/ConsentCategoriesResponseDTO":{"id":"components/schemas/ConsentCategoriesResponseDTO","kind":"json-schema","title":"ConsentCategoriesResponseDTO","data":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"consentCategories":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategoryDTO"}}}}},"components/schemas/ConsentCategoryDTO":{"id":"components/schemas/ConsentCategoryDTO","kind":"json-schema","title":"ConsentCategoryDTO","data":{"type":"object","properties":{"name":{"type":"string"},"notes":{"type":"string"},"type":{"$ref":"#/components/schemas/ConsentCategory_TypeEnum"},"id":{"$ref":"#/components/schemas/ConsentCategoryId"},"isDefaultCC":{"type":"boolean","description":"If true, this is the default consent category"},"cmpData":{"$ref":"#/components/schemas/ConsentCategory_Cmp_Data"},"updatedType":{"$ref":"#/components/schemas/ConsentCategory_updatedType"},"updatedAt":{"type":"string","format":"date-time","description":"The last time this consent category was updated in UTC timezone"}}}},"components/schemas/ConsentCategorySnapshotDTO":{"id":"components/schemas/ConsentCategorySnapshotDTO","kind":"json-schema","title":"ConsentCategorySnapshotDTO","data":{"type":"object","description":"A consent category snapshot dto","required":["name","type","consentCategoryId","consentCategorySnapshotId","consentCategoryConfigExists"],"properties":{"name":{"type":"string"},"notes":{"type":"string"},"type":{"$ref":"#/components/schemas/ConsentCategory_TypeEnum"},"consentCategoryId":{"$ref":"#/components/schemas/ConsentCategoryId"},"consentCategorySnapshotId":{"$ref":"#/components/schemas/ConsentCategorySnapshotId"},"consentCategoryConfigExists":{"type":"boolean","description":"If false, the consent category config doesn't exist anymore"}}}},"components/schemas/ConsentCategory_LibraryResponseDTO":{"id":"components/schemas/ConsentCategory_LibraryResponseDTO","kind":"json-schema","title":"ConsentCategory_LibraryResponseDTO","data":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"consentCategories":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategory_LibraryItemDTO"}}}}},"components/schemas/ConsentCategory_LibraryItemDTO":{"id":"components/schemas/ConsentCategory_LibraryItemDTO","kind":"json-schema","title":"ConsentCategory_LibraryItemDTO","data":{"allOf":[{"$ref":"#/components/schemas/ConsentCategoryDTO"},{"type":"object","properties":{"itemCounts":{"$ref":"#/components/schemas/ConsentCategory_ItemCountsDTO"},"auditCount":{"description":"the number of audits this consent category is assigned to","type":"integer"},"labelIds":{"type":"array","items":{"type":"integer"}}}}]}},"components/schemas/ConsentCategoryLibrarySortByEnum":{"id":"components/schemas/ConsentCategoryLibrarySortByEnum","kind":"json-schema","title":"ConsentCategoryLibrarySortByEnum","data":{"type":"string","default":"name","enum":["name","type","updated_at"]}},"components/schemas/ConsentCategory_ItemCountsDTO":{"id":"components/schemas/ConsentCategory_ItemCountsDTO","kind":"json-schema","title":"ConsentCategory_ItemCountsDTO","data":{"type":"object","properties":{"tags":{"description":"the number of tags in this consent category","type":"integer"},"cookies":{"description":"the number of cookies in this consent category","type":"integer"},"requestDomainsAndGeos":{"description":"the number of request domain/geo location pairs in this consent category","type":"integer"}}}},"components/schemas/ConsentCategory_TagEntryResponseDTO":{"id":"components/schemas/ConsentCategory_TagEntryResponseDTO","kind":"json-schema","title":"ConsentCategory_TagEntryResponseDTO","data":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategory_TagEntryItemDTO"}}}}},"components/schemas/ConsentCategory_TagEntryItemDTO":{"id":"components/schemas/ConsentCategory_TagEntryItemDTO","kind":"json-schema","title":"ConsentCategory_TagEntryItemDTO","data":{"description":"DTO for tag under a consent category bucket","type":"object","required":["tagId","accounts"],"properties":{"tagId":{"type":"integer","nullable":false},"anyAccount":{"type":"boolean","default":false},"accounts":{"type":"array","uniqueItems":true,"nullable":false,"default":[],"items":{"type":"string","format":"text","minLength":1}}}}},"components/schemas/ConsentCategory_RequestDomainResponseDTO":{"id":"components/schemas/ConsentCategory_RequestDomainResponseDTO","kind":"json-schema","title":"ConsentCategory_RequestDomainResponseDTO","data":{"type":"object","properties":{"requestDomains":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategory_RequestDomainItemDTO"}}}}},"components/schemas/ConsentCategory_RequestDomainItemDTO":{"id":"components/schemas/ConsentCategory_RequestDomainItemDTO","kind":"json-schema","title":"ConsentCategory_RequestDomainItemDTO","data":{"description":"DTO for request domain under a consent category","type":"object","required":["domainType"],"properties":{"domain":{"type":"string"},"domainType":{"$ref":"#/components/schemas/RequestDomainMatchType"},"locationIds":{"description":"geo location ids","type":"array","items":{"type":"integer"}},"anyLocation":{"description":"true if request domain should apply to any location","type":"boolean"}}}},"components/schemas/RequestDomainMatchType":{"id":"components/schemas/RequestDomainMatchType","kind":"json-schema","title":"RequestDomainMatchType","data":{"type":"string","enum":["domain_any","domain_regex","domain_exact_match"]}},"components/schemas/ConsentCategory_WebAudits_ResponseDTO":{"id":"components/schemas/ConsentCategory_WebAudits_ResponseDTO","kind":"json-schema","title":"ConsentCategory_WebAudits_ResponseDTO","data":{"type":"object","properties":{"webAudits":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategory_WebAudits_ItemDTO"}}}}},"components/schemas/ConsentCategory_WebAudits_ItemDTO":{"id":"components/schemas/ConsentCategory_WebAudits_ItemDTO","kind":"json-schema","title":"ConsentCategory_WebAudits_ItemDTO","data":{"type":"object","properties":{"auditId":{"type":"integer"},"auditName":{"type":"string"},"domain":{"type":"string"},"createdBy":{"type":"integer"},"access":{"type":"boolean"},"lastRun":{"type":"string","format":"date-time"}}}},"components/schemas/ConsentCategory_CookieEntryResponseDTO":{"id":"components/schemas/ConsentCategory_CookieEntryResponseDTO","kind":"json-schema","title":"ConsentCategory_CookieEntryResponseDTO","data":{"description":"DTO for cookie entry response","type":"object","required":["cookies"],"properties":{"cookies":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategory_CookieEntryItemDTO"}}}}},"components/schemas/ConsentCategory_CookieEntryItemDTO":{"id":"components/schemas/ConsentCategory_CookieEntryItemDTO","kind":"json-schema","title":"ConsentCategory_CookieEntryItemDTO","data":{"description":"DTO For Cookie under a consent preference bucket","type":"object","properties":{"nameType":{"$ref":"#/components/schemas/CookieNameMatchType"},"name":{"type":"string","nullable":false},"domainType":{"$ref":"#/components/schemas/CookieDomainMatchType"},"domain":{"type":"string","nullable":false},"cookieDescription":{"type":"string"}}}},"components/schemas/CookieNameMatchType":{"id":"components/schemas/CookieNameMatchType","kind":"json-schema","title":"CookieNameMatchType","data":{"type":"string","enum":["name_any","name_regex","name_exact_match"]}},"components/schemas/CookieDomainMatchType":{"id":"components/schemas/CookieDomainMatchType","kind":"json-schema","title":"CookieDomainMatchType","data":{"type":"string","enum":["domain_any","domain_regex","domain_exact_match"]}},"components/schemas/WebAudit_ConsentCategories_ResponseDTO":{"id":"components/schemas/WebAudit_ConsentCategories_ResponseDTO","kind":"json-schema","title":"WebAudit_ConsentCategories_ResponseDTO","data":{"type":"object","required":["consentCategories"],"properties":{"consentCategories":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategoryDTO"}}}}},"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO":{"id":"components/schemas/WebAudit_ConsentCategorySnapshots_ResponseDTO","kind":"json-schema","title":"WebAudit_ConsentCategorySnapshots_ResponseDTO","data":{"type":"object","description":"NOTE: For individual consent category snapshot, Field consentCategoryId is omitted when the consent category is deleted","properties":{"consentCategorySnapshots":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategorySnapshotDTO"}}}}},"components/schemas/LabelResponseDTO":{"id":"components/schemas/LabelResponseDTO","kind":"json-schema","title":"LabelResponseDTO","data":{"description":"DTO for get/patch labels","type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"}}}}},"components/schemas/FolderDomainFilter":{"id":"components/schemas/FolderDomainFilter","kind":"json-schema","title":"FolderDomainFilter","data":{"type":"object","description":"non-empty array of folders with domains (subfolders), items from which will be included in response","required":["folders"],"properties":{"folders":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/FolderDomainFilterItem"}}}}},"components/schemas/FolderDomainFilterItem":{"id":"components/schemas/FolderDomainFilterItem","kind":"json-schema","title":"FolderDomainFilterItem","data":{"type":"object","required":["folderId"],"properties":{"folderId":{"$ref":"#/components/schemas/FolderId"},"domains":{"type":"array","description":"null or empty array of domains (subfolders) present on an item, works as \"null or empty if entire folder (all domains in a folder), otherwise specific domain IDs\"","items":{"$ref":"#/components/schemas/DomainId"}}}}},"components/schemas/Label":{"id":"components/schemas/Label","kind":"json-schema","title":"Label","data":{"description":"DTO for Labels","type":"object","required":["id","name"],"properties":{"id":{"$ref":"#/components/schemas/LabelId"},"name":{"type":"string","nullable":false}}}},"components/schemas/RuleLibrary_RequestDTO":{"id":"components/schemas/RuleLibrary_RequestDTO","kind":"json-schema","title":"RuleLibrary_RequestDTO","data":{"type":"object","description":"Filters supported by Rule Library","properties":{"id":{"$ref":"#/components/schemas/RuleId"},"ruleName":{"type":"string","example":"Filter by rule name. Matched as contains, case insensitive."},"labels":{"type":"array","items":{"$ref":"#/components/schemas/LabelId"}},"notificationEnabled":{"type":"boolean"},"createdByUserId":{"$ref":"#/components/schemas/UserId"},"fromTemplate":{"type":"boolean"}}}},"components/schemas/RuleLibrary_SortColumn":{"id":"components/schemas/RuleLibrary_SortColumn","kind":"json-schema","title":"RuleLibrary_SortColumn","data":{"type":"string","enum":["NAME","TYPE","AUDITS","WEB_JOURNEYS","APP_JOURNEYS","OWNER","MODIFIED_AT"]}},"components/schemas/RuleLibrary_ResponseDTO":{"id":"components/schemas/RuleLibrary_ResponseDTO","kind":"json-schema","title":"RuleLibrary_ResponseDTO","data":{"type":"object","properties":{"paginationMetadata":{"$ref":"#/components/schemas/PaginationMetadata"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleLibrary_RuleItem"}}}}},"components/schemas/RuleLibrary_RuleItem":{"id":"components/schemas/RuleLibrary_RuleItem","kind":"json-schema","title":"RuleLibrary_RuleItem","data":{"type":"object","required":["id","name","fromTemplate","labels","usage","ownedByUserId","updatedAt"],"properties":{"id":{"$ref":"#/components/schemas/RuleId"},"name":{"type":"string"},"fromTemplate":{"type":"boolean"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/AssignedLabel"}},"usage":{"$ref":"#/components/schemas/RuleLibrary_RuleUsage"},"ownedByUserId":{"$ref":"#/components/schemas/UserId"},"updatedAt":{"$ref":"#/components/schemas/DateAndTime"},"recipients":{"type":"array","items":{"type":"string"}}}}},"components/schemas/RuleLibrary_RuleUsage":{"id":"components/schemas/RuleLibrary_RuleUsage","kind":"json-schema","title":"RuleLibrary_RuleUsage","data":{"type":"object","required":["auditCount","webJourneyCount","appJourneyCount"],"properties":{"auditCount":{"type":"integer","example":0},"webJourneyCount":{"type":"integer","example":3},"appJourneyCount":{"type":"integer","example":1}}}},"components/schemas/AssignedLabel":{"id":"components/schemas/AssignedLabel","kind":"json-schema","title":"AssignedLabel","data":{"type":"object","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/LabelId"}}}},"components/schemas/AuditRun_ActionSnapshotsResponseDTO":{"id":"components/schemas/AuditRun_ActionSnapshotsResponseDTO","kind":"json-schema","title":"AuditRun_ActionSnapshotsResponseDTO","data":{"type":"object","required":["preAuditActionSnapshots","onPageActionSnapshots"],"properties":{"preAuditActionSnapshots":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_ActionSnapshotDTO"}},"onPageActionSnapshots":{"type":"array","items":{"$ref":"#/components/schemas/AuditRun_ActionSnapshotDTO"}}}}},"components/schemas/AuditRun_RunNowRequestDTO":{"id":"components/schemas/AuditRun_RunNowRequestDTO","kind":"json-schema","title":"AuditRun_RunNowRequestDTO","data":{"type":"object","required":["callbackWorkflowEventType","callbackRepositoryOwner","callbackRepositoryName"],"properties":{"startingUrls":{"nullable":true,"minItems":0,"type":"array","items":{"type":"string"}},"callbackWorkflowEventType":{"type":"string","description":"The workflow file to be used in for starting the callback workflow\nHas to be a file name without extension, e.g. \"audit-complete\" instead of \"audit-complete.yml\"\n"},"callbackRepositoryOwner":{"type":"string","description":"The owner of the repository where the callback workflow is defined\nThis is required to correctly invoke the callback workflow\n"},"callbackRepositoryName":{"type":"string","description":"The name of the repository where the callback workflow is defined\nThis is required to correctly invoke the callback workflow\n"},"callbackContext":{"type":"object","description":"Contains a context for the callback URL to be used in the run\n"},"maxPages":{"type":"integer","nullable":true,"description":"Maximum number of pages to scan during the audit run.\nIf not provided, will default to the count of starting URLs if it exceeds the current audit configuration limit.\n"},"ghAppName":{"description":"GitHub App to use for the callback workflow dispatch.\nDefaults to observepoint-integration if not specified (handled in service layer).\n","allOf":[{"$ref":"#/components/schemas/GhAppNameEnum"}]}}}},"components/schemas/AuditRun_ConfigurationInfoResponseDTO":{"id":"components/schemas/AuditRun_ConfigurationInfoResponseDTO","kind":"json-schema","title":"AuditRun_ConfigurationInfoResponseDTO","data":{"type":"object","required":["blockThirdPartyCookies","browserName","browserVersion","customProxy","filters","gpcEnabled","height","loginActions","locationId","locationName","onPageActions","privacyConsentActions","runDuration","scanSpeed","startingUrlCount","urlsScanned","userAgent","vpnEnabled","width","technologyBlockingEnabled","fileSubstitutionConfigured","discoverSitemaps","customHeadersApplied"],"properties":{"blockThirdPartyCookies":{"type":"boolean","description":"When true the browser blocks all third-party cookies"},"browserName":{"type":"string","description":"Browser name"},"browserVersion":{"type":"string","description":"Browser version"},"customProxy":{"type":"string","description":"The custom proxy used for the audit"},"discoverSitemaps":{"type":"boolean","description":"When true, the audit discovers sitemaps on any domains for starting URLs and uses those to find URLs to scan"},"sitemapData":{"$ref":"#/components/schemas/AuditRun_SitemapData"},"filters":{"type":"object","description":"Filters used for the audit to include and exclude urls to be scanned","required":["includeFilters","excludeFilters"],"properties":{"includeFilters":{"type":"array","items":{"type":"string","format":"regex","example":"^https?://([^/:\\?]*\\.)?google.com"},"description":"List of include filters"},"excludeFilters":{"type":"array","items":{"type":"string","format":"regex","example":"/careers"},"description":"List of exclude filters"}}},"gpcEnabled":{"type":"boolean","description":"GPC enabled or not"},"height":{"type":"integer","description":"Browser height in pixels"},"loginActions":{"type":"boolean","description":"Pre-Audit Actions present in configuration or not"},"locationId":{"type":"integer","description":"Location (Proxy) ID, this maps to a location in the location table"},"locationName":{"type":"string","description":"Location  human readable name. This field maps to the db location.label","example":"England, London"},"onPageActions":{"type":"boolean","description":"On Page Actions present in configuration or not"},"privacyConsentActions":{"type":"boolean","description":"Privacy Consent Actions present in configuration or not"},"runDuration":{"type":"integer","description":"Run duration in seconds"},"scanSpeed":{"type":"integer","description":"Scan speed is the number of engines the customer requests to run the audit with\nCurrently a value between 1-50 is supported, but not guaranteed.\n"},"startingUrlCount":{"type":"number"},"urlsScanned":{"type":"integer","description":"Number of URLs scanned"},"userAgent":{"type":"string","description":"User agent"},"vpnEnabled":{"type":"boolean","description":"VPN enabled or not for the run configuration "},"width":{"type":"integer","description":"Browser width in pixels"},"technologyBlockingEnabled":{"type":"boolean","description":"Tag ID/Tag Category ID blocking enabled or not"},"fileSubstitutionConfigured":{"type":"boolean","description":"File Substitution configured or not"},"customHeadersApplied":{"type":"boolean","description":"Custom HTTP headers applied or not"},"auditStoppedByUserId":{"type":"integer","format":"int64","description":"ID of the user who stopped the audit run early, if applicable","nullable":true}}}},"components/schemas/AuditRun_SitemapData":{"id":"components/schemas/AuditRun_SitemapData","kind":"json-schema","title":"AuditRun_SitemapData","data":{"type":"object","description":"Data about sitemaps that were discovered and visited by the audit","properties":{"sitemapsScannedCount":{"type":"integer","description":"Number of sitemaps visited successfully by the audit"},"sitemapsScanned":{"type":"array","description":"List of sitemaps visited successfully by the audit","items":{"$ref":"#/components/schemas/AuditRun_SitemapDataItem"}},"sitemapsBrokenCount":{"type":"integer","description":"Number of sitemaps that were found, but could not be visited by the audit"},"sitemapsBrokenUrls":{"type":"array","items":{"type":"string","format":"url","example":"https://www.example.com/sitemap.xml"},"description":"List of sitemap URLs that could not be visited"}}}},"components/schemas/AuditRun_SitemapDataItem":{"id":"components/schemas/AuditRun_SitemapDataItem","kind":"json-schema","title":"AuditRun_SitemapDataItem","data":{"type":"object","required":["sitemapUrl","urlsFound"],"properties":{"sitemapUrl":{"type":"string"},"urlsFound":{"type":"integer"}}}},"components/schemas/AuditRun_ActionSnapshotDTO":{"id":"components/schemas/AuditRun_ActionSnapshotDTO","kind":"json-schema","title":"AuditRun_ActionSnapshotDTO","data":{"type":"object","required":["actionSnapshotId","sequenceId","actionType"],"properties":{"actionSnapshotId":{"type":"integer"},"sequenceId":{"type":"integer"},"actionType":{"type":"integer"},"description":{"type":"string"}}}},"components/schemas/WebJourneyRun_ConfigurationInfoResponseDTO":{"id":"components/schemas/WebJourneyRun_ConfigurationInfoResponseDTO","kind":"json-schema","title":"WebJourneyRun_ConfigurationInfoResponseDTO","data":{"type":"object","required":["browserName","browserVersion","width","height","userAgent","locationId","privacyConsentActions","vpnEnabled","gpcEnabled","technologyBlockingEnabled","fileSubstitutionConfigured","blockThirdPartyCookies","customHeadersApplied"],"properties":{"browserName":{"type":"string","description":"Browser name"},"browserVersion":{"type":"string","description":"Browser version"},"width":{"type":"integer","description":"Browser width in pixels"},"height":{"type":"integer","description":"Browser height in pixels"},"userAgent":{"type":"string","description":"User agent"},"locationId":{"type":"integer","description":"Location  ID, this maps to a location in the location table"},"customProxy":{"type":"string","description":"Custom proxy used for the run, if supplied by the user.","example":"http://90.90.90.90:8888"},"privacyConsentActions":{"type":"boolean","description":"Privacy Consent Actions present in configuration or not"},"vpnEnabled":{"type":"boolean","description":"VPN enabled or not for the run configuration"},"gpcEnabled":{"type":"boolean","description":"GPC enabled or not"},"technologyBlockingEnabled":{"type":"boolean","description":"Tag ID/Tag Category ID blocking enabled or not"},"fileSubstitutionConfigured":{"type":"boolean","description":"File Substitution configured or not"},"blockThirdPartyCookies":{"type":"boolean","description":"Block third party cookies or not"},"customHeadersApplied":{"type":"boolean","description":"Custom HTTP headers applied or not"}}}},"components/schemas/BlockingConfig_DTO":{"id":"components/schemas/BlockingConfig_DTO","kind":"json-schema","title":"BlockingConfig_DTO","data":{"type":"object","description":"The blocking configuration to be applied to the Audit or Journey.","properties":{"tagIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optional) Present when blockingType is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a list of tag ids to block"},"children":[]}]}]}],"type":"array","items":{"type":"integer"}},"tagCategoryIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optional) Present when blockingType is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a list of tag category ids to block"},"children":[]}]}]}],"type":"array","items":{"type":"integer"}}}}},"components/schemas/EmailInboxResponseDTO":{"id":"components/schemas/EmailInboxResponseDTO","kind":"json-schema","title":"EmailInboxResponseDTO","data":{"type":"object","required":["id","emailAddress","labelIds","name","linkExclusionFilters","omitSocialLinks"],"properties":{"id":{"type":"integer","format":"int64","example":10},"labelIds":{"description":"The ids of the labels associated to the Email Inbox","type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/LabelId"}},"name":{"type":"string","example":"Christmas Marketing Campaign"},"emailAddress":{"description":"The email address that has been assigned to the inbox","type":"string","example":"scanTest+<8^[a-z0-9]>@email.observepoint.com"},"notes":{"type":"string"},"subscribers":{"$ref":"#/components/schemas/EmailInboxSubscribersDTO"},"linkExclusionFilters":{"type":"array","items":{"$ref":"#/components/schemas/EmailInboxLinkExclusionFilters"}},"omitSocialLinks":{"type":"boolean"}}}},"components/schemas/EmailInboxLinkExclusionFilters":{"id":"components/schemas/EmailInboxLinkExclusionFilters","kind":"json-schema","title":"EmailInboxLinkExclusionFilters","data":{"description":"A regex to be used to exclude links in email scans.","type":"string"}},"components/schemas/EmailInboxSubscribersDTO":{"id":"components/schemas/EmailInboxSubscribersDTO","kind":"json-schema","title":"EmailInboxSubscribersDTO","data":{"type":"object","properties":{"onReceived":{"type":"array","items":{"type":"string","description":"Email address subscribers to be alerted on email message received."}},"onProcessed":{"type":"array","items":{"type":"string","description":"Email address subscribers to be alerted on email message processed."}}}}},"components/schemas/EmailInboxLibraryDTO":{"id":"components/schemas/EmailInboxLibraryDTO","kind":"json-schema","title":"EmailInboxLibraryDTO","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":10},"labelIds":{"description":"The ids of the labels associated to the Email Inbox","type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/LabelId"}},"name":{"type":"string","example":"Christmas Marketing Campaign"},"emailAddress":{"description":"The email address that has been assigned to the inbox","type":"string","example":"scanTest+<8^[a-z0-9]>@email.observepoint.com"},"notes":{"type":"string"},"messagesReceived":{"description":"The number of messages received by the Email Inbox","type":"integer","default":0},"lastMessageReceived":{"$ref":"#/components/schemas/DateAndTime"},"testScenariosCount":{"description":"The number of test scenarios performed against the email landing pages.","type":"integer"}}}},"components/schemas/EmailInboxLibraryResponseDTO":{"id":"components/schemas/EmailInboxLibraryResponseDTO","kind":"json-schema","title":"EmailInboxLibraryResponseDTO","data":{"type":"object","required":["metadata","emailInboxes"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"emailInboxes":{"type":"array","items":{"$ref":"#/components/schemas/EmailInboxLibraryDTO"}}}}},"components/schemas/EmailInboxConfigurationDTO":{"id":"components/schemas/EmailInboxConfigurationDTO","kind":"json-schema","title":"EmailInboxConfigurationDTO","data":{"type":"object","required":["auditId","auditName","auditLastRunAt","auditLabels"],"properties":{"auditId":{"$ref":"#/components/schemas/AuditId"},"auditName":{"type":"string","description":"Name of audit/WJ etc"},"auditLastRunAt":{"$ref":"#/components/schemas/DateAndTime"},"auditLabels":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/LabelId"}}}}},"components/schemas/EmailInboxRequestDTO":{"id":"components/schemas/EmailInboxRequestDTO","kind":"json-schema","title":"EmailInboxRequestDTO","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Adove Campaign Holidays, Marketing Department"},"notes":{"type":"string"},"labelIds":{"description":"The ids of the labels to be associated to the Email Inbox","type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/LabelId"}},"subscribers":{"$ref":"#/components/schemas/EmailInboxSubscribersDTO"},"linkExclusionFilters":{"type":"array","items":{"$ref":"#/components/schemas/EmailInboxLinkExclusionFilters"}},"omitSocialLinks":{"type":"boolean"}}}},"components/schemas/EmailInboxLibraryRequestDTO":{"id":"components/schemas/EmailInboxLibraryRequestDTO","kind":"json-schema","title":"EmailInboxLibraryRequestDTO","data":{"type":"object","properties":{"name":{"type":"string","example":"Adobe Campaign Holidays, Marketing Department"},"emailAddress":{"type":"string","example":"scanTest+<8^[a-z0-9]>-<truncatedInboxName>@email.observepoint.com"},"auditIds":{"description":"The ids of the audits to be associated to the Email Inbox","type":"array","items":{"type":"integer","format":"int64"}},"labelIds":{"description":"The ids of the labels to be associated to the Email Inbox","type":"array","items":{"$ref":"#/components/schemas/LabelId"}},"createdBy":{"description":"The ids of Email Inbox owners","type":"array","items":{"$ref":"#/components/schemas/UserId"}}}}},"components/schemas/EmailInboxLibrarySortByEnum":{"id":"components/schemas/EmailInboxLibrarySortByEnum","kind":"json-schema","title":"EmailInboxLibrarySortByEnum","data":{"type":"string","default":"name","enum":["name","emailAddress","messagesReceived","lastMessageReceived","testScenariosCount"]}},"components/schemas/ReceivedEmailMessageBaseDTO":{"id":"components/schemas/ReceivedEmailMessageBaseDTO","kind":"json-schema","title":"ReceivedEmailMessageBaseDTO","data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"integer","format":"int64","example":10},"status":{"type":"string","enum":["RECEIVED","PROCESSING","AUDITING","NOT_AUDITING","NOTIFYING","COMPLETE","FAILED","CANCELLED"],"example":"COMPLETE"},"statusReason":{"type":"string","enum":["ITEM_CONCURRENCY_REACHED","ACCOUNT_CONCURRENCY_REACHED","USER_CONCURRENCY_REACHED","USAGE_LIMIT_EXCEEDED_WHEN_OVERAGE_NOT_ALLOWED","NO_AUDITS_ASSIGNED","UNABLE_TO_PROCESS_MESSAGE","NO_LINKS_FOUND","MESSAGE_NOT_FOUND","ABORTED","UNKNOWN"],"example":"NO_AUDITS_ASSIGNED"}}}},"components/schemas/ReceivedEmailMessageDTO":{"id":"components/schemas/ReceivedEmailMessageDTO","kind":"json-schema","title":"ReceivedEmailMessageDTO","data":{"type":"object","required":["metadata","messages"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"messages":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ReceivedEmailMessageBaseDTO"},{"$ref":"#/components/schemas/ReceivedEmailMessageEntryDTO"}]}}}}},"components/schemas/ReceivedEmailMessageEntryDTO":{"id":"components/schemas/ReceivedEmailMessageEntryDTO","kind":"json-schema","title":"ReceivedEmailMessageEntryDTO","data":{"type":"object","required":["subject","receivedAt","senderEmailAddress","uniqueLinks","runs","screenshotPath","screenshotThumbnailPath"],"properties":{"receivedAt":{"$ref":"#/components/schemas/DateAndTime"},"senderEmailAddress":{"type":"string","example":"marketing@email.observepoint.com"},"subject":{"type":"string","example":"Christmas Marketing Campaign"},"uniqueLinks":{"type":"integer","format":"int64","example":317},"runs":{"type":"array","items":{"$ref":"#/components/schemas/ReceivedEmailMessageAuditInfo"}},"screenshotPath":{"type":"string","description":"A url that redirects to a time-limited screenshot of the email.","example":"/v2/screenshots?token=a.b.c"},"screenshotThumbnailPath":{"type":"string","description":"Provides a smaller resolution screenshot than the screenshot property.","example":"/v2/screenshots?token=a.b.c"}}}},"components/schemas/ReceivedEmailMessageAuditInfo":{"id":"components/schemas/ReceivedEmailMessageAuditInfo","kind":"json-schema","title":"ReceivedEmailMessageAuditInfo","data":{"type":"object","required":["auditName","auditId","runId"],"properties":{"auditName":{"type":"string","example":"Audit Name"},"auditId":{"type":"integer","example":123},"runId":{"type":"integer","example":123},"isCompleted":{"type":"boolean","description":"TRUE if the audit run is completed, otherwise FALSE"}}}},"components/schemas/CmpProviders_CookieGroupsImportRequest":{"id":"components/schemas/CmpProviders_CookieGroupsImportRequest","kind":"json-schema","title":"CmpProviders_CookieGroupsImportRequest","data":{"type":"object","required":["cmpProvider","sourceUrl","locales"],"properties":{"cmpProvider":{"type":"string","description":"The type of CMP provider expected on the sourceUrl","enum":["ONE_TRUST"]},"sourceUrl":{"type":"string","description":"The URL of the page where the CMP cookie data should be harvested","example":"https://www.example.com"},"locales":{"type":"array","items":{"$ref":"#/components/schemas/CmpProviders_Locale"}}}}},"components/schemas/CmpProviders_CookieGroupsImportResultRequest":{"id":"components/schemas/CmpProviders_CookieGroupsImportResultRequest","kind":"json-schema","title":"CmpProviders_CookieGroupsImportResultRequest","data":{"type":"object","required":["importRequestIds"],"properties":{"importRequestIds":{"type":"array","description":"The unique identifiers for the CMP import results","items":{"type":"string","format":"uuid","maxItems":500,"example":"123e4567-e89b-12d3-a456-426614174000"}}}}},"components/schemas/CmpProviders_CookieGroupsImportRequestHandles":{"id":"components/schemas/CmpProviders_CookieGroupsImportRequestHandles","kind":"json-schema","title":"CmpProviders_CookieGroupsImportRequestHandles","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/CmpProviders_CookieGroupsImportHandle"}}}}},"components/schemas/CmpProviders_CookieGroupsImportResults":{"id":"components/schemas/CmpProviders_CookieGroupsImportResults","kind":"json-schema","title":"CmpProviders_CookieGroupsImportResults","data":{"type":"object","properties":{"importResults":{"type":"object","description":"A JSON object containing the current state of CMP import results.\nThe object keys will represent each valid import request ID. Invalid request IDs will be omitted from the object.\nThe object values will be the current state of the import request for the respective import request ID.\n","additionalProperties":{"$ref":"#/components/schemas/CmpCookieGroups"}}}}},"components/schemas/CmpProviders_CookieGroupsImportHandle":{"id":"components/schemas/CmpProviders_CookieGroupsImportHandle","kind":"json-schema","title":"CmpProviders_CookieGroupsImportHandle","data":{"type":"object","required":["requestId","locale"],"properties":{"requestId":{"type":"string","format":"uuid","description":"The unique identifier for the import request associated with this handle"},"locale":{"$ref":"#/components/schemas/CmpProviders_Locale"}}}},"components/schemas/CmpProviders_Locale":{"id":"components/schemas/CmpProviders_Locale","kind":"json-schema","title":"CmpProviders_Locale","data":{"type":"string","description":"The locale of the cookie configuration. Provide an ISO-3166 alpha-2 country code. If for a US state, use 'US' followed by a comma and the state abbreviation. Example: US,CA\nAt least one locale must be provided.\n"}},"components/schemas/StartedAt":{"id":"components/schemas/StartedAt","kind":"json-schema","title":"StartedAt","data":{"type":"string","format":"datetime","description":"Date/time of when an item was started"}},"components/schemas/SubFolderId":{"id":"components/schemas/SubFolderId","kind":"json-schema","title":"SubFolderId","data":{"type":"integer","description":"The ID of the subfolder under which the WebJourney/Audit is within.\n"}},"components/schemas/CurrentlyRunningItem":{"id":"components/schemas/CurrentlyRunningItem","kind":"json-schema","title":"CurrentlyRunningItem","data":{"type":"object","description":"Run of data source item that is in progress.","properties":{"runId":{"$ref":"#/components/schemas/RunId"},"startedAt":{"$ref":"#/components/schemas/StartedAt"}}}},"components/schemas/ISO8601LocalDateTime":{"id":"components/schemas/ISO8601LocalDateTime","kind":"json-schema","title":"ISO8601LocalDateTime","data":{"type":"string","description":"ISO-8601 Formatted date time implicitly in the user's local timezone (ex: YYYY-MM-DDTHH:MM:SS/2020-10-30T12:00:00)"}},"components/schemas/ScheduledItem":{"id":"components/schemas/ScheduledItem","kind":"json-schema","title":"ScheduledItem","data":{"type":"object","description":"Base scheduled item which includes data source specific information.","properties":{"itemName":{"description":"Name of the scheduled item.","type":"string"},"itemId":{"description":"Item id of scheduled item.","type":"integer"},"itemType":{"$ref":"#/components/schemas/DataSourceItemTypeCap"},"runs":{"type":"array","items":{"$ref":"#/components/schemas/CurrentlyRunningItem"}},"futureOccurrences":{"type":"array","items":{"$ref":"#/components/schemas/ISO8601LocalDateTime"}},"folderId":{"$ref":"#/components/schemas/FolderId"},"subFolderId":{"$ref":"#/components/schemas/SubFolderId"},"userId":{"$ref":"#/components/schemas/UserId"},"labels":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/LabelId"}},"isMonitoredByScriptServices":{"type":"boolean","description":"Whether the journey is monitored by script services."},"schedule":{"$ref":"#/components/schemas/ScheduleWithExceptionsAndDescription"}}}},"components/schemas/ScheduledItemWithNextTest":{"id":"components/schemas/ScheduledItemWithNextTest","kind":"json-schema","title":"ScheduledItemWithNextTest","data":{"type":"object","description":"Scheduled item which includes data source specific information and next check info.","allOf":[{"$ref":"#/components/schemas/ScheduledItem"},{"type":"object","properties":{"nextTest":{"type":"string","format":"datetime"}}}]}},"components/schemas/CalendarUpdateItem":{"id":"components/schemas/CalendarUpdateItem","kind":"json-schema","title":"CalendarUpdateItem","data":{"description":"Item in a calendar update (PUT) request.","type":"object","required":["itemType","itemId","schedule"],"properties":{"itemType":{"$ref":"#/components/schemas/DataSourceItemTypeCap"},"itemId":{"description":"Item id of scheduled item.","type":"number"},"schedule":{"$ref":"#/components/schemas/ScheduleWithExceptions"}}}},"components/schemas/CalendarUpdateRequestBody":{"id":"components/schemas/CalendarUpdateRequestBody","kind":"json-schema","title":"CalendarUpdateRequestBody","data":{"description":"The body for calendar item updates using the bulk PUT endpoint.","type":"object","required":["updateItems"],"properties":{"updateItems":{"type":"array","items":{"$ref":"#/components/schemas/CalendarUpdateItem"}}}}},"components/schemas/CustomHeaderBody":{"id":"components/schemas/CustomHeaderBody","kind":"json-schema","title":"CustomHeaderBody","data":{"type":"object","required":["groupName","headers","requestUrlFilters","assignments","applyToAll"],"properties":{"id":{"type":"integer","format":"int64"},"groupName":{"type":"string"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/CustomHeader"}},"requestUrlFilters":{"type":"array","items":{"$ref":"#/components/schemas/RequestUrlFilter"}},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/CustomHeaderAssignments"}},"applyToAll":{"type":"boolean"}}}},"components/schemas/CustomHeaderGroupSnapshot":{"id":"components/schemas/CustomHeaderGroupSnapshot","kind":"json-schema","title":"CustomHeaderGroupSnapshot","data":{"type":"object","description":"Custom header group for runtime snapshots - matches s3-schema CustomHeaderGroup structure","required":["groupName","headers","requestUrlFilters"],"properties":{"id":{"type":"integer","format":"int64"},"groupName":{"type":"string"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/CustomHeader"}},"requestUrlFilters":{"type":"array","items":{"$ref":"#/components/schemas/RequestUrlFilter"}}}}},"components/schemas/CustomHeaderGroupSummaryResponse":{"id":"components/schemas/CustomHeaderGroupSummaryResponse","kind":"json-schema","title":"CustomHeaderGroupSummaryResponse","data":{"type":"object","required":["customHeaderGroups"],"properties":{"customHeaderGroups":{"type":"array","items":{"$ref":"#/components/schemas/CustomHeaderGroupSummary"}}}}},"components/schemas/CustomHeaderGroupSummary":{"id":"components/schemas/CustomHeaderGroupSummary","kind":"json-schema","title":"CustomHeaderGroupSummary","data":{"type":"object","required":["id","groupName","headerCount","requestUrlFilterCount","createdBy","createdAt","updatedAt","applyToAll","assignments"],"properties":{"id":{"type":"integer","format":"int64"},"groupName":{"type":"string"},"headerCount":{"type":"integer"},"requestUrlFilterCount":{"type":"integer"},"createdBy":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"applyToAll":{"type":"boolean"},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/CustomHeaderAssignments"}}}}},"components/schemas/CustomHeader":{"id":"components/schemas/CustomHeader","kind":"json-schema","title":"CustomHeader","data":{"type":"object","required":["name","value","type"],"properties":{"name":{"type":"string"},"value":{"type":"string"},"type":{"type":"string","enum":["REQUEST","RESPONSE"]}}}},"components/schemas/RequestUrlFilter":{"id":"components/schemas/RequestUrlFilter","kind":"json-schema","title":"RequestUrlFilter","data":{"type":"object","required":["requestUrlFilter","allowSubdomains"],"properties":{"requestUrlFilter":{"type":"string"},"allowSubdomains":{"type":"boolean"}}}},"components/schemas/CustomHeaderAssignments":{"id":"components/schemas/CustomHeaderAssignments","kind":"json-schema","title":"CustomHeaderAssignments","data":{"type":"object","required":["itemType","itemId"],"properties":{"itemType":{"type":"string","enum":["AUDIT","WEB_JOURNEY"]},"itemId":{"type":"integer","format":"int64"}}}},"components/schemas/CustomHeaderTargetItemsSearchRequest":{"id":"components/schemas/CustomHeaderTargetItemsSearchRequest","kind":"json-schema","title":"CustomHeaderTargetItemsSearchRequest","data":{"type":"object","description":"Filters supported by Custom Header Target Items Search","properties":{"customHeaderGroupId":{"type":"integer","format":"int64"},"assignedToCustomHeaderGroup":{"type":"boolean"},"itemName":{"type":"string","minLength":1},"itemLabels":{"type":"array","description":"non-empty array of labels present on an item, works as \"item has all specified labels\" filter","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"folders":{"$ref":"#/components/schemas/FolderDomainFilter"}}}},"components/schemas/CustomHeaderTargetItemsSearchResponse":{"id":"components/schemas/CustomHeaderTargetItemsSearchResponse","kind":"json-schema","title":"CustomHeaderTargetItemsSearchResponse","data":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/PaginationMetadata"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomHeaderTargetItem"}}}}},"components/schemas/CustomHeaderTargetItem":{"id":"components/schemas/CustomHeaderTargetItem","kind":"json-schema","title":"CustomHeaderTargetItem","data":{"type":"object","properties":{"isAssigned":{"type":"boolean"},"itemType":{"type":"string","enum":["AUDIT","WEB_JOURNEY"]},"itemId":{"type":"integer","format":"int64"},"itemName":{"type":"string"},"lastRunAt":{"type":"string","format":"date-time","description":"The timestamp of the last run for this item"},"itemLabels":{"type":"array","items":{"$ref":"#/components/schemas/AssignedLabel"}}}}},"components/schemas/CustomHeaderSortByEnum":{"id":"components/schemas/CustomHeaderSortByEnum","kind":"json-schema","title":"CustomHeaderSortByEnum","data":{"type":"string","default":"ITEM_NAME","enum":["IS_ASSIGNED","ITEM_NAME","RUN_DATE"]}},"components/schemas/WebJourneyCustomHeaderDTO":{"id":"components/schemas/WebJourneyCustomHeaderDTO","kind":"json-schema","title":"WebJourneyCustomHeaderDTO","data":{"type":"object","required":["assignedCustomHttpHeaders"],"properties":{"assignedCustomHttpHeaders":{"type":"array","items":{"required":["groupId"],"properties":{"groupId":{"type":"integer","format":"int64"},"isApplyToAll":{"type":"boolean","description":"Indicates whether custom header should be applied to all requests. For GET request, indicates that the header is not just assigned to the request but also applied to all requests. For PUT request, it specifies that the header should be updated to apply to all requests, if set to true, header will not be applied to the request."}}}}}}},"components/schemas/DataSourcesTargetItemsSearchRequest":{"id":"components/schemas/DataSourcesTargetItemsSearchRequest","kind":"json-schema","title":"DataSourcesTargetItemsSearchRequest","data":{"type":"object","description":"Filters supported by Unified Data Sources Target Items Search.","properties":{"searchItemType":{"type":"string","enum":["ALERT","CUSTOM_HEADER","EMAIL_INBOX","RULE"]},"searchedItemId":{"type":"integer","format":"int64"},"assignedToSearchedItem":{"type":"boolean"},"itemName":{"type":"string","minLength":1},"itemLabels":{"type":"array","description":"non-empty array of labels present on an item, works as \"item has all specified labels\" filter","minItems":1,"items":{"$ref":"#/components/schemas/LabelId"}},"folders":{"$ref":"#/components/schemas/FolderDomainFilter"}}}},"components/schemas/DataSourcesTargetItemsSearchResponse":{"id":"components/schemas/DataSourcesTargetItemsSearchResponse","kind":"json-schema","title":"DataSourcesTargetItemsSearchResponse","data":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/PaginationMetadata"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DataSourcesTargetItem"}}}}},"components/schemas/DataSourcesTargetItem":{"id":"components/schemas/DataSourcesTargetItem","kind":"json-schema","title":"DataSourcesTargetItem","data":{"type":"object","properties":{"isAssigned":{"type":"boolean"},"itemType":{"type":"string","enum":["AUDIT","WEB_JOURNEY"]},"itemId":{"type":"integer","format":"int64"},"itemName":{"type":"string"},"lastRunAt":{"type":"string","format":"date-time","description":"The timestamp of the last run for this item"},"itemLabels":{"type":"array","items":{"$ref":"#/components/schemas/AssignedLabel"}}}}},"components/schemas/DataSourceTargetItemSortByEnum":{"id":"components/schemas/DataSourceTargetItemSortByEnum","kind":"json-schema","title":"DataSourceTargetItemSortByEnum","data":{"type":"string","default":"ITEM_NAME","enum":["ITEM_NAME","RUN_DATE"]}},"components/schemas/ArchivedItemType":{"id":"components/schemas/ArchivedItemType","kind":"json-schema","title":"ArchivedItemType","data":{"description":"Type of archived item.","type":"string","enum":["audit","web-journey"]}},"components/schemas/ArchivedItemSortField":{"id":"components/schemas/ArchivedItemSortField","kind":"json-schema","title":"ArchivedItemSortField","data":{"description":"Field to sort archived items by. Values correspond to the columns shown on the\nArchived Items page. Defaults to deletedAt (first enum value used by SortingPagination).\n","type":"string","default":"deletedAt","enum":["deletedAt","name","originalFolderName","startingUrl","pageLimit","stepCount","schedule","createdAt","deletedBy"]}},"components/schemas/ArchivedItem":{"id":"components/schemas/ArchivedItem","kind":"json-schema","title":"ArchivedItem","data":{"type":"object","description":"A single archived (soft-deleted) audit or journey.","required":["id","name","type","schedule","createdAt","deletedAt","deletedBy"],"properties":{"id":{"type":"integer","format":"int64","description":"The item id (audit id or web journey id)."},"name":{"type":"string","description":"The item name."},"type":{"$ref":"#/components/schemas/ArchivedItemType"},"originalFolderId":{"type":"integer","format":"int64","nullable":true,"description":"The Folder the item was in when archived. null if that Folder was deleted while the item was archived."},"originalFolderName":{"type":"string","nullable":true,"description":"The name of the original Folder. null if the Folder was deleted."},"originalSubFolderId":{"type":"integer","format":"int64","nullable":true,"description":"The Sub-folder (a Domain id) the item was in when archived. null if deleted."},"originalSubFolderName":{"type":"string","nullable":true,"description":"The name of the original Sub-folder. null if the Sub-folder was deleted."},"startingUrl":{"type":"string","nullable":true,"description":"The starting URL. For a journey, the first \"Navigate To\" action URL. null if none is available."},"pageLimit":{"type":"integer","format":"int32","nullable":true,"description":"Audits only. The audit page limit. null for journeys."},"stepCount":{"type":"integer","format":"int32","nullable":true,"description":"Journeys only. The number of steps/actions. null for audits."},"schedule":{"type":"string","description":"A human-readable schedule display string, shown as-is (for example \"Every day\", \"Unscheduled\")."},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 date-time the item was created. Shown as Date Created."},"deletedAt":{"type":"string","format":"date-time","description":"ISO 8601 date-time the item was archived (soft-deleted). Shown as Archived On and the default sort."},"deletedBy":{"type":"string","description":"A display name or email of the user who archived the item. Shown as Archived By."}}}},"components/schemas/ArchivedItemsResponse":{"id":"components/schemas/ArchivedItemsResponse","kind":"json-schema","title":"ArchivedItemsResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page of archived items for the requested type, plus counts. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scoped to this request (type + search) and drives pagination. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auditCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webJourneyCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are account-wide totals of archived items per type, ignoring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and paging, so the UI can render both tab badges from a single request."},"children":[]}]}]}],"required":["items","totalCount","auditCount","webJourneyCount"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ArchivedItem"}},"totalCount":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of archived items matching this request (type + search) across all pages. Drives pagination."},"children":[]}]}]}]},"auditCount":{"type":"integer","format":"int64","description":"Total archived audits in the account, ignoring search and paging. For the Audits tab badge."},"webJourneyCount":{"type":"integer","format":"int64","description":"Total archived web journeys in the account, ignoring search and paging. For the Journeys tab badge."}}}},"components/schemas/SiteCensusBaseDTO":{"id":"components/schemas/SiteCensusBaseDTO","kind":"json-schema","title":"SiteCensusBaseDTO","data":{"type":"object","required":["name","autoPauseAfter","notificationEmails"],"properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for the Site Census."},"accountId":{"type":"integer","format":"int64","description":"The account ID associated with the Site Census."},"name":{"type":"string","description":"The name of the Site Census."},"autoPauseAfter":{"type":"integer","maximum":10080,"minimum":1,"description":"The max time the scan will run, in minutes."},"ownerId":{"type":"integer","format":"int64","description":"The userId of the user who created the Site Census."},"currentScanStartedAt":{"type":"string","format":"date-time","nullable":true,"description":"The date and time when the current scan session started."},"lastScanStoppedAt":{"type":"string","format":"date-time","nullable":true,"description":"The date and time when the last scan session stopped."},"notificationEmails":{"type":"array","minItems":0,"items":{"type":"string","format":"email"},"description":"Target email addresses for notification when this census auto-pauses or runs out of URLs."},"userAgentId":{"type":"integer","default":122,"description":"The user agent ID used for data collection."},"customHttpHeaders":{"type":"array","default":[],"minItems":0,"items":{"$ref":"#/components/schemas/SiteCensusCustomHttpHeader"},"description":"List of custom HTTP header groups assigned to this site census."}}}},"components/schemas/SiteCensusCustomHttpHeader":{"id":"components/schemas/SiteCensusCustomHttpHeader","kind":"json-schema","title":"SiteCensusCustomHttpHeader","data":{"type":"object","required":["groupId"],"properties":{"groupId":{"type":"integer","format":"int64","description":"The ID of the custom HTTP header group."}}}},"components/schemas/SiteCensusBehaviorDTO":{"id":"components/schemas/SiteCensusBehaviorDTO","kind":"json-schema","title":"SiteCensusBehaviorDTO","data":{"allOf":[{"$ref":"#/components/schemas/SiteCensusBaseDTO"},{"type":"object","required":["startingUrls","filterPatterns"],"properties":{"startingUrls":{"type":"array","minItems":0,"items":{"type":"string","format":"uri"},"description":"The list of starting URLs for the Site Census."},"filterPatterns":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/SiteCensusFilterPattern"}}}}]}},"components/schemas/SiteCensusFilterPattern":{"id":"components/schemas/SiteCensusFilterPattern","kind":"json-schema","title":"SiteCensusFilterPattern","data":{"type":"object","required":["pathPattern","fqdn","type"],"properties":{"pathPattern":{"type":"string","description":"The GLOB pattern to match the path of the URL."},"fqdn":{"type":"string","description":"The fully qualified domain name (FQDN) to match against the URL."},"type":{"type":"string","enum":["PRIORITY","IGNORE"],"description":"Indicates whether matches should be prioritized or ignored."}}}},"components/schemas/SiteCensusCompleteDTO":{"id":"components/schemas/SiteCensusCompleteDTO","kind":"json-schema","title":"SiteCensusCompleteDTO","data":{"allOf":[{"$ref":"#/components/schemas/SiteCensusBehaviorDTO"},{"type":"object","required":["id","isArchived"],"properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for the Site Census."},"isArchived":{"type":"boolean","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the Site Census has been archived. True if and only if the census has an archived_at timestamp. Archived censuses cannot be edited or restarted, but they can be deleted. Server-set; ignored on requests."},"children":[]}]}]}]}}}]}},"components/schemas/SiteCensusResultsSummaryDTO":{"id":"components/schemas/SiteCensusResultsSummaryDTO","kind":"json-schema","title":"SiteCensusResultsSummaryDTO","data":{"type":"object","required":["uniqueUrls","visitedUrls","urlsToVisit","ignoredUrls","brokenUrls","isRunning","isArchived"],"properties":{"uniqueUrls":{"type":"integer","minimum":0,"description":"The number of unique included URLs found. Included is defined as URLs that share the same main-domain as any starting URL."},"visitedUrls":{"type":"integer","minimum":0,"description":"The number of included URLs visited. Included is defined as URLs that share the same main-domain as any starting URL."},"urlsToVisit":{"type":"integer","minimum":0,"description":"The number of included URLs to visit. Included is defined as URLs that share the same main-domain as any starting URL."},"ignoredUrls":{"type":"integer","minimum":0,"description":"The number of URLs matching an IGNORE filter pattern found on included pages. Included is defined as URLs that share the same main-domain as any starting URL."},"brokenUrls":{"type":"integer","minimum":0,"description":"The number of included URLs that are broken. Broken is defined as URLs that return a non-2xx,3xx status code. Included is defined as URLs that share the same main-domain as any starting URL."},"isRunning":{"type":"boolean","description":"Indicates whether the Site Census is currently scanning."},"isArchived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the Site Census has been archived. True if and only if the census has an archived_at timestamp."},"children":[]}]}]}]}}}},"components/schemas/SiteCensusSummaryDTO":{"id":"components/schemas/SiteCensusSummaryDTO","kind":"json-schema","title":"SiteCensusSummaryDTO","data":{"allOf":[{"$ref":"#/components/schemas/SiteCensusResultsSummaryDTO"},{"type":"object","required":["censusConfig"],"properties":{"censusConfig":{"$ref":"#/components/schemas/SiteCensusCompleteDTO"}}}]}},"components/schemas/SiteCensusSummariesResponseDTO":{"id":"components/schemas/SiteCensusSummariesResponseDTO","kind":"json-schema","title":"SiteCensusSummariesResponseDTO","data":{"type":"object","required":["metadata","censuses"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"censuses":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/SiteCensusSummaryDTO"}}}}},"components/schemas/SiteCensusUrlSegment":{"id":"components/schemas/SiteCensusUrlSegment","kind":"json-schema","title":"SiteCensusUrlSegment","data":{"type":"object","required":["segmentType"],"properties":{"segmentType":{"type":"string","description":"The type of segment in the path. A static segment is a string in the path that does not represent a variable.\nA dynamic segment is one that represents a variable in the URL. For example, a dynamic segment could be a user ID.\n","enum":["STATIC","DYNAMIC"]},"staticSegmentValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"present when segment type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"static"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A static segment is a string in the path that does not represent a variable."},"children":[]}]}]}]},"dynamicSegmentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"present when segment type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use this type to make rendering decisions when displaying path segments."},"children":[]}]}]}],"enum":["NUMBER","DATETIME","ALPHA","ALPHA_NUMERIC"]}}}},"components/schemas/SiteCensusBaseUrlPattern":{"id":"components/schemas/SiteCensusBaseUrlPattern","kind":"json-schema","title":"SiteCensusBaseUrlPattern","data":{"type":"object","description":"The ObservePoint proprietary pattern used to classify URLs with similar paths based upon dynamic path segments.","required":["fqdn","renderedPathPattern"],"properties":{"fqdn":{"type":"string","description":"The fully qualified domain name (FQDN) of the URL pattern."},"renderedPathPattern":{"type":"string","description":"The rendered path of the URL pattern with the dynamic segment character. Not meant for display."}}}},"components/schemas/SiteCensusUrlPattern":{"id":"components/schemas/SiteCensusUrlPattern","kind":"json-schema","title":"SiteCensusUrlPattern","data":{"allOf":[{"$ref":"#/components/schemas/SiteCensusBaseUrlPattern"},{"type":"object","description":"The ObservePoint proprietary pattern used to classify URLs with similar paths based upon dynamic path segments.","required":["urlSegments"],"properties":{"urlSegments":{"type":"array","minItems":0,"description":"The list of URL path segments.  Construct a full path pattern by appending the segment in order of array index separated by forward slashes.","items":{"$ref":"#/components/schemas/SiteCensusUrlSegment"}}}}]}},"components/schemas/SiteCensusUrlPatternResultsDTO":{"id":"components/schemas/SiteCensusUrlPatternResultsDTO","kind":"json-schema","title":"SiteCensusUrlPatternResultsDTO","data":{"type":"object","required":["urlPattern","totalUrls","urlsToVisit","visitedUrls","brokenUrls"],"properties":{"urlPattern":{"$ref":"#/components/schemas/SiteCensusUrlPattern"},"totalUrls":{"type":"integer","minimum":0,"description":"The total number of URLs within this pattern."},"urlsToVisit":{"type":"integer","minimum":0,"description":"The number of URLs in this pattern that can still be visited."},"visitedUrls":{"type":"integer","minimum":0,"description":"The number of URLs in this pattern that have been visited."},"brokenUrls":{"type":"integer","minimum":0,"description":"The number of URLs in this pattern that have been visited, but returned with 4xx or 5xx status codes."},"latestFound":{"type":"string","format":"date-time","description":"The date and time of the last URL in this pattern that was found in ISO 8601 format"}}}},"components/schemas/SiteCensusCurrentResultsDTO":{"id":"components/schemas/SiteCensusCurrentResultsDTO","kind":"json-schema","title":"SiteCensusCurrentResultsDTO","data":{"type":"object","required":["metadata","paginatedUrlPatternResults","resultsSummary"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"paginatedUrlPatternResults":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/SiteCensusUrlPatternResultsDTO"}},"resultsSummary":{"$ref":"#/components/schemas/SiteCensusResultsSummaryDTO"}}}},"components/schemas/SiteCensusPatternPreviewResponse":{"id":"components/schemas/SiteCensusPatternPreviewResponse","kind":"json-schema","title":"SiteCensusPatternPreviewResponse","data":{"type":"object","required":["censusId","totalUrls","urls"],"properties":{"censusId":{"type":"integer","format":"int64","description":"The unique identifier for the Site Census."},"totalUrls":{"type":"integer"},"urls":{"type":"array","minItems":0,"items":{"type":"string"}}}}},"components/schemas/SiteCensusResultsSortByEnum":{"id":"components/schemas/SiteCensusResultsSortByEnum","kind":"json-schema","title":"SiteCensusResultsSortByEnum","data":{"type":"string","default":"TOTAL_URLS","enum":["TOTAL_URLS","URL_PATTERN","URLS_TO_VISIT","VISITED_URLS","BROKEN_URLS","LAST_FOUND"]}},"components/schemas/SiteCensusUrlFolderSortByEnum":{"id":"components/schemas/SiteCensusUrlFolderSortByEnum","kind":"json-schema","title":"SiteCensusUrlFolderSortByEnum","data":{"type":"string","default":"FOLDER_NAME","enum":["FOLDER_NAME","TOTAL_URLS","URLS_TO_VISIT","VISITED_URLS","BROKEN_URLS","LAST_FOUND"]}},"components/schemas/SiteCensusUrlFolderResultDTO":{"id":"components/schemas/SiteCensusUrlFolderResultDTO","kind":"json-schema","title":"SiteCensusUrlFolderResultDTO","data":{"type":"object","required":["folderPath","folderName","baseDomain","host","totalUrls","urlsToVisit","visitedUrls","brokenUrls","matched"],"properties":{"folderPath":{"type":"string","description":"The normalized folder path key."},"folderName":{"type":"string","description":"The display name of the folder."},"parentFolderPath":{"type":"string","description":"The normalized parent folder path key. Absent only for the root folder."},"baseDomain":{"type":"string","description":"The URL base domain."},"host":{"type":"string","description":"The URL hostname."},"totalUrls":{"type":"integer","minimum":0,"description":"The number of URLs counted in the folder's subtree (the folder and all of its descendants) that are in view for the current scope. Never restricted by searchPattern, so a folder reports the same value whether it was reached by browsing or by searching."},"visitedUrls":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of counted URLs in the folder's subtree that have been visited (live: most_recent_status_code != 0; persisted rollup: any 2xx/3xx/4xx/5xx). Always totalUrls - urlsToVisit."},"children":[]}]}]}]},"urlsToVisit":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of counted URLs in the folder's subtree still awaiting a visit (live: most_recent_status_code = 0; persisted rollup: the unknown-status bucket, which also absorbs missing, 1xx and 6xx+ codes)."},"children":[]}]}]}]},"brokenUrls":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of counted URLs in the folder's subtree where most_recent_status_code is between 400 and 599."},"children":[]}]}]}]},"latestFound":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latest url_found_at timestamp among the counted URLs in the folder's subtree."},"children":[]}]}]}]},"matched":{"type":"boolean","description":"True if this folder is a hit counted toward totalCount: its own name (or, for a host root, its hostname) contains searchPattern, or it directly contains at least one URL whose page name does. Hits are the paged rows and the only rows carrying urls/matchedUrlCount. False means the folder is present only as tree context - an ancestor needed to connect a hit back to the root (or parentFolderPath); context rows are extra and do not count toward totalCount. Always true when searchPattern is omitted."},"matchedUrlCount":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The uncapped number of this folder's DIRECT child URLs in view: every in-view direct URL in browse mode, only those whose own page name contains searchPattern in search mode. Present exactly when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is (matched rows, urlsPerFolder > 0). May exceed the length of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is capped at urlsPerFolder - page the remainder through the folders/urls endpoint."},"children":[]}]}]}]},"urls":{"type":"array","minItems":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to urlsPerFolder of this folder's direct-child URLs in view (see matchedUrlCount for the uncapped total), always in (URL, id) order - the folders/urls endpoint's default, so these URLs reappear there in the same relative order (that endpoint lists every direct URL, unfiltered by this endpoint's view). Present only on matched rows when urlsPerFolder > 0; absent on context rows and when previews are disabled."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SiteCensusUrlFolderPageDTO"}}}}},"components/schemas/SiteCensusUrlFolderPageDTO":{"id":"components/schemas/SiteCensusUrlFolderPageDTO","kind":"json-schema","title":"SiteCensusUrlFolderPageDTO","data":{"type":"object","description":"One direct-child URL of the folder row it is nested under. In search mode its own page name matched searchPattern; in browse mode every in-view direct URL qualifies. Carries no folder identity of its own - the enclosing folder row is the identity.\n","required":["urlId","url","pageName"],"properties":{"urlId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The site_census_urls row id for this URL."},"children":[]}]}]}]},"url":{"type":"string","description":"The full page URL (scheme://host/path?query)."},"pageName":{"type":"string","description":"The last path segment - the part of the path that searchPattern is matched against."},"mostRecentStatusCode":{"type":"integer","nullable":true,"description":"Most recent HTTP status observed; null/0 when not yet visited."},"urlFoundAt":{"type":"string","format":"date-time","nullable":true,"description":"When the URL was first found, ISO 8601."}}}},"components/schemas/SiteCensusUrlFolderResultsDTO":{"id":"components/schemas/SiteCensusUrlFolderResultsDTO","kind":"json-schema","title":"SiteCensusUrlFolderResultsDTO","data":{"type":"object","required":["metadata","folders"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"folders":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/SiteCensusUrlFolderResultDTO"}}}}},"components/schemas/SiteCensusFolderUrlSortByEnum":{"id":"components/schemas/SiteCensusFolderUrlSortByEnum","kind":"json-schema","title":"SiteCensusFolderUrlSortByEnum","data":{"type":"string","default":"URL","enum":["URL","STATUS_CODE","LAST_FOUND"]}},"components/schemas/SiteCensusFolderSummaryDTO":{"id":"components/schemas/SiteCensusFolderSummaryDTO","kind":"json-schema","title":"SiteCensusFolderSummaryDTO","data":{"type":"object","required":["censusId","baseDomain","host","folderPath","totalUrls","directUrls","childFolderCount","visitedUrls","urlsToVisit","brokenUrls","includedUrls","ignoredUrls","finalized"],"properties":{"censusId":{"type":"integer","format":"int64"},"baseDomain":{"type":"string"},"host":{"type":"string"},"folderPath":{"type":"string"},"totalUrls":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Self-inclusive total URLs in this folder and all descendants (descendant_page_count)."},"children":[]}]}]}]},"directUrls":{"type":"integer","minimum":0,"description":"URLs sitting directly in this folder (not descendants)."},"childFolderCount":{"type":"integer","minimum":0,"description":"Number of immediate child folders."},"visitedUrls":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visited URLs in the subtree (success + redirect + broken buckets)."},"children":[]}]}]}]},"urlsToVisit":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not-yet-categorized URLs in the subtree (unknown-status bucket); ~0 for a finalized census."},"children":[]}]}]}]},"brokenUrls":{"type":"integer","minimum":0,"description":"URLs in the subtree with a 4xx/5xx status."},"includedUrls":{"type":"integer","minimum":0,"description":"Live count of subtree URLs NOT matching any IGNORE pattern."},"ignoredUrls":{"type":"integer","minimum":0,"description":"Live count of subtree URLs matching an IGNORE pattern."},"finalized":{"type":"boolean","description":"True when the folder's precomputed rollup counts have been finalized and are trustworthy."}}}},"components/schemas/SiteCensusFolderUrlDTO":{"id":"components/schemas/SiteCensusFolderUrlDTO","kind":"json-schema","title":"SiteCensusFolderUrlDTO","data":{"type":"object","required":["urlId","url"],"properties":{"urlId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The site_census_urls row id for this URL."},"children":[]}]}]}]},"url":{"type":"string","description":"The full page URL (scheme://host/path?query)."},"mostRecentStatusCode":{"type":"integer","nullable":true,"description":"Most recent HTTP status observed; null/0 when not yet visited."},"urlFoundAt":{"type":"string","format":"date-time","nullable":true,"description":"When the URL was first found, ISO 8601."}}}},"components/schemas/SiteCensusFolderUrlsResultsDTO":{"id":"components/schemas/SiteCensusFolderUrlsResultsDTO","kind":"json-schema","title":"SiteCensusFolderUrlsResultsDTO","data":{"type":"object","required":["metadata","urls"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"urls":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/SiteCensusFolderUrlDTO"}}}}},"components/schemas/SiteCensusSortByEnum":{"id":"components/schemas/SiteCensusSortByEnum","kind":"json-schema","title":"SiteCensusSortByEnum","data":{"type":"string","default":"NAME","enum":["NAME","UNIQUE_URLS","VISITED_URLS","URLS_TO_VISIT","IGNORED_URLS","BROKEN_URLS","SCAN_DATE"]}},"components/schemas/SiteCensusSearchParam":{"id":"components/schemas/SiteCensusSearchParam","kind":"json-schema","title":"SiteCensusSearchParam","data":{"type":"string","minLength":1,"description":"Parameter to search for site censuses"}},"components/schemas/FoundSiteCensusesListResponseDTO":{"id":"components/schemas/FoundSiteCensusesListResponseDTO","kind":"json-schema","title":"FoundSiteCensusesListResponseDTO","data":{"type":"object","required":["metadata","items"],"properties":{"metadata":{"$ref":"#/components/schemas/CommonIterableResponseMetadata"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FoundSiteCensusDTO"}}}}},"components/schemas/FoundSiteCensusDTO":{"id":"components/schemas/FoundSiteCensusDTO","kind":"json-schema","title":"FoundSiteCensusDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a site census retrieved from a search operation. Site censuses can be searched by the following properties:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}],"required":["id","name","accountId"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"accountId":{"type":"integer","format":"int64"}}}},"components/schemas/EmailFinderSearchParam":{"id":"components/schemas/EmailFinderSearchParam","kind":"json-schema","title":"EmailFinderSearchParam","data":{"type":"string","minLength":1,"description":"Parameter to search for email inboxes or messages"}},"components/schemas/FoundEmailInboxDTO":{"id":"components/schemas/FoundEmailInboxDTO","kind":"json-schema","title":"FoundEmailInboxDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an email inbox retrieved from a search operation. Email inboxes can be searched by the following properties:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}],"required":["id","name","accountId"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"accountId":{"type":"integer","format":"int64"},"mostRecentMessageId":{"type":"integer","format":"int64","nullable":true,"description":"ID of the most recently received message in this inbox, or null if the inbox has no messages"}}}},"components/schemas/FoundEmailMessageDTO":{"id":"components/schemas/FoundEmailMessageDTO","kind":"json-schema","title":"FoundEmailMessageDTO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a received email message retrieved from a search operation. Email messages can be searched by the following properties:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the message subject)"},"children":[]}]}]}]}],"required":["id","name","accountId","inboxId"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"accountId":{"type":"integer","format":"int64"},"inboxId":{"type":"integer","format":"int64"}}}},"components/schemas/EmailFinderResultsDTO":{"id":"components/schemas/EmailFinderResultsDTO","kind":"json-schema","title":"EmailFinderResultsDTO","data":{"type":"object","required":["inboxes","messages"],"properties":{"inboxes":{"type":"array","items":{"$ref":"#/components/schemas/FoundEmailInboxDTO"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/FoundEmailMessageDTO"}}}}},"components/schemas/RequestBlocking":{"id":"components/schemas/RequestBlocking","kind":"json-schema","title":"RequestBlocking","data":{"type":"object","description":"(Optional) Present if run configuration had TMS blocking enabled and request for this entry was blocked.","required":["blockReason","urlSignature"],"properties":{"blockReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The configuration chosen by user. Phase 2 will include url_signature"},"children":[]}]}]}],"type":"string","enum":["tag_id","tag_category","url_signature"]},"urlSignature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The singature used to identify requests.  Tag Signatures shall not be exposed to customers (blockReason is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"tagId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optional - Present when reason is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Allows FE to get Vendor, Category and other info as they do in tag initiators"},"children":[]}]}]}],"type":"integer"},"tagCategoryId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optional) Present when reason is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"integer"},"failureMessage":{"description":"(Optional) Present if the request was meant to be blocked but it was not.","type":"string"}}}},"components/schemas/Substitution":{"id":"components/schemas/Substitution","kind":"json-schema","title":"Substitution","data":{"type":"object","required":["substituteUrl"],"properties":{"substituteUrl":{"type":"string"},"failure":{"$ref":"#/components/schemas/RemoteFileMappingFailure"},"tagId":{"type":"integer"},"tagName":{"type":"string"}}}},"components/schemas/RemoteFileMappingFailure":{"id":"components/schemas/RemoteFileMappingFailure","kind":"json-schema","title":"RemoteFileMappingFailure","data":{"type":"object","required":["failureType"],"properties":{"failureType":{"$ref":"#/components/schemas/RemoteFileMappingFailureType"},"failureMessage":{"type":"string"}}}},"components/schemas/RemoteFileMappingFailureType":{"id":"components/schemas/RemoteFileMappingFailureType","kind":"json-schema","title":"RemoteFileMappingFailureType","data":{"type":"integer","enum":[1,2,3,4],"x-enum-varnames":["UNKNOWN","FILE_SIZE_LIMIT_EXCEEDED","FILE_NOT_FOUND","CANNOT_GET_FILE"]}},"components/schemas/HarEntryTimings":{"id":"components/schemas/HarEntryTimings","kind":"json-schema","title":"HarEntryTimings","data":{"type":"object","properties":{"blocked":{"type":"number","minimum":-1,"nullable":true},"dns":{"type":"number","minimum":-1,"nullable":true},"connect":{"type":"number","minimum":-1,"nullable":true},"send":{"type":"number","minimum":-1},"wait":{"type":"number","minimum":-1},"receive":{"type":"number","minimum":-1},"ssl":{"type":"number","minimum":-1,"nullable":true},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/HarResponse":{"id":"components/schemas/HarResponse","kind":"json-schema","title":"HarResponse","data":{"type":"object","properties":{"status":{"type":"integer","minimum":100,"maximum":600},"statusText":{"type":"string"},"httpVersion":{"type":"string"},"cookies":{"type":"array","items":{"$ref":"#/components/schemas/HarCookie"}},"headers":{"type":"array","items":{"$ref":"#/components/schemas/HarHeaderOrQueryString"}},"content":{"$ref":"#/components/schemas/HarResponseContent"},"redirectURL":{"type":"string","nullable":true},"headersSize":{"type":"integer","minimum":-1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of bytes in response headers (including ending \\r\\n\\r\\n). -1 if unavailable"},"children":[]}]}]}]},"bodySize":{"type":"integer","minimum":-1,"description":"Number of bytes in response body. -1 if unavailable"},"_transferSize":{"type":"integer","format":"int64","minimum":0},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/HarResponseContent":{"id":"components/schemas/HarResponseContent","kind":"json-schema","title":"HarResponseContent","data":{"type":"object","properties":{"size":{"type":"integer","minimum":0},"compression":{"type":"integer","minimum":0,"nullable":true},"mimeType":{"type":"string","format":"mimeType"},"text":{"type":"string","nullable":true},"encoding":{"type":"string","nullable":true},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/HarHeaderOrQueryString":{"id":"components/schemas/HarHeaderOrQueryString","kind":"json-schema","title":"HarHeaderOrQueryString","data":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string","nullable":true},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/HarCookie":{"id":"components/schemas/HarCookie","kind":"json-schema","title":"HarCookie","data":{"allOf":[{"$ref":"#/components/schemas/CookieBase"},{"type":"object","properties":{"comment":{"$ref":"#/components/schemas/HarComment"}}}]}},"components/schemas/CookieBase":{"id":"components/schemas/CookieBase","kind":"json-schema","title":"CookieBase","data":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"},"domain":{"type":"string"},"path":{"type":"string"},"expires":{"type":"string"},"httpOnly":{"type":"boolean"},"secure":{"type":"boolean"},"partyType":{"$ref":"#/components/schemas/CookiePartyType"},"sameSite":{"$ref":"#/components/schemas/CookieSameSite"},"partitionKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The partition key used for 3rd party cookies using CHIPS"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See https://developer.mozilla.org/en-US/docs/Web/Privacy/Partitioned_cookies"},"children":[]}]}]}],"type":"string"},"partitionKeyOpaque":{"description":"True if a partition key is used, but for security reasons the partition key is not exposed\nIf this value is true, a cookie will be considered partitioned.\n","type":"boolean"}}}},"components/schemas/HarCache":{"id":"components/schemas/HarCache","kind":"json-schema","title":"HarCache","data":{"type":"object","nullable":true,"properties":{"beforeRequest":{"$ref":"#/components/schemas/HarCacheEntry"},"afterRequest":{"$ref":"#/components/schemas/HarCacheEntry"},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/HarCacheEntry":{"id":"components/schemas/HarCacheEntry","kind":"json-schema","title":"HarCacheEntry","data":{"type":"object","nullable":true,"properties":{"expires":{"$ref":"#/components/schemas/nullableDatetime"},"lastAccess":{"$ref":"#/components/schemas/datetime"},"eTag":{"type":"string"},"hitCount":{"type":"integer","minimum":0},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/Har":{"id":"components/schemas/Har","kind":"json-schema","title":"Har","data":{"type":"object","properties":{"log":{"$ref":"#/components/schemas/HarLog"}}}},"components/schemas/HarComment":{"id":"components/schemas/HarComment","kind":"json-schema","title":"HarComment","data":{"type":"string","nullable":true}},"components/schemas/HarLog":{"id":"components/schemas/HarLog","kind":"json-schema","title":"HarLog","data":{"type":"object","properties":{"version":{"type":"string"},"creator":{"$ref":"#/components/schemas/HarCreatorOrBrowser"},"browser":{"$ref":"#/components/schemas/HarCreatorOrBrowser"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/HarPage"}},"entries":{"type":"array","items":{"$ref":"#/components/schemas/HarEntry"}},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/HarCreatorOrBrowser":{"id":"components/schemas/HarCreatorOrBrowser","kind":"json-schema","title":"HarCreatorOrBrowser","data":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/HarPage":{"id":"components/schemas/HarPage","kind":"json-schema","title":"HarPage","data":{"type":"object","properties":{"startedDateTime":{"$ref":"#/components/schemas/datetime"},"id":{"type":"string","description":"An automatically-generated identifier string unique within the HAR"},"title":{"type":"string"},"pageTimings":{"$ref":"#/components/schemas/HarPageTimings"},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/HarPageTimings":{"id":"components/schemas/HarPageTimings","kind":"json-schema","title":"HarPageTimings","data":{"type":"object","properties":{"onContentLoad":{"type":"integer","minimum":-1,"nullable":true,"description":"Number of milliseconds from page load to firing of \"onContentLoad\" event, or -1 if not recorded"},"onLoad":{"type":"integer","minimum":-1,"nullable":true,"description":"Number of milliseconds from page load to firing of \"onLoad\" event, or -1 if not recorded"},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/nullableDatetime":{"id":"components/schemas/nullableDatetime","kind":"json-schema","title":"nullableDatetime","data":{"type":"string","format":"date-time","description":"The full date and time, according to ISO-8601 (e. g. 2020-08-25T21:15:43Z)","nullable":true}},"components/schemas/datetime":{"id":"components/schemas/datetime","kind":"json-schema","title":"datetime","data":{"type":"string","format":"date-time","description":"The full date and time, according to ISO-8601 (e. g. 2020-08-25T21:15:43Z)"}},"components/schemas/RequestId":{"id":"components/schemas/RequestId","kind":"json-schema","title":"RequestId","data":{"type":"string","format":"uuid","description":"A UUIDv4 unique identifier for a CMP data harvest request","maxLength":36}},"components/schemas/timestamp":{"id":"components/schemas/timestamp","kind":"json-schema","title":"timestamp","data":{"type":"integer","format":"int64"}},"components/schemas/CmpCookieGroups":{"id":"components/schemas/CmpCookieGroups","kind":"json-schema","title":"CmpCookieGroups","data":{"type":"object","required":["requestId","accountId","created","status","cmpProvider","sourceUrl","locale","groups"],"properties":{"requestId":{"$ref":"#/components/schemas/RequestId"},"accountId":{"$ref":"#/components/schemas/AccountId"},"created":{"$ref":"#/components/schemas/timestamp"},"status":{"$ref":"#/components/schemas/CmpCookieGroupStatus"},"errorMessage":{"type":"string","description":"(Optional) Present if status is FAILURE"},"cmpProvider":{"type":"string","description":"CMP provider","enum":["ONE_TRUST"]},"domain":{"type":"string","description":"Domain to which the gathered cookie groups are related"},"sourceUrl":{"type":"string","description":"URL of the page where the CMP data was harvested"},"locale":{"type":"string","description":"An ISO-3166 alpha-2 country code or 'US' followed by a 2 letter state code separated by comma"},"groups":{"type":"array","description":"Array of CMP cookie groups","items":{"$ref":"#/components/schemas/CmpCookieGrouping"}}}}},"components/schemas/CmpCookieGroupStatus":{"id":"components/schemas/CmpCookieGroupStatus","kind":"json-schema","title":"CmpCookieGroupStatus","data":{"type":"string","description":"Status of the CMP data harvest request","enum":["PROCESSING","COMPLETE","FAILURE"]}},"components/schemas/CmpCookieGrouping":{"id":"components/schemas/CmpCookieGrouping","kind":"json-schema","title":"CmpCookieGrouping","data":{"type":"object","description":"A consent group containing cookies assigned to the group","required":["groupId","groupName","cookies","status"],"properties":{"groupId":{"type":"string"},"groupName":{"type":"string"},"status":{"type":"string","description":"The current status of the CMP group on the domain. e.g. \"always active\", \"active\", \"inactive\"."},"cookies":{"type":"array","description":"The cookies in the consent group","items":{"$ref":"#/components/schemas/CmpCookieDefinition"}}}}},"components/schemas/CmpCookieDefinition":{"id":"components/schemas/CmpCookieDefinition","kind":"json-schema","title":"CmpCookieDefinition","data":{"type":"object","required":["domain","regexDomain","name"],"properties":{"domain":{"type":"string","description":"The raw domain of the cookie as reported by the CMP"},"regexDomain":{"type":"string","description":"The cookie domain with regex applied to include any subdomains"},"name":{"type":"string"},"nameIsRegex":{"type":"boolean","default":false,"description":"Indicates if the cookie name should be treated as a regular expression"},"description":{"type":"string"}}}},"components/schemas/HarRequest":{"id":"components/schemas/HarRequest","kind":"json-schema","title":"HarRequest","data":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"httpVersion":{"type":"string"},"cookies":{"type":"array","items":{"$ref":"#/components/schemas/HarCookie"}},"headers":{"type":"array","items":{"$ref":"#/components/schemas/HarHeaderOrQueryString"}},"queryString":{"type":"array","items":{"$ref":"#/components/schemas/HarHeaderOrQueryString"}},"postData":{"$ref":"#/components/schemas/HarPostData"},"headersSize":{"type":"integer","minimum":-1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of bytes in request headers (including ending \\r\\n\\r\\n). -1 if unavailable"},"children":[]}]}]}]},"bodySize":{"type":"integer","minimum":-1,"description":"Number of bytes in POST data payload. -1 if unavailable"},"comment":{"$ref":"#/components/schemas/HarComment"},"substitution":{"$ref":"#/components/schemas/Substitution"},"requestBlocking":{"$ref":"#/components/schemas/RequestBlocking"}}}},"components/schemas/HarPostData":{"id":"components/schemas/HarPostData","kind":"json-schema","title":"HarPostData","data":{"type":"object","properties":{"mimeType":{"type":"string","format":"mimeType"},"params":{"type":"array","items":{"$ref":"#/components/schemas/HarPostParameter"}},"text":{"type":"string"},"comment":{"$ref":"#/components/schemas/HarComment"}},"nullable":true}},"components/schemas/HarPostParameter":{"id":"components/schemas/HarPostParameter","kind":"json-schema","title":"HarPostParameter","data":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string","nullable":true},"fileName":{"type":"string","format":"fileName","nullable":true},"contentType":{"type":"string","format":"mimeType","nullable":true},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/HarEntry":{"id":"components/schemas/HarEntry","kind":"json-schema","title":"HarEntry","data":{"type":"object","properties":{"pageref":{"type":"string","nullable":true},"startedDateTime":{"$ref":"#/components/schemas/datetime"},"time":{"type":"integer","minimum":0,"description":"Request's duration in milliseconds"},"request":{"$ref":"#/components/schemas/HarRequest"},"response":{"$ref":"#/components/schemas/HarResponse"},"cache":{"$ref":"#/components/schemas/HarCache"},"timings":{"$ref":"#/components/schemas/HarEntryTimings"},"serverIPAddress":{"type":"string","format":"ipAddress","nullable":true},"connection":{"type":"string","nullable":true},"_tagId":{"type":"integer"},"_resourceType":{"type":"string","description":"The type of request (e.g. 'xhr', 'fetch', 'document', 'script', 'image', 'stylesheet', 'font', 'other')"},"comment":{"$ref":"#/components/schemas/HarComment"}}}},"components/schemas/Rule":{"id":"components/schemas/Rule","kind":"json-schema","title":"Rule","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"accountId":{"type":"integer","format":"int32"},"createdBy":{"type":"integer","format":"int32"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"recipients":{"type":"array","items":{"type":"string"}},"checkTimes":{"type":"integer","format":"int32"},"matchAllFilters":{"type":"boolean"},"pageFilters":{"type":"array","items":{"$ref":"#/components/schemas/PageFilter"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/RuleTag"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"}},"fromTemplate":{"type":"boolean"}}}},"components/schemas/PageFilter":{"id":"components/schemas/PageFilter","kind":"json-schema","title":"PageFilter","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"ruleId":{"type":"integer","format":"int32"},"value":{"type":"string"},"type":{"$ref":"#/components/schemas/PageFilterTypeEnum"},"matchType":{"$ref":"#/components/schemas/MatchTypeEnum"}}}},"components/schemas/PageFilterTypeEnum":{"id":"components/schemas/PageFilterTypeEnum","kind":"json-schema","title":"PageFilterTypeEnum","data":{"type":"integer","description":"Type of the page filter.","nullable":true,"enum":[1,2],"x-enum-varnames":["URL","STATUSCODE"],"x-enum-descriptions":["URL filter type","StatusCode filter type"]}},"components/schemas/MatchTypeEnum":{"id":"components/schemas/MatchTypeEnum","kind":"json-schema","title":"MatchTypeEnum","data":{"type":"string","nullable":true,"enum":["IsPresent","Equals","DoesNotEqual","Contains","DoesNotContain","IsSet","IsNotSet","Regex","GreaterThanOrEqualTo","LessThanOrEqualTo"]}},"components/schemas/RuleTag":{"id":"components/schemas/RuleTag","kind":"json-schema","title":"RuleTag","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"ruleId":{"type":"integer","format":"int32"},"tagId":{"type":"integer","format":"int32"},"matchType":{"$ref":"#/components/schemas/MatchTypeEnum"},"account":{"type":"string"},"validationDescription":{"type":"string"},"clause":{"$ref":"#/components/schemas/ClauseEnum"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/RuleTagVariable"}}}}},"components/schemas/ClauseEnum":{"id":"components/schemas/ClauseEnum","kind":"json-schema","title":"ClauseEnum","data":{"type":"string","nullable":true,"enum":["If","Then","Else"]}},"components/schemas/RuleTagVariable":{"id":"components/schemas/RuleTagVariable","kind":"json-schema","title":"RuleTagVariable","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"ruleTagId":{"type":"integer","format":"int32"},"variable":{"type":"string"},"value":{"type":"string"},"validationDescription":{"type":"string"},"matchType":{"$ref":"#/components/schemas/MatchTypeEnum"},"valueTagId":{"type":"integer","format":"int32"},"selectorType":{"$ref":"#/components/schemas/SelectorTypeEnum"}}}},"components/schemas/SelectorTypeEnum":{"id":"components/schemas/SelectorTypeEnum","kind":"json-schema","title":"SelectorTypeEnum","data":{"type":"string","enum":["Empty","String","UrlParameter","DataLayer","Tag"]}},"components/schemas/GeoLocationCountryDTO":{"id":"components/schemas/GeoLocationCountryDTO","kind":"json-schema","title":"GeoLocationCountryDTO","data":{"type":"object","description":"Represents a country with geo-location information including continent details","required":["countryId","countryName","countryCode","continentId","continentName"],"properties":{"countryId":{"type":"integer","description":"Unique identifier for the country","example":46},"countryName":{"type":"string","description":"Display name of the country","example":"China"},"countryCode":{"type":"string","description":"ISO country code (2-letter code)","example":"CN","maxLength":2,"minLength":2},"continentId":{"type":"integer","description":"Unique identifier for the continent this country belongs to","example":5},"continentName":{"type":"string","description":"Name of the continent this country belongs to","example":"Asia"}}}},"components/schemas/BrowserInfoDTO":{"id":"components/schemas/BrowserInfoDTO","kind":"json-schema","title":"BrowserInfoDTO","data":{"type":"object","description":"Browser configuration information for audit run snapshots","properties":{"width":{"type":"integer","description":"Browser viewport width in pixels","example":1920},"height":{"type":"integer","description":"Browser viewport height in pixels","example":1080},"gcpEnabled":{"type":"boolean","description":"Global Privacy Control (GPC) enabled flag","example":true},"vpnEnabled":{"type":"boolean","description":"VPN enabled flag for the audit run","example":false}}}},"components/schemas/AuditFiltersSnapshotRequestDTO":{"id":"components/schemas/AuditFiltersSnapshotRequestDTO","kind":"json-schema","title":"AuditFiltersSnapshotRequestDTO","data":{"type":"object","description":"Request body for creating audit run snapshots with optional filter override","properties":{"filterSnapshotOverride":{"$ref":"#/components/schemas/AuditFilterSnapshotDTO"}}}},"components/schemas/AuditFilterSnapshotDTO":{"id":"components/schemas/AuditFilterSnapshotDTO","kind":"json-schema","title":"AuditFilterSnapshotDTO","data":{"type":"object","description":"Audit filter snapshot configuration","properties":{"accountId":{"type":"integer","description":"Account ID for the audit filter snapshot"},"itemId":{"type":"integer","format":"int64","description":"Item ID (audit ID) for the snapshot"},"runId":{"type":"integer","format":"int64","description":"Run ID for the snapshot"},"includes":{"type":"array","description":"List of include filters","items":{"$ref":"#/components/schemas/AuditFilterDTO"}},"excludes":{"type":"array","description":"List of exclude filters","items":{"$ref":"#/components/schemas/AuditFilterDTO"}}}}},"components/schemas/AuditFilterDTO":{"id":"components/schemas/AuditFilterDTO","kind":"json-schema","title":"AuditFilterDTO","data":{"type":"object","description":"Audit filter configuration","properties":{"filter":{"type":"string","description":"Filter pattern or value","example":"https://example.com/*"},"includeLimit":{"type":"integer","nullable":true,"description":"Include limit for the filter (null for exclude filters)","example":100}}}},"components/schemas/WebAuditDTO":{"id":"components/schemas/WebAuditDTO","kind":"json-schema","title":"WebAuditDTO","data":{"type":"object","description":"Web audit information","required":["auditId","auditName","folderId","domainId"],"properties":{"auditId":{"type":"integer","description":"Unique identifier for the audit"},"auditName":{"type":"string","description":"Name of the audit"},"ownerId":{"type":"integer","description":"User ID of the audit owner"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the audit was created"},"folderId":{"type":"integer","description":"Folder ID where the audit is stored"},"domainId":{"type":"integer","description":"Domain ID associated with the audit"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the audit was last updated"}}}},"components/schemas/AuditNotesDTO":{"id":"components/schemas/AuditNotesDTO","kind":"json-schema","title":"AuditNotesDTO","data":{"type":"object","description":"Audit notes information","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier for the audit notes"},"notes":{"type":"string","description":"Notes content for the audit"}}}},"components/schemas/LatestRunItemDTO":{"id":"components/schemas/LatestRunItemDTO","kind":"json-schema","title":"LatestRunItemDTO","data":{"type":"object","description":"Latest run information for an audit","required":["id","name","latestRun","domainInfo"],"properties":{"id":{"type":"integer","description":"Audit ID"},"name":{"type":"string","description":"Audit name"},"latestRun":{"$ref":"#/components/schemas/RunInfoDTO"},"domainInfo":{"$ref":"#/components/schemas/DomainInfoDTO"},"labels":{"type":"array","description":"Labels associated with the audit","items":{"$ref":"#/components/schemas/Label"}}}}},"components/schemas/RunInfoDTO":{"id":"components/schemas/RunInfoDTO","kind":"json-schema","title":"RunInfoDTO","data":{"type":"object","description":"Run execution information","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"Run ID"},"completedAt":{"type":"string","format":"date-time","description":"Timestamp when the run completed"},"pageCount":{"type":"integer","format":"int64","description":"Number of pages processed in the run"}}}},"components/schemas/DomainInfoDTO":{"id":"components/schemas/DomainInfoDTO","kind":"json-schema","title":"DomainInfoDTO","data":{"type":"object","description":"Domain information","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}}},"components/schemas/WebJourneyDTO":{"id":"components/schemas/WebJourneyDTO","kind":"json-schema","title":"WebJourneyDTO","data":{"type":"object","description":"Web journey configuration and metadata","required":["id","name","domainId","userId"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier for the web journey","example":12345},"name":{"type":"string","description":"Name of the web journey","example":"E-commerce Checkout Flow","maxLength":255},"notes":{"type":"string","description":"Optional notes or description","example":"Tests the complete checkout process","nullable":true},"domainId":{"type":"integer","description":"ID of the associated domain","example":123},"userId":{"type":"integer","description":"ID of the user who created this web journey","example":456},"folderId":{"type":"integer","description":"ID of the folder containing this web journey","example":789,"nullable":true},"browserWidth":{"type":"integer","description":"Browser viewport width in pixels","example":1920,"minimum":250,"maximum":10000,"nullable":true},"browserHeight":{"type":"integer","description":"Browser viewport height in pixels","example":1080,"minimum":250,"maximum":10000,"nullable":true},"loadVideos":{"type":"boolean","description":"Whether to load video content","example":true,"nullable":true},"vpnEnabled":{"type":"boolean","description":"Whether VPN is enabled for this journey","example":false,"nullable":true},"gpcEnabled":{"type":"boolean","description":"Whether Global Privacy Control is enabled","example":true,"nullable":true},"blockThirdPartyCookies":{"type":"boolean","description":"Whether to block third-party cookies","example":false,"nullable":true},"frequency":{"$ref":"#/components/schemas/WebJourneyFrequencyEnum"},"location":{"type":"string","description":"Geographic location for the web journey execution","example":"US-West","nullable":true},"userAgent":{"type":"string","description":"User agent string to use","example":"Chrome/91.0.4472.124","nullable":true},"userAgentDescription":{"type":"string","description":"Human-readable description of the user agent","example":"Chrome Browser","nullable":true},"customProxy":{"type":"string","description":"Custom proxy server configuration","example":"proxy.example.com:8080","nullable":true},"monitoredByScriptServices":{"type":"boolean","description":"Whether this journey is monitored by script services","example":true,"nullable":true},"createdAt":{"type":"string","format":"date-time","description":"When the web journey was created","example":"2023-06-01T10:30:00Z"},"nextCheck":{"type":"string","format":"date-time","description":"When the next execution is scheduled","example":"2023-06-02T10:30:00Z","nullable":true},"schedule":{"$ref":"#/components/schemas/Schedule","nullable":true}}}},"components/schemas/WebJourneyUpdateDTO":{"id":"components/schemas/WebJourneyUpdateDTO","kind":"json-schema","title":"WebJourneyUpdateDTO","data":{"type":"object","description":"Web journey data for creation or update","required":["domainId"],"properties":{"name":{"type":"string","description":"Name of the web journey","example":"E-commerce Checkout Flow","maxLength":255},"notes":{"type":"string","description":"Optional notes or description","example":"Tests the complete checkout process","nullable":true},"domainId":{"type":"integer","description":"ID of the associated domain","example":123},"userId":{"type":"integer","description":"ID of the user who created this web journey","example":456},"folderId":{"type":"integer","description":"ID of the folder containing this web journey","example":789,"nullable":true},"browserWidth":{"type":"integer","description":"Browser viewport width in pixels","example":1920,"minimum":250,"maximum":10000,"nullable":true},"browserHeight":{"type":"integer","description":"Browser viewport height in pixels","example":1080,"minimum":250,"maximum":10000,"nullable":true},"loadVideos":{"type":"boolean","description":"Whether to load video content","example":true,"nullable":true},"vpnEnabled":{"type":"boolean","description":"Whether VPN is enabled for this journey","example":false,"nullable":true},"gpcEnabled":{"type":"boolean","description":"Whether Global Privacy Control is enabled","example":true,"nullable":true},"blockThirdPartyCookies":{"type":"boolean","description":"Whether to block third-party cookies","example":false,"nullable":true},"frequency":{"$ref":"#/components/schemas/WebJourneyFrequencyEnum"},"location":{"type":"string","description":"Geographic location for the web journey execution","example":"US-West","nullable":true},"userAgent":{"type":"string","description":"User agent string to use","example":"Chrome/91.0.4472.124","nullable":true},"userAgentDescription":{"type":"string","description":"Human-readable description of the user agent","example":"Chrome Browser","nullable":true},"customProxy":{"type":"string","description":"Custom proxy server configuration","example":"proxy.example.com:8080","nullable":true},"monitoredByScriptServices":{"type":"boolean","description":"Whether this journey is monitored by script services","example":true,"nullable":true},"nextCheck":{"type":"string","format":"date-time","description":"When the next execution is scheduled","example":"2023-06-02T10:30:00Z","nullable":true},"schedule":{"$ref":"#/components/schemas/BaseScheduleForCreation","nullable":true}}}},"components/schemas/WebJourneyStatusDTO":{"id":"components/schemas/WebJourneyStatusDTO","kind":"json-schema","title":"WebJourneyStatusDTO","data":{"type":"object","description":"Current status of a web journey","required":["status","webJourneyRunning","queued"],"properties":{"status":{"$ref":"#/components/schemas/WebJourneyRunStatusEnum"},"webJourneyRunning":{"type":"boolean","description":"Whether the web journey is currently running","example":false},"lastCheck":{"type":"string","format":"date-time","description":"When the web journey was last executed","example":"2023-06-01T16:45:00Z","nullable":true},"queued":{"type":"boolean","description":"Whether the web journey is queued for execution","example":false},"failureType":{"$ref":"#/components/schemas/WebJourneyFailureTypeEnum","nullable":true,"description":"The failure type of the last run, present only when status indicates failure"}}}},"components/schemas/WebJourneyFrequencyEnum":{"id":"components/schemas/WebJourneyFrequencyEnum","kind":"json-schema","title":"WebJourneyFrequencyEnum","data":{"type":"string","description":"Frequency options for web journey execution","enum":["paused","once","15 minutes","1 hour","6 hours","12 hours","daily","weekly","biweekly","monthly"],"example":"daily"}},"components/schemas/WebJourneyRunStatusEnum":{"id":"components/schemas/WebJourneyRunStatusEnum","kind":"json-schema","title":"WebJourneyRunStatusEnum","data":{"type":"string","description":"Status of a web journey run","enum":["NotChecked","Ok","Failure","PageFailure","ActionFailure","RulesFailure","ExecutingActions","ProcessingRules","DataCollectionFailure"],"example":"Ok"}},"components/schemas/WebJourneyFailureTypeEnum":{"id":"components/schemas/WebJourneyFailureTypeEnum","kind":"json-schema","title":"WebJourneyFailureTypeEnum","data":{"type":"string","description":"Type of failure for a web journey run","enum":["JOURNEY_ACTION_FAIL","JOURNEY_COOKIE_COLLECTION_ERROR","JOURNEY_DATA_LAYER_COLLECTION_ERROR","JOURNEY_HAR_COLLECTION_ERROR","JOURNEY_SCREENSHOT_COLLECTION_ERROR","JOURNEY_DATA_COLLECTION_ERROR"]}},"components/schemas/WebActionSelectorTypeEnum":{"id":"components/schemas/WebActionSelectorTypeEnum","kind":"json-schema","title":"WebActionSelectorTypeEnum","data":{"type":"string","description":"Types of web element selectors","enum":["CSS","XPath","ID","Name","Class","Tag","Attribute"],"example":"CSS"}},"components/schemas/RemoteFileMapping":{"id":"components/schemas/RemoteFileMapping","kind":"json-schema","title":"RemoteFileMapping","data":{"type":"object","description":"Remote file mapping configuration","required":["id","name","matchType","matchValue","accountId","createdBy","createdAt","updatedBy","updatedAt"],"properties":{"id":{"type":"integer","format":"int64","description":"Simple surrogate key in the database for this RFM config","example":123},"name":{"type":"string","maxLength":255,"description":"A user-supplied name to identify this RFM config","example":"Google Analytics Replacement"},"fileId":{"type":"string","description":"A string GUID used as the uploaded replacement file's \"name\" in S3","example":"8c59d02b-6ebc-4893-9391-9be26c6d34cc","nullable":true},"fileUrl":{"type":"string","maxLength":5000,"description":"The replacement URL, or else the name of the replacement file before it was uploaded","example":"https://example.com/replacement-script.js","nullable":true},"matchType":{"type":"string","enum":["equals","regex"],"description":"Either \"regex\" or \"equals\"","example":"equals"},"matchValue":{"type":"string","description":"The request URL to be replaced (or the regex that matches URLs to replace)","example":"https://www.google-analytics.com/analytics.js"},"accountId":{"type":"integer","description":"Foreign key reference to accounts table. The owner of this RemoteFileMapping","example":343},"createdBy":{"type":"integer","description":"Foreign key reference to the users table. Who created this RFM?","example":1362},"createdAt":{"type":"string","format":"date-time","description":"When this RFM was created","example":"2024-01-01T10:15:00.000Z"},"updatedBy":{"type":"integer","description":"Foreign key reference to the users table. Who updated this RFM most recently?","example":1362},"updatedAt":{"type":"string","format":"date-time","description":"When this RFM was last updated","example":"2024-01-02T10:15:00.000Z"}}}},"components/schemas/RemoteFileMappingRequest":{"id":"components/schemas/RemoteFileMappingRequest","kind":"json-schema","title":"RemoteFileMappingRequest","data":{"type":"object","description":"Request data for creating or updating remote file mapping","required":["name","matchType","matchValue"],"properties":{"name":{"type":"string","maxLength":255,"description":"A user-supplied name to identify this RFM config","example":"Google Analytics Replacement"},"fileId":{"type":"string","description":"A string GUID used as the uploaded replacement file's \"name\" in S3","example":"8c59d02b-6ebc-4893-9391-9be26c6d34cc","nullable":true},"fileUrl":{"type":"string","maxLength":5000,"description":"The replacement URL, or else the name of the replacement file before it was uploaded","example":"https://example.com/replacement-script.js","nullable":true},"matchType":{"type":"string","enum":["equals","regex"],"description":"Either \"regex\" or \"equals\"","example":"equals"},"matchValue":{"type":"string","description":"The request URL to be replaced (or the regex that matches URLs to replace)","example":"https://www.google-analytics.com/analytics.js"}}}},"components/schemas/FileUploadResponse":{"id":"components/schemas/FileUploadResponse","kind":"json-schema","title":"FileUploadResponse","data":{"type":"object","description":"Response for file upload operation","required":["fileId"],"properties":{"fileId":{"type":"string","description":"Unique identifier for the uploaded file","example":"g3c7fa03-e442-c57b-b179-b349ee4ebce4"}}}},"components/schemas/GitHubAppInstallationLinkResponse":{"id":"components/schemas/GitHubAppInstallationLinkResponse","kind":"json-schema","title":"GitHubAppInstallationLinkResponse","data":{"type":"object","description":"GitHub App installation record","required":["id","createdByUserId","initiatedAt","status"],"properties":{"id":{"type":"integer","format":"int32"},"createdByUserId":{"$ref":"#/components/schemas/UserId"},"status":{"$ref":"#/components/schemas/GitHubAppInstallationStatusEnum"},"orgName":{"type":"string"},"initiatedAt":{"$ref":"#/components/schemas/DateAndTime"},"completedAt":{"$ref":"#/components/schemas/DateAndTime"},"updatedAt":{"$ref":"#/components/schemas/DateAndTime"},"lastUsedAt":{"$ref":"#/components/schemas/DateAndTime"},"disabledAt":{"$ref":"#/components/schemas/DateAndTime"},"installationUrl":{"type":"string","format":"uri","description":"GitHub App installation URL (only populated for pending installations)"},"expiresAt":{"$ref":"#/components/schemas/DateAndTime"}}}},"components/schemas/GhAppNameEnum":{"id":"components/schemas/GhAppNameEnum","kind":"json-schema","title":"GhAppNameEnum","data":{"type":"string","description":"Allowed GitHub App names for installation","enum":["observepoint-integration","observepoint-test-app"]}},"components/schemas/GitHubAppInstallationStatusEnum":{"id":"components/schemas/GitHubAppInstallationStatusEnum","kind":"json-schema","title":"GitHubAppInstallationStatusEnum","data":{"type":"string","description":"Installation status values aligned with backend enum","enum":["pending","active","disabled"]}},"components/schemas/GitHubAppInstallationSortByEnum":{"id":"components/schemas/GitHubAppInstallationSortByEnum","kind":"json-schema","title":"GitHubAppInstallationSortByEnum","data":{"type":"string","description":"Sortable fields for GitHub App installations","enum":["initiated_at","completed_at","org_name"]}},"components/schemas/GitHubAppInstallationDTO":{"id":"components/schemas/GitHubAppInstallationDTO","kind":"json-schema","title":"GitHubAppInstallationDTO","data":{"type":"object","description":"GitHub App installation record","required":["id","createdByUserId","initiatedAt","status"],"properties":{"id":{"type":"integer","format":"int32"},"createdByUserId":{"$ref":"#/components/schemas/UserId"},"status":{"$ref":"#/components/schemas/GitHubAppInstallationStatusEnum"},"orgName":{"type":"string"},"initiatedAt":{"$ref":"#/components/schemas/DateAndTime"},"completedAt":{"$ref":"#/components/schemas/DateAndTime"},"updatedAt":{"$ref":"#/components/schemas/DateAndTime"},"lastUsedAt":{"$ref":"#/components/schemas/DateAndTime"},"disabledAt":{"$ref":"#/components/schemas/DateAndTime"},"installationUrl":{"type":"string","format":"uri","description":"GitHub App installation URL (only populated for pending installations)"},"expiresAt":{"$ref":"#/components/schemas/DateAndTime"}}}},"components/schemas/GitHubAppInstallations_ResponseDTO":{"id":"components/schemas/GitHubAppInstallations_ResponseDTO","kind":"json-schema","title":"GitHubAppInstallations_ResponseDTO","data":{"type":"object","required":["installations"],"properties":{"installations":{"type":"array","items":{"$ref":"#/components/schemas/GitHubAppInstallationDTO"}}}}},"components/schemas/GitHubAppInstallationCompleteRequestDTO":{"id":"components/schemas/GitHubAppInstallationCompleteRequestDTO","kind":"json-schema","title":"GitHubAppInstallationCompleteRequestDTO","data":{"type":"object","description":"Request to complete a GitHub App installation.\nMust provide exactly one of: redirectSecret (for direct link flow) or claimCode (for claim flow).\n","properties":{"redirectSecret":{"type":"string","format":"uuid","description":"Secret from OAuth flow redirect (Phase 2A - user with ObservePoint account)"},"claimCode":{"type":"string","minLength":10,"maxLength":10,"pattern":"^[A-Za-z0-9]{10}$","description":"10-character alphanumeric claim code (Phase 2B - teammate claims on behalf of GH admin)"}}}},"components/schemas/GitHubAppInstallationCompleteResponseDTO":{"id":"components/schemas/GitHubAppInstallationCompleteResponseDTO","kind":"json-schema","title":"GitHubAppInstallationCompleteResponseDTO","data":{"type":"object","required":["installationId"],"properties":{"installationId":{"$ref":"#/components/schemas/GitHubAppInstallationRecordId"}},"description":"Response returned when an installation request is successfully completed"}},"components/schemas/GitHubAppOAuthInitiateRequestDTO":{"id":"components/schemas/GitHubAppOAuthInitiateRequestDTO","kind":"json-schema","title":"GitHubAppOAuthInitiateRequestDTO","data":{"type":"object","required":["installationId","hasOpAccount"],"properties":{"installationId":{"$ref":"#/components/schemas/InstallationId"},"hasOpAccount":{"type":"boolean","description":"Whether user has an ObservePoint account"}},"description":"Request to initiate GitHub OAuth flow for a GitHub App installation.\nUser decision on whether they have an ObservePoint account determines the subsequent flow.\n"}},"components/schemas/GitHubAppRedirectResponseDTO":{"id":"components/schemas/GitHubAppRedirectResponseDTO","kind":"json-schema","title":"GitHubAppRedirectResponseDTO","data":{"type":"object","required":["redirectUri"],"properties":{"redirectUri":{"type":"string","format":"uri","description":"URI to redirect the user to"}},"description":"Common response containing a redirect URI for GitHub App OAuth flows"}},"components/schemas/WebJourneyRun_ErrorCode":{"id":"components/schemas/WebJourneyRun_ErrorCode","kind":"json-schema","title":"WebJourneyRun_ErrorCode","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10: ValidationError"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11: MalformedRequest"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"33: AlreadyRunning"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"34: UsageLimitExceeded"},"children":[]}]}]}]}]}},"components/schemas/WebJourneyBulkRun_RequestDTO":{"id":"components/schemas/WebJourneyBulkRun_RequestDTO","kind":"json-schema","title":"WebJourneyBulkRun_RequestDTO","data":{"type":"array","description":"Array of web journey IDs to start","items":{"$ref":"#/components/schemas/WebJourneyId"},"example":[107239,107240,107241]}},"components/schemas/WebJourneyBulkRun_ResponseDTO":{"id":"components/schemas/WebJourneyBulkRun_ResponseDTO","kind":"json-schema","title":"WebJourneyBulkRun_ResponseDTO","data":{"type":"object","description":"Response for bulk run request","properties":{"failures":{"type":"array","description":"Journey IDs that encountered failures","items":{"$ref":"#/components/schemas/WebJourneyId"}}},"required":["failures"],"example":{"failures":[107240,107241]}}},"components/schemas/WebJourneyRun_CreatedResponseDTO":{"id":"components/schemas/WebJourneyRun_CreatedResponseDTO","kind":"json-schema","title":"WebJourneyRun_CreatedResponseDTO","data":{"type":"object","description":"Response when a run is successfully created","properties":{"newRunId":{"type":"integer","format":"int64","description":"The ID of the newly created run"}},"required":["newRunId"],"example":{"newRunId":5765432}}},"components/schemas/WebJourneyRun_RunExistsResponseDTO":{"id":"components/schemas/WebJourneyRun_RunExistsResponseDTO","kind":"json-schema","title":"WebJourneyRun_RunExistsResponseDTO","data":{"type":"object","description":"Response when a journey is already running","properties":{"currentRunId":{"type":"integer","format":"int64","description":"The ID of the currently running run"},"code":{"$ref":"#/components/schemas/WebJourneyRun_ErrorCode"}},"required":["currentRunId","code"],"example":{"currentRunId":5765431,"code":33}}},"components/schemas/WebJourneyRun_ErrorResponseDTO":{"id":"components/schemas/WebJourneyRun_ErrorResponseDTO","kind":"json-schema","title":"WebJourneyRun_ErrorResponseDTO","data":{"type":"object","properties":{"message":{"type":"string"},"code":{"$ref":"#/components/schemas/WebJourneyRun_ErrorCode"}},"required":["message","code"],"example":{"message":"An error occurred","code":10}}},"schema_594":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditId"},"id":"schema_594"},"schema_595":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RunId"},"id":"schema_595"},"schema_596":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0},"id":"schema_596"},"schema_597":{"kind":"json-schema","data":{"type":"integer","maximum":1000,"default":50,"minimum":50},"id":"schema_597"},"schema_598":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_AuditSummary_AlertsSortColumn"},"id":"schema_598"},"schema_599":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_599"},"schema_600":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AlertId"},"id":"schema_600"},"schema_601":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_AuditSummary_TrendsEnum"},"id":"schema_601"},"schema_602":{"kind":"json-schema","data":{"type":"integer","description":"Number of days to get trend values for, relative to current time","maximum":390,"minimum":1},"id":"schema_602"},"schema_603":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_AuditSummary_ScoreTrendsEnum"},"id":"schema_603"},"schema_604":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_BrowserLogs_TrendsEnum"},"id":"schema_604"},"schema_605":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_BrowserLogs_MessagesSortColumn"},"id":"schema_605"},"schema_606":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_BrowserLogs_PagesSortColumn"},"id":"schema_606"},"schema_607":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_CookieInventory_TrendsEnum"},"id":"schema_607"},"schema_608":{"kind":"json-schema","data":{"type":"integer","maximum":1000,"default":100,"minimum":100},"id":"schema_608"},"schema_609":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_CookieInventory_CookiesSortColumn"},"id":"schema_609"},"schema_610":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_CookieInventory_PageSortColumn"},"id":"schema_610"},"schema_611":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_CookieInventory_DomainSortColumn"},"id":"schema_611"},"schema_612":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_CookiePrivacy_TrendsEnum"},"id":"schema_612"},"schema_613":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_CookiePrivacy_CookiesSortColumn"},"id":"schema_613"},"schema_614":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_CookiePrivacy_PagesSortColumn"},"id":"schema_614"},"schema_615":{"kind":"json-schema","data":{"type":"integer","maximum":200,"default":50,"minimum":50},"id":"schema_615"},"schema_616":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_FileChanges_FilesSortColumn"},"id":"schema_616"},"schema_617":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_FileChanges_PagesSortColumn"},"id":"schema_617"},"schema_618":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PageId"},"id":"schema_618"},"schema_619":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_PageInfo_LinkDirection"},"id":"schema_619"},"schema_620":{"kind":"json-schema","data":{"type":"array","minItems":1,"maxItems":3,"items":{"$ref":"#/components/schemas/AuditRun_PageInfo_LinkDownloadOptionEnum"}},"id":"schema_620"},"schema_621":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_PageInfo_ThisUrlTypeEnum"},"id":"schema_621"},"schema_622":{"kind":"json-schema","data":{"type":"string","format":"csv","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AuditRun_PageInfo_LinkItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for single row schema"},"children":[]}]}]}]},"id":"schema_622"},"schema_623":{"kind":"json-schema","data":{"type":"object","properties":{"content-disposition":{"type":"string","example":"attachment; filename=\"page-summary-links-to-this-page-My_Audit-2022-03-22_15-16-17.csv\"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the name of the downloaded file (in case of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" content)"},"children":[]}]}]}]}}},"id":"schema_623"},"schema_624":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/FileMappingResultsDTO"}},"id":"schema_624"},"schema_625":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_625"},"schema_626":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_PageDetails_RequestLogSortColumn"},"id":"schema_626"},"schema_627":{"kind":"json-schema","data":{"type":"string"},"id":"schema_627"},"schema_628":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRunPage_BrowserLogs_MessagesSortColumn"},"id":"schema_628"},"schema_629":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_PageDetails_TrendsEnum"},"id":"schema_629"},"schema_630":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":390,"example":120},"id":"schema_630"},"schema_631":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_WebVitalsTrends_Enum"},"id":"schema_631"},"schema_632":{"kind":"json-schema","data":{"type":"integer","maximum":10000,"default":50,"minimum":50},"id":"schema_632"},"schema_633":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_PageSummary_PagesSortColumn"},"id":"schema_633"},"schema_634":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_PageSummary_TrendsEnum"},"id":"schema_634"},"schema_635":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_RequestPrivacy_TrendsEnum"},"id":"schema_635"},"schema_636":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_RequestPrivacy_RequestsSortColumn"},"id":"schema_636"},"schema_637":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_RequestPrivacy_PagesSortColumn"},"id":"schema_637"},"schema_638":{"kind":"json-schema","data":{"type":"integer","description":"Number of days to get trend values for, relative to current time"},"id":"schema_638"},"schema_639":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RuleSnapshotId"},"id":"schema_639"},"schema_640":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_RuleSummary_AllRules_PagesSortColumn"},"id":"schema_640"},"schema_641":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_RuleSummary_SpecificRule_PagesSortColumn"},"id":"schema_641"},"schema_642":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_TrendsEnum"},"id":"schema_642"},"schema_643":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TagId"},"id":"schema_643"},"schema_644":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_TagAccountsSortColumn"},"id":"schema_644"},"schema_645":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagDuplicatesAndMultiples_PagesSortColumn"},"id":"schema_645"},"schema_646":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagHealth_TrendsEnum"},"id":"schema_646"},"schema_647":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagHealth_TagAccountsSortColumn"},"id":"schema_647"},"schema_648":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagHealth_PageSortColumn"},"id":"schema_648"},"schema_649":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagInventory_TrendsEnum"},"id":"schema_649"},"schema_650":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagInventory_PagesSortColumn"},"id":"schema_650"},"schema_651":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagPrivacy_TrendsEnum"},"id":"schema_651"},"schema_652":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagPrivacy_TagsSortColumn"},"id":"schema_652"},"schema_653":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_TagPrivacy_PagesSortColumn"},"id":"schema_653"},"schema_654":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_VariableInventory_TrendsEnum"},"id":"schema_654"},"schema_655":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_VariableInventory_PagesSortColumn"},"id":"schema_655"},"schema_656":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_VariableInventory_VariableValuesSortColumn"},"id":"schema_656"},"schema_657":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_PagesSort"},"id":"schema_657"},"schema_658":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CookieDTO"}},"id":"schema_658"},"schema_659":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/GeoLocationDTO"}},"id":"schema_659"},"schema_660":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"The URL to which the client will be redirected"}}},"id":"schema_660"},"schema_661":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WebJourneyId"},"id":"schema_661"},"schema_662":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ActionSequenceId"},"id":"schema_662"},"schema_663":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ActionId"},"id":"schema_663"},"schema_664":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AccountUsageExportTypeEnum"},"id":"schema_664"},"schema_665":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exact type depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param, see mapping in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountUsageExportTypeToFilterMapping"},"children":[]}]}]}]},"id":"schema_665"},"schema_666":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AlertExportTypeEnum"},"id":"schema_666"},"schema_667":{"kind":"json-schema","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same constraints applied as on regular \"get items list\" endpoint, depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportType"},"children":[]}]}]}],"default":50},"id":"schema_667"},"schema_668":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must correspond to sort column enum appropriate for given export type, see mapping in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlertExportTypeToSortColumnMapping"},"children":[]}]}]}]},"id":"schema_668"},"schema_669":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exact type depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param, see mapping in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlertExportTypeToFilterMapping"},"children":[]}]}]}]},"id":"schema_669"},"schema_670":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuditRun_ExportTypeEnum"},"id":"schema_670"},"schema_671":{"kind":"json-schema","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same constraints applied as on regular \"get items list\" endpoint, depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportType"},"children":[]}]}]}]},"id":"schema_671"},"schema_672":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must correspond to sort column enum appropriate for given export type, see mapping in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AuditRun_ExportTypeToSortColumnMapping"},"children":[]}]}]}]},"id":"schema_672"},"schema_673":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exact type depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param, see mapping in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AuditRun_ExportTypeToFilterMapping"},"children":[]}]}]}]},"id":"schema_673"},"schema_674":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ConsentCategory_ExportTypeEnum"},"id":"schema_674"},"schema_675":{"kind":"json-schema","data":{"type":"integer","default":20,"minimum":20,"maximum":200},"id":"schema_675"},"schema_676":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ExportCenter_ExportsSortColumn"},"id":"schema_676"},"schema_677":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ExportCenter_ExportedItemTypeEnum"},"id":"schema_677"},"schema_678":{"kind":"json-schema","data":{"type":"string","example":"my audit"},"id":"schema_678"},"schema_679":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UserId"},"id":"schema_679"},"schema_680":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ExportId"}},"id":"schema_680"},"schema_681":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ExportUuid"},"id":"schema_681"},"schema_682":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string"}}},"id":"schema_682"},"schema_683":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ManualJourneyId"},"id":"schema_683"},"schema_684":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ManualJourneyRun_ExportTypeEnum"},"id":"schema_684"},"schema_685":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ScheduledExports_ExportedItemType"},"id":"schema_685"},"schema_686":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ScheduledExports_ExportedItemId"},"id":"schema_686"},"schema_687":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ScheduledExports_SortColumn"},"id":"schema_687"},"schema_688":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ScheduledExportId"},"id":"schema_688"},"schema_689":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WebJourneyRun_ExportTypeEnum"},"id":"schema_689"},"schema_690":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exact type depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param, see mapping in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WebJourneyRun_ExportTypeToFilterMapping"},"children":[]}]}]}]},"id":"schema_690"},"schema_691":{"kind":"json-schema","data":{"$ref":"#/components/schemas/GetAccountTriggeredAlertsSortColumn"},"id":"schema_691"},"schema_692":{"kind":"json-schema","data":{"$ref":"#/components/schemas/GetAccountTriggeredAlertSortColumn"},"id":"schema_692"},"schema_693":{"kind":"json-schema","data":{"title":"AlertSetLabelsRequestDTO","description":"existing labels will be overwritten by labels listed here","type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/LabelId"}}}},"id":"schema_693"},"schema_694":{"kind":"json-schema","data":{"$ref":"#/components/schemas/GetAlertsLibrarySortColumn"},"id":"schema_694"},"schema_695":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AlertMetricTypeEnum"},"id":"schema_695"},"schema_696":{"kind":"json-schema","data":{"$ref":"#/components/schemas/GetAlertsByMetricSortColumn"},"id":"schema_696"},"schema_697":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AlertAssignmentItemTypeEnum"},"id":"schema_697"},"schema_698":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AlertAssignmentsSortColumn"},"id":"schema_698"},"schema_699":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SearchAlertsForAssignmentSortColumn"},"id":"schema_699"},"schema_700":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AlertAssignmentItemId"},"id":"schema_700"},"schema_701":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AccountUsageV2_ItemTypeEnum"},"id":"schema_701"},"schema_702":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EmailInboxId"},"id":"schema_702"},"schema_703":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/AuditId"}},"id":"schema_703"},"schema_704":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/LabelId"}},"id":"schema_704"},"schema_705":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Label"}},"id":"schema_705"},"schema_706":{"kind":"json-schema","data":{"type":"string","example":"My notes for this inbox. This inbox will audit marketing emails."},"id":"schema_706"},"schema_707":{"kind":"json-schema","data":{"type":"number"},"id":"schema_707"},"schema_708":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EmailInboxLibrarySortByEnum"},"id":"schema_708"},"schema_709":{"kind":"json-schema","data":{"type":"array","description":"The collection of the audits associated to an Email Inbox","items":{"$ref":"#/components/schemas/EmailInboxConfigurationDTO"}},"id":"schema_709"},"schema_710":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"integer","maxItems":200}},"id":"schema_710"},"schema_711":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ReceivedEmailMessageBaseDTO"}},"id":"schema_711"},"schema_712":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Rule"}},"id":"schema_712"},"schema_713":{"kind":"json-schema","data":{"uniqueItems":true,"type":"array","description":"Set of rule IDs to associate with the action","items":{"type":"integer","format":"int32"}},"id":"schema_713"},"schema_714":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ActionSetDto"}},"id":"schema_714"},"schema_715":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ActionSetActionDto"}},"id":"schema_715"},"schema_716":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLoginSequencedAction"}},"id":"schema_716"},"schema_717":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WebAuditDTO"}},"id":"schema_717"},"schema_718":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/LatestRunItemDTO"}},"id":"schema_718"},"schema_719":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategoryDTO"}},"id":"schema_719"},"schema_720":{"kind":"json-schema","data":{"type":"object","properties":{"upload":{"type":"string","format":"binary"}}},"id":"schema_720"},"schema_721":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"}},"id":"schema_721"},"schema_722":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ConsentCategory_TypeEnum"},"id":"schema_722"},"schema_723":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ConsentCategory_VendorTypeEnum"},"id":"schema_723"},"schema_724":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ConsentCategoryLibrarySortByEnum"},"id":"schema_724"},"schema_725":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ConsentCategoryId"},"id":"schema_725"},"schema_726":{"kind":"json-schema","data":{"type":"string","example":"My notes for this Consent Category."},"id":"schema_726"},"schema_727":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataSourceItemTypeCap"},"id":"schema_727"},"schema_728":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CustomHeaderSortByEnum"},"id":"schema_728"},"schema_729":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataSourceSortByEnum"},"id":"schema_729"},"schema_730":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataSourceItemType"},"id":"schema_730"},"schema_731":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_731"},"schema_732":{"kind":"json-schema","data":{"type":"object","properties":{"itemName":{"type":"string","description":"filter the items by a given name"},"labelIds":{"type":"array","items":{"type":"integer"},"description":"filter the items by label ids"},"itemIds":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter the items by IDs (itemName & labelIds are ignored)"},"children":[]}]}]}]},"itemType":{"$ref":"#/components/schemas/DataSourceItemType"},"withRuns":{"type":"boolean","description":"If true - response includes only data sources with at least one run. If false - only those without runs. All if not set."}}},"id":"schema_732"},"schema_733":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataSourceTargetItemSortByEnum"},"id":"schema_733"},"schema_734":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/GeoLocationCountryDTO"}},"id":"schema_734"},"schema_735":{"kind":"json-schema","data":{"$ref":"#/components/schemas/NotificationCenter_AssignmentItemTypeEnum"},"id":"schema_735"},"schema_736":{"kind":"json-schema","data":{"$ref":"#/components/schemas/NotificationCenter_AssignmentsSortColumn"},"id":"schema_736"},"schema_737":{"kind":"json-schema","data":{"type":"integer","example":123},"id":"schema_737"},"schema_738":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/RemoteFileMapping"}},"id":"schema_738"},"schema_739":{"kind":"json-schema","data":{"type":"integer","format":"int64","example":123},"id":"schema_739"},"schema_740":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RuleLibrary_SortColumn"},"id":"schema_740"},"schema_741":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SchedulePreset"}},"id":"schema_741"},"schema_742":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ISO8601LocalDateTime"},"id":"schema_742"},"schema_743":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledItem"}},"id":"schema_743"},"schema_744":{"kind":"json-schema","data":{"type":"integer","maximum":1000,"default":10,"minimum":10},"id":"schema_744"},"schema_745":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SiteCensusSortByEnum"},"id":"schema_745"},"schema_746":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CensusId"},"id":"schema_746"},"schema_747":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SiteCensusResultsSortByEnum"},"id":"schema_747"},"schema_748":{"kind":"json-schema","data":{"type":"integer","maximum":10000,"default":100,"minimum":1},"id":"schema_748"},"schema_749":{"kind":"json-schema","data":{"type":"integer","minimum":0,"maximum":100,"default":50},"id":"schema_749"},"schema_750":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SiteCensusUrlFolderSortByEnum"},"id":"schema_750"},"schema_751":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SiteCensusFolderUrlSortByEnum"},"id":"schema_751"},"schema_752":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SiteCensusSearchParam"},"id":"schema_752"},"schema_753":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UserEventTypeApi"},"id":"schema_753"},"schema_754":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UserEventItemTypeApi"},"id":"schema_754"},"schema_755":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2021-06-01T01:30:00.000-05:00"},"id":"schema_755"},"schema_756":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UserEventSortByEnum"},"id":"schema_756"},"schema_757":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_757"},"schema_758":{"kind":"json-schema","data":{"type":"integer","example":456},"id":"schema_758"},"schema_759":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WebJourneyDTO"}},"id":"schema_759"},"schema_760":{"kind":"json-schema","data":{"type":"integer","format":"int64","example":1001},"id":"schema_760"},"schema_761":{"kind":"json-schema","data":{"type":"integer","format":"int64","example":12345},"id":"schema_761"},"schema_762":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"},"example":[101,102,103]},"id":"schema_762"},"schema_763":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int64"},"example":[201,202,203]},"id":"schema_763"},"schema_764":{"kind":"json-schema","data":{"type":"integer","format":"int64","example":1},"id":"schema_764"},"schema_765":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WebJourneyActionRequestResponse"}},"id":"schema_765"},"schema_766":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ConsoleLogDto"}},"id":"schema_766"},"schema_767":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"}}},"id":"schema_767"}},"exampleStore":{"paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/401/content/application~1json/example":{"value":{"message":"Unauthorized"},"id":"paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/401/content/application~1json/example"},"paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/409/content/application~1json/example":{"value":{"currentRunId":5765431,"code":33},"id":"paths/~1v3~1web-journeys~1{webJourneyId}~1runs/post/responses/409/content/application~1json/example"}},"securitySchemeStore":{"API_Key":{"id":"API_Key","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: abc123...def456"},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"https://api.observepoint.com","description":"ObservePoint Production API"}]},"options":{"hideSchemaTitles":true,"corsProxyUrl":"","hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/combined.openapi.json?download"},{"url":"/_bundle/openapi/combined.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"V3 API","description":"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."}},"baseSlug":"/openapi/combined.openapi","routesMapping":{}}