{"items":[{"type":"link","label":"V2 API","link":"/openapi/scala-api.openapi","routeSlug":"/openapi/scala-api.openapi","content":{"contentType":"overview","meta":{"name":"V2 API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"SCALA-API.openapi.json","url":"/_bundle/openapi/SCALA-API.openapi.json?download"},{"kind":"download","label":"SCALA-API.openapi.yaml","url":"/_bundle/openapi/SCALA-API.openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"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/v2"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"V2 API","showPageActions":true}],"sectionId":"/openapi/scala-api.openapi"}]}]}},{"type":"group","label":"Account","link":"/openapi/scala-api.openapi/account","routeSlug":"/openapi/scala-api.openapi/account","items":[{"label":"Returns account for current user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/account/getaccount","routeSlug":"/openapi/scala-api.openapi/account/getaccount","metadata":{"seo":{"title":"Returns account for current user","description":"GET /v2/account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccount","name":"Returns account for current user","isWebhook":false,"pointer":"/paths/~1account/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns account for current user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/account","href":"account/getaccount","openApiOperationId":"getAccount","summary":"Returns account for current user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Account"}},"schemaId":"components/schemas/Account"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1account/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Account","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccount"}],"panels":[]}]},"httpPath":"/account"}],"content":{"contentType":"group","meta":{"name":"Account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing account settings, configurations, and account-level information"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account","summary":"Returns account for current user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Rules","link":"/openapi/scala-api.openapi/rules","routeSlug":"/openapi/scala-api.openapi/rules","items":[{"label":"Create new rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/createrule","routeSlug":"/openapi/scala-api.openapi/rules/createrule","metadata":{"seo":{"title":"Create new rule","description":"POST /v2/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRule","name":"Create new rule","isWebhook":false,"pointer":"/paths/~1rules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new 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":" /v2/rules"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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/NewRule"}},"schemaId":"components/schemas/NewRule","pointer":"/paths/~1rules/post/requestBody","description":"Rule create information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rules","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NewRule"}},"responseCodes":["201","403","409"],"pointer":"/rules","href":"rules/createrule","openApiOperationId":"createRule","summary":"Create new rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/NewRule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewRule"}},"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/Rule"}},"schemaId":"components/schemas/Rule"},{"code":"403","description":"Current user has read-only permissions or doesn't have access to this rule"},{"code":"409","description":"Rule name is not unique"}],"pointer":"/paths/~1rules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Rule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Rule"}}},{"code":"403"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/createrule"}],"panels":[]}]},"httpPath":"/rules"},{"label":"Get list of rule preview objects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/getrulepreviews","routeSlug":"/openapi/scala-api.openapi/rules/getrulepreviews","metadata":{"seo":{"title":"Get list of rule preview objects","description":"GET /v2/rules/previews"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRulePreviews","name":"Get list of rule preview objects","isWebhook":false,"pointer":"/paths/~1rules~1previews/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of rule preview objects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/rules/previews"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":"/rules/previews","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/rules/previews","href":"rules/getrulepreviews","openApiOperationId":"getRulePreviews","summary":"Get list of rule preview objects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_567"}},"schemaId":"schema_567"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1rules~1previews/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_567","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_567"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getrulepreviews"}],"panels":[]}]},"httpPath":"/rules/previews"},{"label":"Get original rule page filter id by given rule page filter snapshot id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/getoriginalrulepagefilteridfromsnapshot","routeSlug":"/openapi/scala-api.openapi/rules/getoriginalrulepagefilteridfromsnapshot","metadata":{"seo":{"title":"Get original rule page filter id by given rule page filter snapshot id","description":"GET /v2/rules/snapshots/page-filters/{pageFilterSnapshotId}/original"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOriginalRulePageFilterIdFromSnapshot","name":"Get original rule page filter id by given rule page filter snapshot id","isWebhook":false,"pointer":"/paths/~1rules~1snapshots~1page-filters~1{pageFilterSnapshotId}~1original/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get original rule page filter id by given rule page filter snapshot 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":" /v2/rules/snapshots/page-filters/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{pageFilterSnapshotId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/original"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"pageFilterSnapshotId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1rules~1snapshots~1page-filters~1{pageFilterSnapshotId}~1original/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"schemaId":"components/schemas/UserContext","pointer":"/paths/~1rules~1snapshots~1page-filters~1{pageFilterSnapshotId}~1original/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/snapshots/page-filters/{pageFilterSnapshotId}/original","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"pageFilterSnapshotId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserContext"}},"responseCodes":["200","404"],"pointer":"/rules/snapshots/page-filters/{pageFilterSnapshotId}/original","href":"rules/getoriginalrulepagefilteridfromsnapshot","openApiOperationId":"getOriginalRulePageFilterIdFromSnapshot","summary":"Get original rule page filter id by given rule page filter snapshot id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/UserContext","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"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/Rule"}},"schemaId":"components/schemas/Rule"},{"code":"404","description":"Rule by given id not found"}],"pointer":"/paths/~1rules~1snapshots~1page-filters~1{pageFilterSnapshotId}~1original/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Rule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Rule"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getoriginalrulepagefilteridfromsnapshot"}],"panels":[]}]},"httpPath":"/rules/snapshots/page-filters/{pageFilterSnapshotId}/original"},{"label":"Get original rule tag variable id by given rule tag variable snapshot id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/getoriginalruletagvariableidfromsnapshot","routeSlug":"/openapi/scala-api.openapi/rules/getoriginalruletagvariableidfromsnapshot","metadata":{"seo":{"title":"Get original rule tag variable id by given rule tag variable snapshot id","description":"GET /v2/rules/snapshots/tags/variables/{tagVariableSnapshotId}/original"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOriginalRuleTagVariableIdFromSnapshot","name":"Get original rule tag variable id by given rule tag variable snapshot id","isWebhook":false,"pointer":"/paths/~1rules~1snapshots~1tags~1variables~1{tagVariableSnapshotId}~1original/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get original rule tag variable id by given rule tag variable snapshot 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":" /v2/rules/snapshots/tags/variables/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{tagVariableSnapshotId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/original"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"tagVariableSnapshotId","in":"path","schemaId":"schema_569","required":true}],"pointer":"/paths/~1rules~1snapshots~1tags~1variables~1{tagVariableSnapshotId}~1original/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"schemaId":"components/schemas/UserContext","pointer":"/paths/~1rules~1snapshots~1tags~1variables~1{tagVariableSnapshotId}~1original/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/snapshots/tags/variables/{tagVariableSnapshotId}/original","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"tagVariableSnapshotId","in":"path","required":true,"schemaId":"schema_569"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserContext"}},"responseCodes":["200","404"],"pointer":"/rules/snapshots/tags/variables/{tagVariableSnapshotId}/original","href":"rules/getoriginalruletagvariableidfromsnapshot","openApiOperationId":"getOriginalRuleTagVariableIdFromSnapshot","summary":"Get original rule tag variable id by given rule tag variable snapshot id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/UserContext","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"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/Rule"}},"schemaId":"components/schemas/Rule"},{"code":"404","description":"Rule by given id not found"}],"pointer":"/paths/~1rules~1snapshots~1tags~1variables~1{tagVariableSnapshotId}~1original/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Rule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Rule"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getoriginalruletagvariableidfromsnapshot"}],"panels":[]}]},"httpPath":"/rules/snapshots/tags/variables/{tagVariableSnapshotId}/original"},{"label":"Get original rule tag id by given rule tag snapshot id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/getoriginalruletagidfromsnapshot","routeSlug":"/openapi/scala-api.openapi/rules/getoriginalruletagidfromsnapshot","metadata":{"seo":{"title":"Get original rule tag id by given rule tag snapshot id","description":"GET /v2/rules/snapshots/tags/{tagSnapshotId}/original"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOriginalRuleTagIdFromSnapshot","name":"Get original rule tag id by given rule tag snapshot id","isWebhook":false,"pointer":"/paths/~1rules~1snapshots~1tags~1{tagSnapshotId}~1original/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get original rule tag id by given rule tag snapshot 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":" /v2/rules/snapshots/tags/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{tagSnapshotId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/original"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"tagSnapshotId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1rules~1snapshots~1tags~1{tagSnapshotId}~1original/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"schemaId":"components/schemas/UserContext","pointer":"/paths/~1rules~1snapshots~1tags~1{tagSnapshotId}~1original/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/snapshots/tags/{tagSnapshotId}/original","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"tagSnapshotId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserContext"}},"responseCodes":["200","404"],"pointer":"/rules/snapshots/tags/{tagSnapshotId}/original","href":"rules/getoriginalruletagidfromsnapshot","openApiOperationId":"getOriginalRuleTagIdFromSnapshot","summary":"Get original rule tag id by given rule tag snapshot id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/UserContext","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"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/Rule"}},"schemaId":"components/schemas/Rule"},{"code":"404","description":"Rule by given id not found"}],"pointer":"/paths/~1rules~1snapshots~1tags~1{tagSnapshotId}~1original/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Rule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Rule"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getoriginalruletagidfromsnapshot"}],"panels":[]}]},"httpPath":"/rules/snapshots/tags/{tagSnapshotId}/original"},{"label":"Get original rule id by given rule snapshot id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/getoriginalruleidfromsnapshot","routeSlug":"/openapi/scala-api.openapi/rules/getoriginalruleidfromsnapshot","metadata":{"seo":{"title":"Get original rule id by given rule snapshot id","description":"GET /v2/rules/snapshots/{ruleSnapshotId}/original"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOriginalRuleIdFromSnapshot","name":"Get original rule id by given rule snapshot id","isWebhook":false,"pointer":"/paths/~1rules~1snapshots~1{ruleSnapshotId}~1original/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get original rule id by given rule snapshot 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":" /v2/rules/snapshots/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ruleSnapshotId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/original"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"ruleSnapshotId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1rules~1snapshots~1{ruleSnapshotId}~1original/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"schemaId":"components/schemas/UserContext","pointer":"/paths/~1rules~1snapshots~1{ruleSnapshotId}~1original/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/snapshots/{ruleSnapshotId}/original","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"ruleSnapshotId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserContext"}},"responseCodes":["200","404"],"pointer":"/rules/snapshots/{ruleSnapshotId}/original","href":"rules/getoriginalruleidfromsnapshot","openApiOperationId":"getOriginalRuleIdFromSnapshot","summary":"Get original rule id by given rule snapshot id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/UserContext","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"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/Rule"}},"schemaId":"components/schemas/Rule"},{"code":"404","description":"Rule by given id not found"}],"pointer":"/paths/~1rules~1snapshots~1{ruleSnapshotId}~1original/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Rule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Rule"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getoriginalruleidfromsnapshot"}],"panels":[]}]},"httpPath":"/rules/snapshots/{ruleSnapshotId}/original"},{"label":"Get rule by given id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/getrule","routeSlug":"/openapi/scala-api.openapi/rules/getrule","metadata":{"seo":{"title":"Get rule by given id","description":"GET /v2/rules/{ruleId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRule","name":"Get rule by given id","isWebhook":false,"pointer":"/paths/~1rules~1{ruleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rule by given 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":" /v2/rules/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ruleId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"ruleId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1rules~1{ruleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/{ruleId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"ruleId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/rules/{ruleId}","href":"rules/getrule","openApiOperationId":"getRule","summary":"Get rule by given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Rule"}},"schemaId":"components/schemas/Rule"},{"code":"404","description":"Rule by given id not found"}],"pointer":"/paths/~1rules~1{ruleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Rule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Rule"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getrule"}],"panels":[]}]},"httpPath":"/rules/{ruleId}"},{"label":"Update rule with given id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/updaterule","routeSlug":"/openapi/scala-api.openapi/rules/updaterule","metadata":{"seo":{"title":"Update rule with given id","description":"PUT /v2/rules/{ruleId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRule","name":"Update rule with given id","isWebhook":false,"pointer":"/paths/~1rules~1{ruleId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update rule with given 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-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/rules/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ruleId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"ruleId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1rules~1{ruleId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRule"}},"schemaId":"components/schemas/UpdateRule","pointer":"/paths/~1rules~1{ruleId}/put/requestBody","description":"Rule update information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rules/{ruleId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"ruleId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateRule"}},"responseCodes":["200","404","409"],"pointer":"/rules/{ruleId}","href":"rules/updaterule","openApiOperationId":"updateRule","summary":"Update rule with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/UpdateRule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRule"}},"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/Rule"}},"schemaId":"components/schemas/Rule"},{"code":"404","description":"Rule by given id not found"},{"code":"409","description":"Rule name is not unique"}],"pointer":"/paths/~1rules~1{ruleId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Rule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Rule"}}},{"code":"404"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/updaterule"}],"panels":[]}]},"httpPath":"/rules/{ruleId}"},{"label":"Delete rule with given id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/deleterule","routeSlug":"/openapi/scala-api.openapi/rules/deleterule","metadata":{"seo":{"title":"Delete rule with given id","description":"DELETE /v2/rules/{ruleId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRule","name":"Delete rule with given id","isWebhook":false,"pointer":"/paths/~1rules~1{ruleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete rule with given 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":" /v2/rules/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ruleId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"ruleId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1rules~1{ruleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rules/{ruleId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"ruleId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","403","404"],"pointer":"/rules/{ruleId}","href":"rules/deleterule","openApiOperationId":"deleteRule","summary":"Delete rule with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Rule was successfully deleted"},{"code":"403","description":"Current user has read-only permissions or doesn't have access to this rule"},{"code":"404","description":"Rule by given id not found"}],"pointer":"/paths/~1rules~1{ruleId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/deleterule"}],"panels":[]}]},"httpPath":"/rules/{ruleId}"},{"label":"Get all web journeys with given rule id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/rules/getallwebjourneysbyrule","routeSlug":"/openapi/scala-api.openapi/rules/getallwebjourneysbyrule","metadata":{"seo":{"title":"Get all web journeys with given rule id","description":"GET /v2/rules/{ruleId}/web-journeys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllWebJourneysByRule","name":"Get all web journeys with given rule id","isWebhook":false,"pointer":"/paths/~1rules~1{ruleId}~1web-journeys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all web journeys with given rule 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":" /v2/rules/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ruleId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/web-journeys"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"ruleId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1rules~1{ruleId}~1web-journeys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/{ruleId}/web-journeys","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"ruleId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/rules/{ruleId}/web-journeys","href":"rules/getallwebjourneysbyrule","openApiOperationId":"getAllWebJourneysByRule","summary":"Get all web journeys with given rule id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_570"}},"schemaId":"schema_570"},{"code":"403","description":"Current user has read-only permissions or doesn't have access to this rule"},{"code":"404","description":"Rule by given id not found"}],"pointer":"/paths/~1rules~1{ruleId}~1web-journeys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_570","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_570"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getallwebjourneysbyrule"}],"panels":[]}]},"httpPath":"/rules/{ruleId}/web-journeys"}],"content":{"contentType":"group","meta":{"name":"Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rules","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing rules including creation, configuration, assignment, and rule-based validation logic"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rules","summary":"Create new rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rules/createrule","deprecated":false},{"title":"/rules/previews","summary":"Get list of rule preview objects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rules/getrulepreviews","deprecated":false},{"title":"/rules/snapshots/page-filters/{pageFilterSnapshotId}/original","summary":"Get original rule page filter id by given rule page filter snapshot id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rules/getoriginalrulepagefilteridfromsnapshot","deprecated":false},{"title":"/rules/snapshots/tags/variables/{tagVariableSnapshotId}/original","summary":"Get original rule tag variable id by given rule tag variable snapshot id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rules/getoriginalruletagvariableidfromsnapshot","deprecated":false},{"title":"/rules/snapshots/tags/{tagSnapshotId}/original","summary":"Get original rule tag id by given rule tag snapshot id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rules/getoriginalruletagidfromsnapshot","deprecated":false},{"title":"/rules/snapshots/{ruleSnapshotId}/original","summary":"Get original rule id by given rule snapshot id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rules/getoriginalruleidfromsnapshot","deprecated":false},{"title":"/rules/{ruleId}","summary":"Get rule by given id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rules/getrule","deprecated":false},{"title":"/rules/{ruleId}","summary":"Update rule with given id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rules/updaterule","deprecated":false},{"title":"/rules/{ruleId}","summary":"Delete rule with given id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rules/deleterule","deprecated":false},{"title":"/rules/{ruleId}/web-journeys","summary":"Get all web journeys with given rule id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rules/getallwebjourneysbyrule","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/openapi/scala-api.openapi/tags","routeSlug":"/openapi/scala-api.openapi/tags","items":[{"label":"Returns all tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/tags/getalltags","routeSlug":"/openapi/scala-api.openapi/tags/getalltags","metadata":{"seo":{"title":"Returns all tags","description":"GET /v2/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllTags","name":"Returns all tags","isWebhook":false,"pointer":"/paths/~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns all tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/tags","href":"tags/getalltags","openApiOperationId":"getAllTags","summary":"Returns all tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_571"}},"schemaId":"schema_571"}],"pointer":"/paths/~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_571","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/getalltags"}],"panels":[]}]},"httpPath":"/tags"},{"label":"Return tag by tagId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/tags/gettag","routeSlug":"/openapi/scala-api.openapi/tags/gettag","metadata":{"seo":{"title":"Return tag by tagId","description":"GET /v2/tags/{tagId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTag","name":"Return tag by tagId","isWebhook":false,"pointer":"/paths/~1tags~1{tagId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return tag by tagId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"tagId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1tags~1{tagId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags/{tagId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"tagId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/tags/{tagId}","href":"tags/gettag","openApiOperationId":"getTag","summary":"Return tag by tagId"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Tag"}},"schemaId":"components/schemas/Tag"},{"code":"403","description":"User doesn't have permissions to get tag by given tagId"},{"code":"404","description":"Not found tag by given tagId"}],"pointer":"/paths/~1tags~1{tagId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Tag","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/gettag"}],"panels":[]}]},"httpPath":"/tags/{tagId}"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing tags and tag-related operations including tag metadata and configuration"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tags","summary":"Returns all tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/getalltags","deprecated":false},{"title":"/tags/{tagId}","summary":"Return tag by tagId","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/gettag","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/openapi/scala-api.openapi/users","routeSlug":"/openapi/scala-api.openapi/users","items":[{"label":"Return all users for current user account.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/users/getusers","routeSlug":"/openapi/scala-api.openapi/users/getusers","metadata":{"seo":{"title":"Return all users for current user account.","description":"GET /v2/users"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUsers","name":"Return all users for current user account.","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return all users for current user 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":" /v2/users"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"withDeleted","in":"query","schemaId":"schema_572","description":"Include deleted users"}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[{"name":"withDeleted","in":"query","required":false,"schemaId":"schema_572"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/users","href":"users/getusers","openApiOperationId":"getUsers","summary":"Return all users for current user account."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_573"}},"schemaId":"schema_573"},{"code":"403","description":"Not Admin User"}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_573","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_573"}}},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getusers"}],"panels":[]}]},"httpPath":"/users"},{"label":"Return user data by given id. Accessible only for admin users or if {userId} equal to current user id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/users/getuser","routeSlug":"/openapi/scala-api.openapi/users/getuser","metadata":{"seo":{"title":"Return user data by given id. Accessible only for admin users or if {userId} equal to current user id","description":"GET /v2/users/{userId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Return user data by given id. Accessible only for admin users or if {userId} equal to current user id","isWebhook":false,"pointer":"/paths/~1users~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return user data by given id. Accessible only for admin users or if {userId} equal to current user 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":" /v2/users/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{userId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"userId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1users~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{userId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/users/{userId}","href":"users/getuser","openApiOperationId":"getUser","summary":"Return user data by given id. Accessible only for admin users or if {userId} equal to current user id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/User"}},"schemaId":"components/schemas/User"},{"code":"403","description":"Not Admin user or id parameter is not equal to current user id"},{"code":"404","description":"Not found user by given id"}],"pointer":"/paths/~1users~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuser"}],"panels":[]}]},"httpPath":"/users/{userId}"},{"label":"Update user data by given userId.Accessible only for admin users or if {userId} equal to current user id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/users/updateuser","routeSlug":"/openapi/scala-api.openapi/users/updateuser","metadata":{"seo":{"title":"Update user data by given userId.Accessible only for admin users or if {userId} equal to current user id","description":"PUT /v2/users/{userId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUser","name":"Update user data by given userId.Accessible only for admin users or if {userId} equal to current user id","isWebhook":false,"pointer":"/paths/~1users~1{userId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user data by given userId.Accessible only for admin users or if {userId} equal to current user 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-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/users/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{userId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"userId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1users~1{userId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserDocument"}},"schemaId":"components/schemas/UserDocument","pointer":"/paths/~1users~1{userId}/put/requestBody","description":"Updated user data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{userId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserDocument"}},"responseCodes":["200","403","404"],"pointer":"/users/{userId}","href":"users/updateuser","openApiOperationId":"updateUser","summary":"Update user data by given userId.Accessible only for admin users or if {userId} equal to current user id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/UserDocument","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserDocument"}},"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/User"}},"schemaId":"components/schemas/User"},{"code":"403","description":"Not Admin user or id parameter is not equal to current user id"},{"code":"404","description":"Not found user by given id"}],"pointer":"/paths/~1users~1{userId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updateuser"}],"panels":[]}]},"httpPath":"/users/{userId}"},{"label":"Delete user by given id. Accessible only for admin users","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/users/deleteuser","routeSlug":"/openapi/scala-api.openapi/users/deleteuser","metadata":{"seo":{"title":"Delete user by given id. Accessible only for admin users","description":"DELETE /v2/users/{userId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Delete user by given id. Accessible only for admin users","isWebhook":false,"pointer":"/paths/~1users~1{userId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete user by given id. Accessible only for admin users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/users/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{userId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"userId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1users~1{userId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/users/{userId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","403","404"],"pointer":"/users/{userId}","href":"users/deleteuser","openApiOperationId":"deleteUser","summary":"Delete user by given id. Accessible only for admin users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"403","description":"Not Admin user or id parameter is not equal to current user id"},{"code":"404","description":"Not found user by given id"}],"pointer":"/paths/~1users~1{userId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteuser"}],"panels":[]}]},"httpPath":"/users/{userId}"},{"label":"Return folders list shared with user by given id. Accessible only for admin users or if {userId} equal to current user id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/users/getuserfolders","routeSlug":"/openapi/scala-api.openapi/users/getuserfolders","metadata":{"seo":{"title":"Return folders list shared with user by given id. Accessible only for admin users or if {userId} equal to current user id","description":"GET /v2/users/{userId}/folders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserFolders","name":"Return folders list shared with user by given id. Accessible only for admin users or if {userId} equal to current user id","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1folders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return folders list shared with user by given id. Accessible only for admin users or if {userId} equal to current user 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":" /v2/users/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{userId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/folders"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"userId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1users~1{userId}~1folders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{userId}/folders","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/users/{userId}/folders","href":"users/getuserfolders","openApiOperationId":"getUserFolders","summary":"Return folders list shared with user by given id. Accessible only for admin users or if {userId} equal to current user id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_574"}},"schemaId":"schema_574"},{"code":"403","description":"Not Admin user or id parameter is not equal to current user id"},{"code":"404","description":"Not found user by given id"}],"pointer":"/paths/~1users~1{userId}~1folders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_574","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuserfolders"}],"panels":[]}]},"httpPath":"/users/{userId}/folders"},{"label":"Add given folders as shared for user with given userId.Accessible only for admin users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/users/adduserfolders","routeSlug":"/openapi/scala-api.openapi/users/adduserfolders","metadata":{"seo":{"title":"Add given folders as shared for user with given userId.Accessible only for admin users","description":"POST /v2/users/{userId}/folders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addUserFolders","name":"Add given folders as shared for user with given userId.Accessible only for admin users","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1folders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add given folders as shared for user with given userId.Accessible only for admin users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/users/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{userId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/folders"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"userId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1users~1{userId}~1folders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575","pointer":"/paths/~1users~1{userId}~1folders/post/requestBody","description":"Folders id list"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{userId}/folders","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_575"}},"responseCodes":["200","403","404","422"],"pointer":"/users/{userId}/folders","href":"users/adduserfolders","openApiOperationId":"addUserFolders","summary":"Add given folders as shared for user with given userId.Accessible only for admin users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"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_574"}},"schemaId":"schema_574"},{"code":"403","description":"Not Admin User"},{"code":"404","description":"Not found user by given id"},{"code":"422","description":"Some of provided folder id's is not found"}],"pointer":"/paths/~1users~1{userId}~1folders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_574","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}}},{"code":"403"},{"code":"404"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/adduserfolders"}],"panels":[]}]},"httpPath":"/users/{userId}/folders"},{"label":"Set given folders as shared for user with given userId. Accessible only for admin users","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/users/setuserfolders","routeSlug":"/openapi/scala-api.openapi/users/setuserfolders","metadata":{"seo":{"title":"Set given folders as shared for user with given userId. Accessible only for admin users","description":"PUT /v2/users/{userId}/folders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setUserFolders","name":"Set given folders as shared for user with given userId. Accessible only for admin users","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1folders/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set given folders as shared for user with given userId. Accessible only for admin users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/users/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{userId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/folders"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"userId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1users~1{userId}~1folders/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575","pointer":"/paths/~1users~1{userId}~1folders/put/requestBody","description":"Folders id list"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{userId}/folders","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_575"}},"responseCodes":["200","403","404","422"],"pointer":"/users/{userId}/folders","href":"users/setuserfolders","openApiOperationId":"setUserFolders","summary":"Set given folders as shared for user with given userId. Accessible only for admin users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"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_574"}},"schemaId":"schema_574"},{"code":"403","description":"Not Admin User"},{"code":"404","description":"Not found user by given id"},{"code":"422","description":"Some of provided folder id's is not found"}],"pointer":"/paths/~1users~1{userId}~1folders/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_574","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}}},{"code":"403"},{"code":"404"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/setuserfolders"}],"panels":[]}]},"httpPath":"/users/{userId}/folders"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing users including creation, authentication, permissions, and user account management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"Return all users for current user account.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getusers","deprecated":false},{"title":"/users/{userId}","summary":"Return user data by given id. Accessible only for admin users or if {userId} equal to current user id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuser","deprecated":false},{"title":"/users/{userId}","summary":"Update user data by given userId.Accessible only for admin users or if {userId} equal to current user id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/updateuser","deprecated":false},{"title":"/users/{userId}","summary":"Delete user by given id. Accessible only for admin users","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/deleteuser","deprecated":false},{"title":"/users/{userId}/folders","summary":"Return folders list shared with user by given id. Accessible only for admin users or if {userId} equal to current user id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuserfolders","deprecated":false},{"title":"/users/{userId}/folders","summary":"Add given folders as shared for user with given userId.Accessible only for admin users","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/adduserfolders","deprecated":false},{"title":"/users/{userId}/folders","summary":"Set given folders as shared for user with given userId. Accessible only for admin users","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/setuserfolders","deprecated":false}]}]}]}]}},{"type":"group","label":"Manual Journeys","link":"/openapi/scala-api.openapi/manual-journeys","routeSlug":"/openapi/scala-api.openapi/manual-journeys","items":[{"label":"Get all manual journeys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/alljourneys","routeSlug":"/openapi/scala-api.openapi/manual-journeys/alljourneys","metadata":{"seo":{"title":"Get all manual journeys","description":"GET /v2/manual-journeys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"allJourneys","name":"Get all manual journeys","isWebhook":false,"pointer":"/paths/~1manual-journeys/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all manual 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":" /v2/manual-journeys"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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/SeqObject"}},"schemaId":"components/schemas/SeqObject","pointer":"/paths/~1manual-journeys/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"responseCodes":["200","401"],"pointer":"/manual-journeys","href":"manual-journeys/alljourneys","openApiOperationId":"allJourneys","summary":"Get all manual journeys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/SeqObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"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_576"}},"schemaId":"schema_576"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1manual-journeys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_576","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_576"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/alljourneys"}],"panels":[]}]},"httpPath":"/manual-journeys"},{"label":"Create new manual journey","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/createjourney","routeSlug":"/openapi/scala-api.openapi/manual-journeys/createjourney","metadata":{"seo":{"title":"Create new manual journey","description":"POST /v2/manual-journeys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createJourney","name":"Create new manual journey","isWebhook":false,"pointer":"/paths/~1manual-journeys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new manual 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":" /v2/manual-journeys"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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/JourneyRequest"}},"schemaId":"components/schemas/JourneyRequest","pointer":"/paths/~1manual-journeys/post/requestBody","description":"New manual journey info"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/manual-journeys","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JourneyRequest"}},"responseCodes":["201","401"],"pointer":"/manual-journeys","href":"manual-journeys/createjourney","openApiOperationId":"createJourney","summary":"Create new manual journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/JourneyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JourneyRequest"}},"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/Journey"}},"schemaId":"components/schemas/Journey"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1manual-journeys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Journey","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Journey"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/createjourney"}],"panels":[]}]},"httpPath":"/manual-journeys"},{"label":"Get default certificate metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/observepoint$api$manualjourney$manualjourneyroute$$getdefaultcertificate","routeSlug":"/openapi/scala-api.openapi/manual-journeys/observepoint$api$manualjourney$manualjourneyroute$$getdefaultcertificate","metadata":{"seo":{"title":"Get default certificate metadata","description":"GET /v2/manual-journeys/certificates/default"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"observepoint$api$manualjourney$ManualJourneyRoute$$getDefaultCertificate","name":"Get default certificate metadata","isWebhook":false,"pointer":"/paths/~1manual-journeys~1certificates~1default/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get default certificate metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/manual-journeys/certificates/default"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":"/manual-journeys/certificates/default","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/manual-journeys/certificates/default","href":"manual-journeys/observepoint$api$manualjourney$manualjourneyroute$$getdefaultcertificate","openApiOperationId":"observepoint$api$manualjourney$ManualJourneyRoute$$getDefaultCertificate","summary":"Get default certificate metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Certificate"}},"schemaId":"components/schemas/Certificate"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1manual-journeys~1certificates~1default/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Certificate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Certificate"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/observepoint$api$manualjourney$manualjourneyroute$$getdefaultcertificate"}],"panels":[]}]},"httpPath":"/manual-journeys/certificates/default"},{"label":"Get manual journey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/journey","routeSlug":"/openapi/scala-api.openapi/manual-journeys/journey","metadata":{"seo":{"title":"Get manual journey","description":"GET /v2/manual-journeys/{manualJourneyId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"journey","name":"Get manual journey","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get manual 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":" /v2/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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}","href":"manual-journeys/journey","openApiOperationId":"journey","summary":"Get manual journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Journey"}},"schemaId":"components/schemas/Journey"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Journey","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Journey"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/journey"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}"},{"label":"Initialize manual journey run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/initialize","routeSlug":"/openapi/scala-api.openapi/manual-journeys/initialize","metadata":{"seo":{"title":"Initialize manual journey run","description":"POST /v2/manual-journeys/{manualJourneyId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initialize","name":"Initialize manual journey run","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initialize 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":" /v2/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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/manual-journeys/{manualJourneyId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}","href":"manual-journeys/initialize","openApiOperationId":"initialize","summary":"Initialize manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/InitializedJourney"}},"schemaId":"components/schemas/InitializedJourney"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InitializedJourney","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InitializedJourney"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/initialize"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}"},{"label":"Update manual journey","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/updatejourney","routeSlug":"/openapi/scala-api.openapi/manual-journeys/updatejourney","metadata":{"seo":{"title":"Update manual journey","description":"PUT /v2/manual-journeys/{manualJourneyId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateJourney","name":"Update manual journey","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update manual 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":" /v2/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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JourneyRequest"}},"schemaId":"components/schemas/JourneyRequest","pointer":"/paths/~1manual-journeys~1{manualJourneyId}/put/requestBody","description":"Update manual journey info"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/manual-journeys/{manualJourneyId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JourneyRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/manual-journeys/{manualJourneyId}","href":"manual-journeys/updatejourney","openApiOperationId":"updateJourney","summary":"Update manual journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/JourneyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JourneyRequest"}},"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/Journey"}},"schemaId":"components/schemas/Journey"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"},{"code":"422","description":"Supplied entity didn't pass a validation"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Journey","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Journey"}}},{"code":"401"},{"code":"404"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/updatejourney"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}"},{"label":"Delete manual journey","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/deletejourney","routeSlug":"/openapi/scala-api.openapi/manual-journeys/deletejourney","metadata":{"seo":{"title":"Delete manual journey","description":"DELETE /v2/manual-journeys/{manualJourneyId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteJourney","name":"Delete manual journey","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete manual 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":" /v2/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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See also POST /v2/manual-journeys/{manualJourneyId}/delete for an equivalent endpoint that supports browser sendBeacon() calls."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/manual-journeys/{manualJourneyId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","404","423"],"pointer":"/manual-journeys/{manualJourneyId}","href":"manual-journeys/deletejourney","openApiOperationId":"deleteJourney","summary":"Delete manual journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"},{"code":"423","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This item has active run. Please stop & discard active run first"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemIsRunningApiError"}},"schemaId":"components/schemas/ItemIsRunningApiError"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"404"},{"code":"423","schemaId":"components/schemas/ItemIsRunningApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemIsRunningApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/deletejourney"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}"},{"label":"Delete manual journey via POST request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/deletejourneyviapost","routeSlug":"/openapi/scala-api.openapi/manual-journeys/deletejourneyviapost","metadata":{"seo":{"title":"Delete manual journey via POST request","description":"POST /v2/manual-journeys/{manualJourneyId}/delete"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteJourneyViaPost","name":"Delete manual journey via POST request","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1delete/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete manual journey via POST request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/delete"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint provides the same functionality as DELETE /v2/manual-journeys/{manualJourneyId}. It exists to support browser sendBeacon() calls, which can only perform POST requests. This is used when users abruptly leave the live-connect page to ensure proper cleanup of the live-connect session (including stopping any ECS tasks associated with the run and removing the run from the database)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1delete/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/manual-journeys/{manualJourneyId}/delete","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","404","423"],"pointer":"/manual-journeys/{manualJourneyId}/delete","href":"manual-journeys/deletejourneyviapost","openApiOperationId":"deleteJourneyViaPost","summary":"Delete manual journey via POST request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"},{"code":"423","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This item has active run. Please stop & discard active run first"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemIsRunningApiError"}},"schemaId":"components/schemas/ItemIsRunningApiError"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"404"},{"code":"423","schemaId":"components/schemas/ItemIsRunningApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemIsRunningApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/deletejourneyviapost"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/delete"},{"label":"Create a manual journey run within the manualJourneyId based on uploaded har files.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/createharrun","routeSlug":"/openapi/scala-api.openapi/manual-journeys/createharrun","metadata":{"seo":{"title":"Create a manual journey run within the manualJourneyId based on uploaded har files.","description":"POST /v2/manual-journeys/{manualJourneyId}/har-runs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createHarRun","name":"Create a manual journey run within the manualJourneyId based on uploaded har files.","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1har-runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a manual journey run within the manualJourneyId based on uploaded har files.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/har-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":"manualJourneyId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1har-runs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HarJourneyRunCreateRequest"}},"schemaId":"components/schemas/HarJourneyRunCreateRequest","pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1har-runs/post/requestBody","description":"New har manual journey request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/manual-journeys/{manualJourneyId}/har-runs","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HarJourneyRunCreateRequest"}},"responseCodes":["200","401"],"pointer":"/manual-journeys/{manualJourneyId}/har-runs","href":"manual-journeys/createharrun","openApiOperationId":"createHarRun","summary":"Create a manual journey run within the manualJourneyId based on uploaded har files."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/HarJourneyRunCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HarJourneyRunCreateRequest"}},"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_569"}},"schemaId":"schema_569"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1har-runs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_569","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_569"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/createharrun"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/har-runs"},{"label":"Get manual journey labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/journeylabels","routeSlug":"/openapi/scala-api.openapi/manual-journeys/journeylabels","metadata":{"seo":{"title":"Get manual journey labels","description":"GET /v2/manual-journeys/{manualJourneyId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"journeyLabels","name":"Get manual journey labels","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get manual journey labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/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":"manualJourneyId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}/labels","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/labels","href":"manual-journeys/journeylabels","openApiOperationId":"journeyLabels","summary":"Get manual journey labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_577"}},"schemaId":"schema_577"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/journeylabels"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/labels"},{"label":"Update manual journey labels","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/updatejourneylabels","routeSlug":"/openapi/scala-api.openapi/manual-journeys/updatejourneylabels","metadata":{"seo":{"title":"Update manual journey labels","description":"PUT /v2/manual-journeys/{manualJourneyId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateJourneyLabels","name":"Update manual journey labels","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update manual journey labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/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":"manualJourneyId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_578"}},"schemaId":"schema_578","pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/manual-journeys/{manualJourneyId}/labels","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_578"}},"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/labels","href":"manual-journeys/updatejourneylabels","openApiOperationId":"updateJourneyLabels","summary":"Update manual journey labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"schema_578","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_578"}},"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_577"}},"schemaId":"schema_577"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/updatejourneylabels"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/labels"},{"label":"Delete manual journey label","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/deletejourneylabel","routeSlug":"/openapi/scala-api.openapi/manual-journeys/deletejourneylabel","metadata":{"seo":{"title":"Delete manual journey label","description":"DELETE /v2/manual-journeys/{manualJourneyId}/labels/{labelId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteJourneyLabel","name":"Delete manual journey label","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels~1{labelId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete manual journey label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/labels/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{labelId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"labelId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels~1{labelId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/manual-journeys/{manualJourneyId}/labels/{labelId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"labelId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/labels/{labelId}","href":"manual-journeys/deletejourneylabel","openApiOperationId":"deleteJourneyLabel","summary":"Delete manual journey label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1labels~1{labelId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/deletejourneylabel"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/labels/{labelId}"},{"label":"Get manual journey rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/journeyrules","routeSlug":"/openapi/scala-api.openapi/manual-journeys/journeyrules","metadata":{"seo":{"title":"Get manual journey rules","description":"GET /v2/manual-journeys/{manualJourneyId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"journeyRules","name":"Get manual journey rules","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get manual 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":" /v2/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":"/rules"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}/rules","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/rules","href":"manual-journeys/journeyrules","openApiOperationId":"journeyRules","summary":"Get manual journey rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_575"}},"schemaId":"schema_575"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/journeyrules"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/rules"},{"label":"Update manual journey rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/updatejourneyrules","routeSlug":"/openapi/scala-api.openapi/manual-journeys/updatejourneyrules","metadata":{"seo":{"title":"Update manual journey rules","description":"PUT /v2/manual-journeys/{manualJourneyId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateJourneyRules","name":"Update manual journey rules","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1rules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update manual 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":" /v2/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":"/rules"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1rules/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575","pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1rules/put/requestBody","description":"Rules ids"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/manual-journeys/{manualJourneyId}/rules","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_575"}},"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/rules","href":"manual-journeys/updatejourneyrules","openApiOperationId":"updateJourneyRules","summary":"Update manual journey rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"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_575"}},"schemaId":"schema_575"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1rules/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/updatejourneyrules"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/rules"},{"label":"Get all available manual journey runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/allruns","routeSlug":"/openapi/scala-api.openapi/manual-journeys/allruns","metadata":{"seo":{"title":"Get all available manual journey runs","description":"GET /v2/manual-journeys/{manualJourneyId}/runs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"allRuns","name":"Get all available manual journey runs","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all available manual journey runs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"schemaId":"components/schemas/SeqObject","pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}/runs","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs","href":"manual-journeys/allruns","openApiOperationId":"allRuns","summary":"Get all available manual journey runs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/SeqObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"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_579"}},"schemaId":"schema_579"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_579","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_579"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/allruns"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs"},{"label":"Get specified manual journey run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/run","routeSlug":"/openapi/scala-api.openapi/manual-journeys/run","metadata":{"seo":{"title":"Get specified manual journey run","description":"GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"run","name":"Get specified manual journey run","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specified 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-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}/runs/{runId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}","href":"manual-journeys/run","openApiOperationId":"run","summary":"Get specified manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/JourneyRun"}},"schemaId":"components/schemas/JourneyRun"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/JourneyRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JourneyRun"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/run"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}"},{"label":"Delete manual journey run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/deletejourneyrun","routeSlug":"/openapi/scala-api.openapi/manual-journeys/deletejourneyrun","metadata":{"seo":{"title":"Delete manual journey run","description":"DELETE /v2/manual-journeys/{manualJourneyId}/runs/{runId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteJourneyRun","name":"Delete manual journey run","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete 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-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/manual-journeys/{manualJourneyId}/runs/{runId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}","href":"manual-journeys/deletejourneyrun","openApiOperationId":"deleteJourneyRun","summary":"Delete manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/deletejourneyrun"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}"},{"label":"Create new action in specified manual journey run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/nextjourneyrunaction","routeSlug":"/openapi/scala-api.openapi/manual-journeys/nextjourneyrunaction","metadata":{"seo":{"title":"Create new action in specified manual journey run","description":"POST /v2/manual-journeys/{manualJourneyId}/runs/{runId}/actions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"nextJourneyRunAction","name":"Create new action in specified manual journey run","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1actions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new action in specified 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":" /v2/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":"/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":"manualJourneyId","in":"path","schemaId":"schema_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1actions/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions","href":"manual-journeys/nextjourneyrunaction","openApiOperationId":"nextJourneyRunAction","summary":"Create new action in specified manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Action"}},"schemaId":"components/schemas/Action"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1actions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Action","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Action"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/nextjourneyrunaction"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions"},{"label":"Get specified manual journey run action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/journeyrunaction","routeSlug":"/openapi/scala-api.openapi/manual-journeys/journeyrunaction","metadata":{"seo":{"title":"Get specified manual journey run action","description":"GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"journeyRunAction","name":"Get specified manual journey run action","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1actions~1{actionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specified manual journey run 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":" /v2/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":"/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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true},{"name":"actionId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1actions~1{actionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"},{"name":"actionId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}","href":"manual-journeys/journeyrunaction","openApiOperationId":"journeyRunAction","summary":"Get specified manual journey run action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Action"}},"schemaId":"components/schemas/Action"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1actions~1{actionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Action","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Action"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/journeyrunaction"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}"},{"label":"Deletes specified manual journey run action","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/deletejourneyrunaction","routeSlug":"/openapi/scala-api.openapi/manual-journeys/deletejourneyrunaction","metadata":{"seo":{"title":"Deletes specified manual journey run action","description":"DELETE /v2/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteJourneyRunAction","name":"Deletes specified manual journey run action","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1actions~1{actionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes specified manual journey run 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-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/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":"/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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true},{"name":"actionId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1actions~1{actionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"},{"name":"actionId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}","href":"manual-journeys/deletejourneyrunaction","openApiOperationId":"deleteJourneyRunAction","summary":"Deletes specified manual journey run action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Function1"}},"schemaId":"components/schemas/Function1"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1actions~1{actionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Function1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Function1"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/deletejourneyrunaction"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}"},{"label":"Manual journey run control request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/processruncontrolrequest","routeSlug":"/openapi/scala-api.openapi/manual-journeys/processruncontrolrequest","metadata":{"seo":{"title":"Manual journey run control request","description":"POST /v2/manual-journeys/{manualJourneyId}/runs/{runId}/control"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processRunControlRequest","name":"Manual journey run control request","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1control/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual journey run control request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/control"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1control/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Function1"}},"schemaId":"components/schemas/Function1","pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1control/post/requestBody","description":"Control request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/control","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Function1"}},"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/control","href":"manual-journeys/processruncontrolrequest","openApiOperationId":"processRunControlRequest","summary":"Manual journey run control request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/Function1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Function1"}},"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/Function1"}},"schemaId":"components/schemas/Function1"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1control/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Function1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Function1"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/processruncontrolrequest"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/control"},{"label":"Get manual journey run labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/runlabels","routeSlug":"/openapi/scala-api.openapi/manual-journeys/runlabels","metadata":{"seo":{"title":"Get manual journey run labels","description":"GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runLabels","name":"Get manual journey run labels","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get manual journey run labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/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":"manualJourneyId","in":"path","schemaId":"schema_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels","href":"manual-journeys/runlabels","openApiOperationId":"runLabels","summary":"Get manual journey run labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_577"}},"schemaId":"schema_577"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/runlabels"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels"},{"label":"Update manual journey run labels","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/updaterunlabels","routeSlug":"/openapi/scala-api.openapi/manual-journeys/updaterunlabels","metadata":{"seo":{"title":"Update manual journey run labels","description":"PUT /v2/manual-journeys/{manualJourneyId}/runs/{runId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRunLabels","name":"Update manual journey run labels","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update manual journey run labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/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":"manualJourneyId","in":"path","schemaId":"schema_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_578"}},"schemaId":"schema_578","pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_578"}},"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels","href":"manual-journeys/updaterunlabels","openApiOperationId":"updateRunLabels","summary":"Update manual journey run labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"schema_578","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_578"}},"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_577"}},"schemaId":"schema_577"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/updaterunlabels"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels"},{"label":"Delete manual journey run label","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/deleterunlabel","routeSlug":"/openapi/scala-api.openapi/manual-journeys/deleterunlabel","metadata":{"seo":{"title":"Delete manual journey run label","description":"DELETE /v2/manual-journeys/{manualJourneyId}/runs/{runId}/labels/{labelId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRunLabel","name":"Delete manual journey run label","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels~1{labelId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete manual journey run label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/labels/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{labelId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true},{"name":"labelId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels~1{labelId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels/{labelId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"},{"name":"labelId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels/{labelId}","href":"manual-journeys/deleterunlabel","openApiOperationId":"deleteRunLabel","summary":"Delete manual journey run label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1labels~1{labelId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/deleterunlabel"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels/{labelId}"},{"label":"Get request filters of specified manual journey run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/getrequestfilters","routeSlug":"/openapi/scala-api.openapi/manual-journeys/getrequestfilters","metadata":{"seo":{"title":"Get request filters of specified manual journey run","description":"GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRequestFilters","name":"Get request filters of specified manual journey run","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get request filters of specified 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-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/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":"/request-filters"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters","href":"manual-journeys/getrequestfilters","openApiOperationId":"getRequestFilters","summary":"Get request filters of specified manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_580"}},"schemaId":"schema_580"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_580","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/getrequestfilters"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters"},{"label":"Set request filters for specified manual journey run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/setrequestfilters","routeSlug":"/openapi/scala-api.openapi/manual-journeys/setrequestfilters","metadata":{"seo":{"title":"Set request filters for specified manual journey run","description":"PUT /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setRequestFilters","name":"Set request filters for specified manual journey run","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set request filters for specified 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-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/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":"/request-filters"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"schemaId":"components/schemas/SeqObject","pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters","href":"manual-journeys/setrequestfilters","openApiOperationId":"setRequestFilters","summary":"Set request filters for specified manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/SeqObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"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_580"}},"schemaId":"schema_580"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_580","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/setrequestfilters"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters"},{"label":"Reset request filters for specified manual journey run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/removerequestfilters","routeSlug":"/openapi/scala-api.openapi/manual-journeys/removerequestfilters","metadata":{"seo":{"title":"Reset request filters for specified manual journey run","description":"DELETE /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeRequestFilters","name":"Reset request filters for specified manual journey run","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset request filters for specified 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-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/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":"/request-filters"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters","href":"manual-journeys/removerequestfilters","openApiOperationId":"removeRequestFilters","summary":"Reset request filters for specified manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Function1"}},"schemaId":"components/schemas/Function1"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-filters/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Function1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Function1"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/removerequestfilters"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters"},{"label":"Get request logs of specified manual journey run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/getrequestlogs","routeSlug":"/openapi/scala-api.openapi/manual-journeys/getrequestlogs","metadata":{"seo":{"title":"Get request logs of specified manual journey run","description":"GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-logs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRequestLogs","name":"Get request logs of specified manual journey run","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-logs/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get request logs of specified 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-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/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":"/request-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":"manualJourneyId","in":"path","schemaId":"schema_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-logs/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pagination"}},"schemaId":"components/schemas/Pagination","pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-logs/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-logs","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Pagination"}},"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-logs","href":"manual-journeys/getrequestlogs","openApiOperationId":"getRequestLogs","summary":"Get request logs of specified manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/Pagination","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pagination"}},"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_581"}},"schemaId":"schema_581"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1request-logs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_581","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_581"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/getrequestlogs"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-logs"},{"label":"Get tags of specified manual journey run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/manual-journeys/getruntags","routeSlug":"/openapi/scala-api.openapi/manual-journeys/getruntags","metadata":{"seo":{"title":"Get tags of specified manual journey run","description":"GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRunTags","name":"Get tags of specified manual journey run","isWebhook":false,"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1tags/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tags of specified 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-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/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":"/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":"manualJourneyId","in":"path","schemaId":"schema_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1tags/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pagination"}},"schemaId":"components/schemas/Pagination","pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1tags/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/manual-journeys/{manualJourneyId}/runs/{runId}/tags","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"manualJourneyId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Pagination"}},"responseCodes":["200","401","404"],"pointer":"/manual-journeys/{manualJourneyId}/runs/{runId}/tags","href":"manual-journeys/getruntags","openApiOperationId":"getRunTags","summary":"Get tags of specified manual journey run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/Pagination","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pagination"}},"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_571"}},"schemaId":"schema_571"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1manual-journeys~1{manualJourneyId}~1runs~1{runId}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_571","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-journeys/getruntags"}],"panels":[]}]},"httpPath":"/manual-journeys/{manualJourneyId}/runs/{runId}/tags"}],"content":{"contentType":"group","meta":{"name":"Manual Journeys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual Journeys","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints for managing manual journeys including real device testing, HAR file ingestion, and journey execution control. These endpoints power Live Connect and HAR Analyzer features in the ObservePoint UI, enabling users to perform manual testing on real devices and analyze HAR files for tag validation and troubleshooting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/sections/api-recipes/har-file-processing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HAR File Processing API Recipe"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/manual-journeys","summary":"Get all manual journeys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/alljourneys","deprecated":false},{"title":"/manual-journeys","summary":"Create new manual journey","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-journeys/createjourney","deprecated":false},{"title":"/manual-journeys/certificates/default","summary":"Get default certificate metadata","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/observepoint$api$manualjourney$manualjourneyroute$$getdefaultcertificate","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}","summary":"Get manual journey","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/journey","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}","summary":"Initialize manual journey run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-journeys/initialize","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}","summary":"Update manual journey","prefix":{"name":"put","color":"put"},"badges":[],"link":"/manual-journeys/updatejourney","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}","summary":"Delete manual journey","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manual-journeys/deletejourney","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/delete","summary":"Delete manual journey via POST request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-journeys/deletejourneyviapost","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/har-runs","summary":"Create a manual journey run within the manualJourneyId based on uploaded har files.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-journeys/createharrun","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/labels","summary":"Get manual journey labels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/journeylabels","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/labels","summary":"Update manual journey labels","prefix":{"name":"put","color":"put"},"badges":[],"link":"/manual-journeys/updatejourneylabels","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/labels/{labelId}","summary":"Delete manual journey label","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manual-journeys/deletejourneylabel","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/rules","summary":"Get manual journey rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/journeyrules","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/rules","summary":"Update manual journey rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/manual-journeys/updatejourneyrules","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs","summary":"Get all available manual journey runs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/allruns","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}","summary":"Get specified manual journey run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/run","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}","summary":"Delete manual journey run","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manual-journeys/deletejourneyrun","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions","summary":"Create new action in specified manual journey run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-journeys/nextjourneyrunaction","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}","summary":"Get specified manual journey run action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/journeyrunaction","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}","summary":"Deletes specified manual journey run action","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manual-journeys/deletejourneyrunaction","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/control","summary":"Manual journey run control request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-journeys/processruncontrolrequest","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels","summary":"Get manual journey run labels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/runlabels","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels","summary":"Update manual journey run labels","prefix":{"name":"put","color":"put"},"badges":[],"link":"/manual-journeys/updaterunlabels","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/labels/{labelId}","summary":"Delete manual journey run label","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manual-journeys/deleterunlabel","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters","summary":"Get request filters of specified manual journey run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/getrequestfilters","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters","summary":"Set request filters for specified manual journey run","prefix":{"name":"put","color":"put"},"badges":[],"link":"/manual-journeys/setrequestfilters","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters","summary":"Reset request filters for specified manual journey run","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manual-journeys/removerequestfilters","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/request-logs","summary":"Get request logs of specified manual journey run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/getrequestlogs","deprecated":false},{"title":"/manual-journeys/{manualJourneyId}/runs/{runId}/tags","summary":"Get tags of specified manual journey run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manual-journeys/getruntags","deprecated":false}]}]}]}]}},{"type":"group","label":"Folders","link":"/openapi/scala-api.openapi/folders","routeSlug":"/openapi/scala-api.openapi/folders","items":[{"label":"Get list of all folders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/folders/getfolders","routeSlug":"/openapi/scala-api.openapi/folders/getfolders","metadata":{"seo":{"title":"Get list of all folders","description":"GET /v2/folders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFolders","name":"Get list of all folders","isWebhook":false,"pointer":"/paths/~1folders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of all folders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/folders"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":"/folders","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/folders","href":"folders/getfolders","openApiOperationId":"getFolders","summary":"Get list of all folders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_582"}},"schemaId":"schema_582"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1folders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_582","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_582"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/getfolders"}],"panels":[]}]},"httpPath":"/folders"},{"label":"Create new folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/folders/createfolder","routeSlug":"/openapi/scala-api.openapi/folders/createfolder","metadata":{"seo":{"title":"Create new folder","description":"POST /v2/folders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFolder","name":"Create new folder","isWebhook":false,"pointer":"/paths/~1folders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new 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-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/folders"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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/NewFolder"}},"schemaId":"components/schemas/NewFolder","pointer":"/paths/~1folders/post/requestBody","description":"Folder create information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/folders","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NewFolder"}},"responseCodes":["201","401"],"pointer":"/folders","href":"folders/createfolder","openApiOperationId":"createFolder","summary":"Create new folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/NewFolder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewFolder"}},"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/Folder"}},"schemaId":"components/schemas/Folder"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1folders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Folder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Folder"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/createfolder"}],"panels":[]}]},"httpPath":"/folders"},{"label":"Get folder by given id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/folders/findfolder","routeSlug":"/openapi/scala-api.openapi/folders/findfolder","metadata":{"seo":{"title":"Get folder by given id","description":"GET /v2/folders/{folderId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findFolder","name":"Get folder by given id","isWebhook":false,"pointer":"/paths/~1folders~1{folderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get folder by given 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":" /v2/folders/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{folderId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"folderId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1folders~1{folderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/folders/{folderId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"folderId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/folders/{folderId}","href":"folders/findfolder","openApiOperationId":"findFolder","summary":"Get folder by given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Folder"}},"schemaId":"components/schemas/Folder"},{"code":"403","description":"Don't have permissions to access this folder"},{"code":"404","description":"Folder by given id not found"}],"pointer":"/paths/~1folders~1{folderId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Folder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Folder"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/findfolder"}],"panels":[]}]},"httpPath":"/folders/{folderId}"},{"label":"Update folder with given id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/folders/updatefolder","routeSlug":"/openapi/scala-api.openapi/folders/updatefolder","metadata":{"seo":{"title":"Update folder with given id","description":"PUT /v2/folders/{folderId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFolder","name":"Update folder with given id","isWebhook":false,"pointer":"/paths/~1folders~1{folderId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update folder with given 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-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/folders/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{folderId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"folderId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1folders~1{folderId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateFolder"}},"schemaId":"components/schemas/UpdateFolder","pointer":"/paths/~1folders~1{folderId}/put/requestBody","description":"Folder update information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/folders/{folderId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"folderId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateFolder"}},"responseCodes":["200","403","404"],"pointer":"/folders/{folderId}","href":"folders/updatefolder","openApiOperationId":"updateFolder","summary":"Update folder with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/UpdateFolder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateFolder"}},"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/Folder"}},"schemaId":"components/schemas/Folder"},{"code":"403","description":"Don't have permissions to access this folder"},{"code":"404","description":"Folder by given id not found"}],"pointer":"/paths/~1folders~1{folderId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Folder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Folder"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/updatefolder"}],"panels":[]}]},"httpPath":"/folders/{folderId}"},{"label":"Delete folder with given id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/folders/deletefolder","routeSlug":"/openapi/scala-api.openapi/folders/deletefolder","metadata":{"seo":{"title":"Delete folder with given id","description":"DELETE /v2/folders/{folderId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFolder","name":"Delete folder with given id","isWebhook":false,"pointer":"/paths/~1folders~1{folderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete folder with given 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":" /v2/folders/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{folderId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"folderId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1folders~1{folderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/folders/{folderId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"folderId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","403","404","423"],"pointer":"/folders/{folderId}","href":"folders/deletefolder","openApiOperationId":"deleteFolder","summary":"Delete folder with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"403","description":"Don't have permissions to access this folder"},{"code":"404","description":"Folder by given id not found"},{"code":"423","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following items are still running. Please stop & discard their active runs first"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemsAreRunningApiError"}},"schemaId":"components/schemas/ItemsAreRunningApiError"}],"pointer":"/paths/~1folders~1{folderId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"403"},{"code":"404"},{"code":"423","schemaId":"components/schemas/ItemsAreRunningApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemsAreRunningApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/deletefolder"}],"panels":[]}]},"httpPath":"/folders/{folderId}"},{"label":"Get users of folder with given id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/folders/getuserswithfolderid","routeSlug":"/openapi/scala-api.openapi/folders/getuserswithfolderid","metadata":{"seo":{"title":"Get users of folder with given id","description":"GET /v2/folders/{folderId}/users"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUsersWithFolderId","name":"Get users of folder with given id","isWebhook":false,"pointer":"/paths/~1folders~1{folderId}~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get users of folder with given 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":" /v2/folders/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{folderId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/users"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"folderId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1folders~1{folderId}~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/folders/{folderId}/users","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"folderId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/folders/{folderId}/users","href":"folders/getuserswithfolderid","openApiOperationId":"GetUsersWithFolderId","summary":"Get users of folder with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_573"}},"schemaId":"schema_573"},{"code":"403","description":"Don't have permissions to access this folder"},{"code":"404","description":"Folder by given id not found"}],"pointer":"/paths/~1folders~1{folderId}~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_573","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_573"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/getuserswithfolderid"}],"panels":[]}]},"httpPath":"/folders/{folderId}/users"},{"label":"Add users to folder with given id","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/folders/addusers","routeSlug":"/openapi/scala-api.openapi/folders/addusers","metadata":{"seo":{"title":"Add users to folder with given id","description":"POST /v2/folders/{folderId}/users"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addUsers","name":"Add users to folder with given id","isWebhook":false,"pointer":"/paths/~1folders~1{folderId}~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add users to folder with given 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-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/folders/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{folderId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/users"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"folderId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1folders~1{folderId}~1users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575","pointer":"/paths/~1folders~1{folderId}~1users/post/requestBody","description":"List of users ids"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/folders/{folderId}/users","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"folderId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_575"}},"responseCodes":["201","403","404"],"pointer":"/folders/{folderId}/users","href":"folders/addusers","openApiOperationId":"addUsers","summary":"Add users to folder with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"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":"schema_573"}},"schemaId":"schema_573"},{"code":"403","description":"Don't have permissions to access this folder"},{"code":"404","description":"Folder by given id not found"}],"pointer":"/paths/~1folders~1{folderId}~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_573","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_573"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/addusers"}],"panels":[]}]},"httpPath":"/folders/{folderId}/users"}],"content":{"contentType":"group","meta":{"name":"Folders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Folders","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing folders including creation, organization, access control, and folder-based resource management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/folders","summary":"Get list of all folders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/folders/getfolders","deprecated":false},{"title":"/folders","summary":"Create new folder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/folders/createfolder","deprecated":false},{"title":"/folders/{folderId}","summary":"Get folder by given id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/folders/findfolder","deprecated":false},{"title":"/folders/{folderId}","summary":"Update folder with given id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/folders/updatefolder","deprecated":false},{"title":"/folders/{folderId}","summary":"Delete folder with given id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/folders/deletefolder","deprecated":false},{"title":"/folders/{folderId}/users","summary":"Get users of folder with given id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/folders/getuserswithfolderid","deprecated":false},{"title":"/folders/{folderId}/users","summary":"Add users to folder with given id","prefix":{"name":"post","color":"post"},"badges":[],"link":"/folders/addusers","deprecated":false}]}]}]}]}},{"type":"group","label":"Sub-Folders","link":"/openapi/scala-api.openapi/sub-folders","routeSlug":"/openapi/scala-api.openapi/sub-folders","items":[{"label":"Get list of all sub-folders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/sub-folders/getdomains","routeSlug":"/openapi/scala-api.openapi/sub-folders/getdomains","metadata":{"seo":{"title":"Get list of all sub-folders","description":"GET /v2/domains"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDomains","name":"Get list of all sub-folders","isWebhook":false,"pointer":"/paths/~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of all sub-folders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/domains","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/domains","href":"sub-folders/getdomains","openApiOperationId":"getDomains","summary":"Get list of all sub-folders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_583"}},"schemaId":"schema_583"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_583","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_583"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sub-folders/getdomains"}],"panels":[]}]},"httpPath":"/domains"},{"label":"Create new sub-folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/sub-folders/createdomain","routeSlug":"/openapi/scala-api.openapi/sub-folders/createdomain","metadata":{"seo":{"title":"Create new sub-folder","description":"POST /v2/domains"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDomain","name":"Create new sub-folder","isWebhook":false,"pointer":"/paths/~1domains/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new sub-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-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewDomain"}},"schemaId":"components/schemas/NewDomain","pointer":"/paths/~1domains/post/requestBody","description":"New sub-folder info"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/domains","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NewDomain"}},"responseCodes":["201","401"],"pointer":"/domains","href":"sub-folders/createdomain","openApiOperationId":"createDomain","summary":"Create new sub-folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/NewDomain","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewDomain"}},"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/Domain"}},"schemaId":"components/schemas/Domain"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1domains/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Domain","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sub-folders/createdomain"}],"panels":[]}]},"httpPath":"/domains"},{"label":"Get sub-folder by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/sub-folders/getdomain","routeSlug":"/openapi/scala-api.openapi/sub-folders/getdomain","metadata":{"seo":{"title":"Get sub-folder by id","description":"GET /v2/domains/{domainId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDomain","name":"Get sub-folder by id","isWebhook":false,"pointer":"/paths/~1domains~1{domainId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get sub-folder 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":" /v2/domains/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{domainId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"domainId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1domains~1{domainId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/domains/{domainId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"domainId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/domains/{domainId}","href":"sub-folders/getdomain","openApiOperationId":"getDomain","summary":"Get sub-folder by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Domain"}},"schemaId":"components/schemas/Domain"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1domains~1{domainId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Domain","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sub-folders/getdomain"}],"panels":[]}]},"httpPath":"/domains/{domainId}"},{"label":"Update sub-folder with given id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/sub-folders/updatedomain","routeSlug":"/openapi/scala-api.openapi/sub-folders/updatedomain","metadata":{"seo":{"title":"Update sub-folder with given id","description":"PUT /v2/domains/{domainId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDomain","name":"Update sub-folder with given id","isWebhook":false,"pointer":"/paths/~1domains~1{domainId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update sub-folder with given 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-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/domains/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{domainId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"domainId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1domains~1{domainId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DomainUpdate"}},"schemaId":"components/schemas/DomainUpdate","pointer":"/paths/~1domains~1{domainId}/put/requestBody","description":"Sub-folder update information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/domains/{domainId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"domainId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DomainUpdate"}},"responseCodes":["200","401","404"],"pointer":"/domains/{domainId}","href":"sub-folders/updatedomain","openApiOperationId":"updateDomain","summary":"Update sub-folder with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/DomainUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DomainUpdate"}},"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/Domain"}},"schemaId":"components/schemas/Domain"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1domains~1{domainId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Domain","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sub-folders/updatedomain"}],"panels":[]}]},"httpPath":"/domains/{domainId}"},{"label":"Delete sub-folder with given id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/sub-folders/deletedomain","routeSlug":"/openapi/scala-api.openapi/sub-folders/deletedomain","metadata":{"seo":{"title":"Delete sub-folder with given id","description":"DELETE /v2/domains/{domainId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDomain","name":"Delete sub-folder with given id","isWebhook":false,"pointer":"/paths/~1domains~1{domainId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete sub-folder with given 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":" /v2/domains/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{domainId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"domainId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1domains~1{domainId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/domains/{domainId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"domainId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","423"],"pointer":"/domains/{domainId}","href":"sub-folders/deletedomain","openApiOperationId":"deleteDomain","summary":"Delete sub-folder with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"423","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following items are still running. Please stop & discard their active runs first"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemsAreRunningApiError"}},"schemaId":"components/schemas/ItemsAreRunningApiError"}],"pointer":"/paths/~1domains~1{domainId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"423","schemaId":"components/schemas/ItemsAreRunningApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemsAreRunningApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sub-folders/deletedomain"}],"panels":[]}]},"httpPath":"/domains/{domainId}"},{"label":"Get web audits for sub-folder with given id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/sub-folders/getaudits","routeSlug":"/openapi/scala-api.openapi/sub-folders/getaudits","metadata":{"seo":{"title":"Get web audits for sub-folder with given id","description":"GET /v2/domains/{domainId}/web-audits"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAudits","name":"Get web audits for sub-folder with given id","isWebhook":false,"pointer":"/paths/~1domains~1{domainId}~1web-audits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web audits for sub-folder with given 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":" /v2/domains/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{domainId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/web-audits"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"domainId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1domains~1{domainId}~1web-audits/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"withRuns","in":"query","schemaId":"schema_584","required":true},{"name":"runsLimit","in":"query","schemaId":"schema_585","required":true}],"pointer":"/paths/~1domains~1{domainId}~1web-audits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/domains/{domainId}/web-audits","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"domainId","in":"path","required":true,"schemaId":"schema_568"}],"query":[{"name":"withRuns","in":"query","required":true,"schemaId":"schema_584"},{"name":"runsLimit","in":"query","required":true,"schemaId":"schema_585"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/domains/{domainId}/web-audits","href":"sub-folders/getaudits","openApiOperationId":"getAudits","summary":"Get web audits for sub-folder with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_586"}},"schemaId":"schema_586"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1domains~1{domainId}~1web-audits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_586","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sub-folders/getaudits"}],"panels":[]}]},"httpPath":"/domains/{domainId}/web-audits"},{"label":"Get web journeys for sub-folder with given id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/sub-folders/getwebjourneys","routeSlug":"/openapi/scala-api.openapi/sub-folders/getwebjourneys","metadata":{"seo":{"title":"Get web journeys for sub-folder with given id","description":"GET /v2/domains/{domainId}/web-journeys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebJourneys","name":"Get web journeys for sub-folder with given id","isWebhook":false,"pointer":"/paths/~1domains~1{domainId}~1web-journeys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web journeys for sub-folder with given 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":" /v2/domains/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{domainId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/web-journeys"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"domainId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1domains~1{domainId}~1web-journeys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/domains/{domainId}/web-journeys","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"domainId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/domains/{domainId}/web-journeys","href":"sub-folders/getwebjourneys","openApiOperationId":"getWebJourneys","summary":"Get web journeys for sub-folder with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_570"}},"schemaId":"schema_570"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1domains~1{domainId}~1web-journeys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_570","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_570"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sub-folders/getwebjourneys"}],"panels":[]}]},"httpPath":"/domains/{domainId}/web-journeys"}],"content":{"contentType":"group","meta":{"name":"Sub-Folders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sub-Folders","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing sub-folders including creation, configuration, and sub-folder-based audit and journey management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/domains","summary":"Get list of all sub-folders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sub-folders/getdomains","deprecated":false},{"title":"/domains","summary":"Create new sub-folder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sub-folders/createdomain","deprecated":false},{"title":"/domains/{domainId}","summary":"Get sub-folder by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sub-folders/getdomain","deprecated":false},{"title":"/domains/{domainId}","summary":"Update sub-folder with given id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sub-folders/updatedomain","deprecated":false},{"title":"/domains/{domainId}","summary":"Delete sub-folder with given id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sub-folders/deletedomain","deprecated":false},{"title":"/domains/{domainId}/web-audits","summary":"Get web audits for sub-folder with given id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sub-folders/getaudits","deprecated":false},{"title":"/domains/{domainId}/web-journeys","summary":"Get web journeys for sub-folder with given id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sub-folders/getwebjourneys","deprecated":false}]}]}]}]}},{"type":"group","label":"Audits","link":"/openapi/scala-api.openapi/audits","routeSlug":"/openapi/scala-api.openapi/audits","items":[{"label":"Get list of all web audits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getallwebaudits","routeSlug":"/openapi/scala-api.openapi/audits/getallwebaudits","metadata":{"seo":{"title":"Get list of all web audits","description":"GET /v2/web-audits"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllWebAudits","name":"Get list of all web audits","isWebhook":false,"pointer":"/paths/~1web-audits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of all 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":" /v2/web-audits"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"withRuns","in":"query","schemaId":"schema_584"},{"name":"runsLimit","in":"query","schemaId":"schema_585"}],"pointer":"/paths/~1web-audits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/web-audits","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[{"name":"withRuns","in":"query","required":false,"schemaId":"schema_584"},{"name":"runsLimit","in":"query","required":false,"schemaId":"schema_585"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/web-audits","href":"audits/getallwebaudits","openApiOperationId":"getAllWebAudits","summary":"Get list of all web audits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_586"}},"schemaId":"schema_586"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1web-audits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_586","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getallwebaudits"}],"panels":[]}]},"httpPath":"/web-audits"},{"label":"Create new web audit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/createwebaudit","routeSlug":"/openapi/scala-api.openapi/audits/createwebaudit","metadata":{"seo":{"title":"Create new web audit","description":"POST /v2/web-audits"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebAudit","name":"Create new web audit","isWebhook":false,"pointer":"/paths/~1web-audits/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new 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-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/web-audits"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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/NewAudit"}},"schemaId":"components/schemas/NewAudit","pointer":"/paths/~1web-audits/post/requestBody","description":"New web audit info"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/web-audits","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NewAudit"}},"responseCodes":["201","401","404"],"pointer":"/web-audits","href":"audits/createwebaudit","openApiOperationId":"createWebAudit","summary":"Create new web audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/NewAudit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewAudit"}},"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/Audit"}},"schemaId":"components/schemas/Audit"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Audit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Audit"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/createwebaudit"}],"panels":[]}]},"httpPath":"/web-audits"},{"label":"Get list of all frequencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getwebauditavailablefrequencies","routeSlug":"/openapi/scala-api.openapi/audits/getwebauditavailablefrequencies","metadata":{"seo":{"title":"Get list of all frequencies","description":"GET /v2/web-audits/frequencies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAuditAvailableFrequencies","name":"Get list of all frequencies","isWebhook":false,"pointer":"/paths/~1web-audits~1frequencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of all 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":" /v2/web-audits/frequencies"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":"/web-audits/frequencies","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/web-audits/frequencies","href":"audits/getwebauditavailablefrequencies","openApiOperationId":"getWebAuditAvailableFrequencies","summary":"Get list of all frequencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_580"}},"schemaId":"schema_580"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1web-audits~1frequencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_580","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getwebauditavailablefrequencies"}],"panels":[]}]},"httpPath":"/web-audits/frequencies"},{"label":"Get list of all available locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getwebauditavailablelocations","routeSlug":"/openapi/scala-api.openapi/audits/getwebauditavailablelocations","metadata":{"seo":{"title":"Get list of all available locations","description":"GET /v2/web-audits/locations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAuditAvailableLocations","name":"Get list of all available locations","isWebhook":false,"pointer":"/paths/~1web-audits~1locations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of all available 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":" /v2/web-audits/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":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/web-audits/locations","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/web-audits/locations","href":"audits/getwebauditavailablelocations","openApiOperationId":"getWebAuditAvailableLocations","summary":"Get list of all available locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_587"}},"schemaId":"schema_587"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1web-audits~1locations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_587","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_587"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getwebauditavailablelocations"}],"panels":[]}]},"httpPath":"/web-audits/locations"},{"label":"Get list of all available user agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getwebauditavailableuseragents","routeSlug":"/openapi/scala-api.openapi/audits/getwebauditavailableuseragents","metadata":{"seo":{"title":"Get list of all available user agents","description":"GET /v2/web-audits/user-agents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAuditAvailableUserAgents","name":"Get list of all available user agents","isWebhook":false,"pointer":"/paths/~1web-audits~1user-agents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of all available user agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/web-audits/user-agents"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":"/web-audits/user-agents","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/web-audits/user-agents","href":"audits/getwebauditavailableuseragents","openApiOperationId":"getWebAuditAvailableUserAgents","summary":"Get list of all available user agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_588"}},"schemaId":"schema_588"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1web-audits~1user-agents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_588","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getwebauditavailableuseragents"}],"panels":[]}]},"httpPath":"/web-audits/user-agents"},{"label":"Get audit labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getauditlabels","routeSlug":"/openapi/scala-api.openapi/audits/getauditlabels","metadata":{"seo":{"title":"Get audit labels","description":"GET /v2/web-audits/{auditId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditLabels","name":"Get audit labels","isWebhook":false,"pointer":"/paths/~1web-audits~1{auditId}~1labels/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get audit labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/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":"auditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{auditId}~1labels/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"schemaId":"components/schemas/UserContext","pointer":"/paths/~1web-audits~1{auditId}~1labels/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/web-audits/{auditId}/labels","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserContext"}},"responseCodes":["200","401","404"],"pointer":"/web-audits/{auditId}/labels","href":"audits/getauditlabels","openApiOperationId":"getAuditLabels","summary":"Get audit labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/UserContext","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserContext"}},"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/Label"}},"schemaId":"components/schemas/Label"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{auditId}~1labels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Label","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Label"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getauditlabels"}],"panels":[]}]},"httpPath":"/web-audits/{auditId}/labels"},{"label":"Create audit labels","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/createauditlabels","routeSlug":"/openapi/scala-api.openapi/audits/createauditlabels","metadata":{"seo":{"title":"Create audit labels","description":"PUT /v2/web-audits/{auditId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAuditLabels","name":"Create audit labels","isWebhook":false,"pointer":"/paths/~1web-audits~1{auditId}~1labels/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create audit labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/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":"auditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{auditId}~1labels/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"schemaId":"components/schemas/SeqObject","pointer":"/paths/~1web-audits~1{auditId}~1labels/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/web-audits/{auditId}/labels","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"responseCodes":["200","401","404"],"pointer":"/web-audits/{auditId}/labels","href":"audits/createauditlabels","openApiOperationId":"createAuditLabels","summary":"Create audit labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/SeqObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SeqObject"}},"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/Label"}},"schemaId":"components/schemas/Label"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{auditId}~1labels/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Label","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Label"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/createauditlabels"}],"panels":[]}]},"httpPath":"/web-audits/{auditId}/labels"},{"label":"Delete web audit labels","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/deletewebauditlabels","routeSlug":"/openapi/scala-api.openapi/audits/deletewebauditlabels","metadata":{"seo":{"title":"Delete web audit labels","description":"DELETE /v2/web-audits/{auditId}/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebAuditLabels","name":"Delete web audit labels","isWebhook":false,"pointer":"/paths/~1web-audits~1{auditId}~1labels/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete web audit labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"/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":"auditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{auditId}~1labels/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_568"}},"schemaId":"schema_568","pointer":"/paths/~1web-audits~1{auditId}~1labels/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/web-audits/{auditId}/labels","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"auditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_568"}},"responseCodes":["200","204","404"],"pointer":"/web-audits/{auditId}/labels","href":"audits/deletewebauditlabels","openApiOperationId":"deleteWebAuditLabels","summary":"Delete web audit labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"schema_568","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_568"}},"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/Function1"}},"schemaId":"components/schemas/Function1"},{"code":"204","description":"Item was successfully deleted"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{auditId}~1labels/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Function1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Function1"}}},{"code":"204"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/deletewebauditlabels"}],"panels":[]}]},"httpPath":"/web-audits/{auditId}/labels"},{"label":"Get web audit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getwebaudit","routeSlug":"/openapi/scala-api.openapi/audits/getwebaudit","metadata":{"seo":{"title":"Get web audit","description":"GET /v2/web-audits/{webAuditId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAudit","name":"Get web audit","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get 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-get"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"withRuns","in":"query","schemaId":"schema_584"},{"name":"runsLimit","in":"query","schemaId":"schema_585"}],"pointer":"/paths/~1web-audits~1{webAuditId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/web-audits/{webAuditId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[{"name":"withRuns","in":"query","required":false,"schemaId":"schema_584"},{"name":"runsLimit","in":"query","required":false,"schemaId":"schema_585"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/web-audits/{webAuditId}","href":"audits/getwebaudit","openApiOperationId":"getWebAudit","summary":"Get web audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/Audit"}},"schemaId":"components/schemas/Audit"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{webAuditId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Audit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Audit"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getwebaudit"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}"},{"label":"Update web audit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/updatewebaudit","routeSlug":"/openapi/scala-api.openapi/audits/updatewebaudit","metadata":{"seo":{"title":"Update web audit","description":"PUT /v2/web-audits/{webAuditId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebAudit","name":"Update web audit","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update 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-put"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditUpdate"}},"schemaId":"components/schemas/AuditUpdate","pointer":"/paths/~1web-audits~1{webAuditId}/put/requestBody","description":"Update web audit info"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/web-audits/{webAuditId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditUpdate"}},"responseCodes":["200","401","404","422"],"pointer":"/web-audits/{webAuditId}","href":"audits/updatewebaudit","openApiOperationId":"updateWebAudit","summary":"Update web audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/AuditUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditUpdate"}},"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/Audit"}},"schemaId":"components/schemas/Audit"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"},{"code":"422","description":"Supplied entity didn't pass a validation"}],"pointer":"/paths/~1web-audits~1{webAuditId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Audit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Audit"}}},{"code":"401"},{"code":"404"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/updatewebaudit"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}"},{"label":"Delete web audit","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/deletewebaudit","routeSlug":"/openapi/scala-api.openapi/audits/deletewebaudit","metadata":{"seo":{"title":"Delete web audit","description":"DELETE /v2/web-audits/{webAuditId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebAudit","name":"Delete web audit","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete 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-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/web-audits/{webAuditId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","404","423"],"pointer":"/web-audits/{webAuditId}","href":"audits/deletewebaudit","openApiOperationId":"deleteWebAudit","summary":"Delete web audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"},{"code":"423","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This item has active run. Please stop & discard active run first"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemIsRunningApiError"}},"schemaId":"components/schemas/ItemIsRunningApiError"}],"pointer":"/paths/~1web-audits~1{webAuditId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"404"},{"code":"423","schemaId":"components/schemas/ItemIsRunningApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItemIsRunningApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/deletewebaudit"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}"},{"label":"Get web audit filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getwebauditfilters","routeSlug":"/openapi/scala-api.openapi/audits/getwebauditfilters","metadata":{"seo":{"title":"Get web audit filters","description":"GET /v2/web-audits/{webAuditId}/filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAuditFilters","name":"Get web audit filters","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1filters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web audit filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/filters"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1filters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/web-audits/{webAuditId}/filters","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/web-audits/{webAuditId}/filters","href":"audits/getwebauditfilters","openApiOperationId":"getWebAuditFilters","summary":"Get web audit filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/AuditFilters"}},"schemaId":"components/schemas/AuditFilters"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1filters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditFilters","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditFilters"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getwebauditfilters"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/filters"},{"label":"Update web audit filters","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/updatewebauditfilters","routeSlug":"/openapi/scala-api.openapi/audits/updatewebauditfilters","metadata":{"seo":{"title":"Update web audit filters","description":"PUT /v2/web-audits/{webAuditId}/filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebAuditFilters","name":"Update web audit filters","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1filters/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update web audit filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/filters"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1filters/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditFilters"}},"schemaId":"components/schemas/AuditFilters","pointer":"/paths/~1web-audits~1{webAuditId}~1filters/put/requestBody","description":"New web audit filters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/web-audits/{webAuditId}/filters","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuditFilters"}},"responseCodes":["200","401","404","422"],"pointer":"/web-audits/{webAuditId}/filters","href":"audits/updatewebauditfilters","openApiOperationId":"updateWebAuditFilters","summary":"Update web audit filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/AuditFilters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuditFilters"}},"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/AuditFilters"}},"schemaId":"components/schemas/AuditFilters"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"},{"code":"422","description":"Supplied entity didn't pass a validation"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1filters/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditFilters","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditFilters"}}},{"code":"401"},{"code":"404"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/updatewebauditfilters"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/filters"},{"label":"Get web audit rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getwebauditrules","routeSlug":"/openapi/scala-api.openapi/audits/getwebauditrules","metadata":{"seo":{"title":"Get web audit rules","description":"GET /v2/web-audits/{webAuditId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAuditRules","name":"Get web audit rules","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get web audit 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":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/rules"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/web-audits/{webAuditId}/rules","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/web-audits/{webAuditId}/rules","href":"audits/getwebauditrules","openApiOperationId":"getWebAuditRules","summary":"Get web audit rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_589"}},"schemaId":"schema_589"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_589","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_589"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getwebauditrules"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/rules"},{"label":"Update web audit rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/updatewebauditrules","routeSlug":"/openapi/scala-api.openapi/audits/updatewebauditrules","metadata":{"seo":{"title":"Update web audit rules","description":"PUT /v2/web-audits/{webAuditId}/rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebAuditRules","name":"Update web audit rules","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1rules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update web audit 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":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/rules"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1rules/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575","pointer":"/paths/~1web-audits~1{webAuditId}~1rules/put/requestBody","description":"New web audit rule ids"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/web-audits/{webAuditId}/rules","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_575"}},"responseCodes":["200","401","404"],"pointer":"/web-audits/{webAuditId}/rules","href":"audits/updatewebauditrules","openApiOperationId":"updateWebAuditRules","summary":"Update web audit rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"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_589"}},"schemaId":"schema_589"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1rules/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_589","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_589"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/updatewebauditrules"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/rules"},{"label":"Get all available audit runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getruns","routeSlug":"/openapi/scala-api.openapi/audits/getruns","metadata":{"seo":{"title":"Get all available audit runs","description":"GET /v2/web-audits/{webAuditId}/runs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRuns","name":"Get all available audit runs","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1runs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all available audit runs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/web-audits/{webAuditId}/runs","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/web-audits/{webAuditId}/runs","href":"audits/getruns","openApiOperationId":"getRuns","summary":"Get all available audit runs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_590"}},"schemaId":"schema_590"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_590","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getruns"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/runs"},{"label":"Request audit run creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/runauditnow","routeSlug":"/openapi/scala-api.openapi/audits/runauditnow","metadata":{"seo":{"title":"Request audit run creation","description":"POST /v2/web-audits/{webAuditId}/runs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runAuditNow","name":"Request audit run creation","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1runs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request audit run creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/web-audits/{webAuditId}/runs","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","202","401","404"],"pointer":"/web-audits/{webAuditId}/runs","href":"audits/runauditnow","openApiOperationId":"runAuditNow","summary":"Request audit run creation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/AuditRunSwaggerReference"}},"schemaId":"components/schemas/AuditRunSwaggerReference"},{"code":"202","description":"This audit can't be run at this moment but is queued to run in the future when the concurrency limit is not exceeded"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRunSwaggerReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRunSwaggerReference"}}},{"code":"202"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/runauditnow"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/runs"},{"label":"Stop and finish the currently running audit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/finishactiveauditrun","routeSlug":"/openapi/scala-api.openapi/audits/finishactiveauditrun","metadata":{"seo":{"title":"Stop and finish the currently running audit","description":"POST /v2/web-audits/{webAuditId}/runs/current/finish"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"finishActiveAuditRun","name":"Stop and finish the currently running audit","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1current~1finish/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop and finish the currently running 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-post"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"/runs/current/finish"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1current~1finish/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/web-audits/{webAuditId}/runs/current/finish","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","409"],"pointer":"/web-audits/{webAuditId}/runs/current/finish","href":"audits/finishactiveauditrun","openApiOperationId":"finishActiveAuditRun","summary":"Stop and finish the currently running audit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Audit run successfully stopped and queued for summarization"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"403","description":"User does not have permission to stop this audit"},{"code":"404","description":"No active run found for this audit"},{"code":"409","description":"The audit run is already stopped or completed"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1current~1finish/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/finishactiveauditrun"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/runs/current/finish"},{"label":"Get specified audit run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getrun","routeSlug":"/openapi/scala-api.openapi/audits/getrun","metadata":{"seo":{"title":"Get specified audit run","description":"GET /v2/web-audits/{webAuditId}/runs/{runId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRun","name":"Get specified audit run","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1{runId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get 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":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true},{"name":"runId","in":"path","schemaId":"schema_569","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1{runId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/web-audits/{webAuditId}/runs/{runId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_569"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/web-audits/{webAuditId}/runs/{runId}","href":"audits/getrun","openApiOperationId":"getRun","summary":"Get specified audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/AuditRunSwaggerReference"}},"schemaId":"components/schemas/AuditRunSwaggerReference"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1{runId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditRunSwaggerReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditRunSwaggerReference"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getrun"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/runs/{runId}"},{"label":"Stop and discard audit run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/stopauditrun","routeSlug":"/openapi/scala-api.openapi/audits/stopauditrun","metadata":{"seo":{"title":"Stop and discard audit run","description":"DELETE /v2/web-audits/{webAuditId}/runs/{runId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stopAuditRun","name":"Stop and discard audit run","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1{runId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop and discard 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-delete"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"webAuditId","in":"path","schemaId":"schema_568","required":true},{"name":"runId","in":"path","schemaId":"schema_569","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1{runId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/web-audits/{webAuditId}/runs/{runId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_569"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401"],"pointer":"/web-audits/{webAuditId}/runs/{runId}","href":"audits/stopauditrun","openApiOperationId":"stopAuditRun","summary":"Stop and discard audit run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Item was successfully deleted"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1{runId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/stopauditrun"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/runs/{runId}"},{"label":"Get rule results for page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/audits/getpageruleresults","routeSlug":"/openapi/scala-api.openapi/audits/getpageruleresults","metadata":{"seo":{"title":"Get rule results for page","description":"GET /v2/web-audits/{webAuditId}/runs/{runId}/pages/{pageId}/rule-results"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPageRuleResults","name":"Get rule results for page","isWebhook":false,"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1{runId}~1pages~1{pageId}~1rule-results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rule results for 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":" /v2/web-audits/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{webAuditId}"},"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":"/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":"webAuditId","in":"path","schemaId":"schema_568","required":true},{"name":"runId","in":"path","schemaId":"schema_568","required":true},{"name":"pageId","in":"path","schemaId":"schema_585","required":true}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1{runId}~1pages~1{pageId}~1rule-results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/web-audits/{webAuditId}/runs/{runId}/pages/{pageId}/rule-results","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"webAuditId","in":"path","required":true,"schemaId":"schema_568"},{"name":"runId","in":"path","required":true,"schemaId":"schema_568"},{"name":"pageId","in":"path","required":true,"schemaId":"schema_585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/web-audits/{webAuditId}/runs/{runId}/pages/{pageId}/rule-results","href":"audits/getpageruleresults","openApiOperationId":"getPageRuleResults","summary":"Get rule results for page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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/PageRuleResults"}},"schemaId":"components/schemas/PageRuleResults"},{"code":"401","description":"Authentication credentials are missing or invalid"},{"code":"404","description":"Requested item not found"}],"pointer":"/paths/~1web-audits~1{webAuditId}~1runs~1{runId}~1pages~1{pageId}~1rule-results/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageRuleResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageRuleResults"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audits/getpageruleresults"}],"panels":[]}]},"httpPath":"/web-audits/{webAuditId}/runs/{runId}/pages/{pageId}/rule-results"}],"content":{"contentType":"group","meta":{"name":"Audits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audits","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing audits including creation, configuration, execution, and retrieving audit results and runs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/web-audits","summary":"Get list of all web audits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getallwebaudits","deprecated":false},{"title":"/web-audits","summary":"Create new web audit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audits/createwebaudit","deprecated":false},{"title":"/web-audits/frequencies","summary":"Get list of all frequencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getwebauditavailablefrequencies","deprecated":false},{"title":"/web-audits/locations","summary":"Get list of all available locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getwebauditavailablelocations","deprecated":false},{"title":"/web-audits/user-agents","summary":"Get list of all available user agents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getwebauditavailableuseragents","deprecated":false},{"title":"/web-audits/{auditId}/labels","summary":"Get audit labels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getauditlabels","deprecated":false},{"title":"/web-audits/{auditId}/labels","summary":"Create audit labels","prefix":{"name":"put","color":"put"},"badges":[],"link":"/audits/createauditlabels","deprecated":false},{"title":"/web-audits/{auditId}/labels","summary":"Delete web audit labels","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/audits/deletewebauditlabels","deprecated":false},{"title":"/web-audits/{webAuditId}","summary":"Get web audit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getwebaudit","deprecated":false},{"title":"/web-audits/{webAuditId}","summary":"Update web audit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/audits/updatewebaudit","deprecated":false},{"title":"/web-audits/{webAuditId}","summary":"Delete web audit","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/audits/deletewebaudit","deprecated":false},{"title":"/web-audits/{webAuditId}/filters","summary":"Get web audit filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getwebauditfilters","deprecated":false},{"title":"/web-audits/{webAuditId}/filters","summary":"Update web audit filters","prefix":{"name":"put","color":"put"},"badges":[],"link":"/audits/updatewebauditfilters","deprecated":false},{"title":"/web-audits/{webAuditId}/rules","summary":"Get web audit rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getwebauditrules","deprecated":false},{"title":"/web-audits/{webAuditId}/rules","summary":"Update web audit rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/audits/updatewebauditrules","deprecated":false},{"title":"/web-audits/{webAuditId}/runs","summary":"Get all available audit runs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getruns","deprecated":false},{"title":"/web-audits/{webAuditId}/runs","summary":"Request audit run creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audits/runauditnow","deprecated":false},{"title":"/web-audits/{webAuditId}/runs/current/finish","summary":"Stop and finish the currently running audit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audits/finishactiveauditrun","deprecated":false},{"title":"/web-audits/{webAuditId}/runs/{runId}","summary":"Get specified audit run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getrun","deprecated":false},{"title":"/web-audits/{webAuditId}/runs/{runId}","summary":"Stop and discard audit run","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/audits/stopauditrun","deprecated":false},{"title":"/web-audits/{webAuditId}/runs/{runId}/pages/{pageId}/rule-results","summary":"Get rule results for page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audits/getpageruleresults","deprecated":false}]}]}]}]}},{"type":"group","label":"Labels","link":"/openapi/scala-api.openapi/labels","routeSlug":"/openapi/scala-api.openapi/labels","items":[{"label":"Get list of all labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/labels/getlabels","routeSlug":"/openapi/scala-api.openapi/labels/getlabels","metadata":{"seo":{"title":"Get list of all labels","description":"GET /v2/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLabels","name":"Get list of all labels","isWebhook":false,"pointer":"/paths/~1labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of all labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/labels","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/labels","href":"labels/getlabels","openApiOperationId":"getLabels","summary":"Get list of all labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"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_591"}},"schemaId":"schema_591"},{"code":"401","description":"Authentication credentials are missing or invalid"}],"pointer":"/paths/~1labels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels/getlabels"}],"panels":[]}]},"httpPath":"/labels"},{"label":"Create new label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/labels/createnewlabel","routeSlug":"/openapi/scala-api.openapi/labels/createnewlabel","metadata":{"seo":{"title":"Create new label","description":"POST /v2/labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNewLabel","name":"Create new label","isWebhook":false,"pointer":"/paths/~1labels/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewLabel"}},"schemaId":"components/schemas/NewLabel","pointer":"/paths/~1labels/post/requestBody","description":"New label info"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/labels","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NewLabel"}},"responseCodes":["201","403","422"],"pointer":"/labels","href":"labels/createnewlabel","openApiOperationId":"createNewLabel","summary":"Create new label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/NewLabel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewLabel"}},"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/LabelWithSignedItems"}},"schemaId":"components/schemas/LabelWithSignedItems"},{"code":"403","description":"Duplicate name"},{"code":"422","description":"Empty name"}],"pointer":"/paths/~1labels/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/LabelWithSignedItems","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelWithSignedItems"}}},{"code":"403"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels/createnewlabel"}],"panels":[]}]},"httpPath":"/labels"},{"label":"Update existing label name","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/labels/updatelabel","routeSlug":"/openapi/scala-api.openapi/labels/updatelabel","metadata":{"seo":{"title":"Update existing label name","description":"PUT /v2/labels/{labelId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLabel","name":"Update existing label name","isWebhook":false,"pointer":"/paths/~1labels~1{labelId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update existing label name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"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":" /v2/labels/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{labelId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"labelId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1labels~1{labelId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewLabel"}},"schemaId":"components/schemas/NewLabel","pointer":"/paths/~1labels~1{labelId}/put/requestBody","description":"Updated label info"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/labels/{labelId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"labelId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NewLabel"}},"responseCodes":["200","403","404","422"],"pointer":"/labels/{labelId}","href":"labels/updatelabel","openApiOperationId":"updateLabel","summary":"Update existing label name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"schemaId":"components/schemas/NewLabel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewLabel"}},"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/LabelWithSignedItems"}},"schemaId":"components/schemas/LabelWithSignedItems"},{"code":"403","description":"Duplicate name"},{"code":"404","description":"Label with such id doesn't exist in your account"},{"code":"422","description":"Empty name"}],"pointer":"/paths/~1labels~1{labelId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LabelWithSignedItems","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LabelWithSignedItems"}}},{"code":"403"},{"code":"404"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels/updatelabel"}],"panels":[]}]},"httpPath":"/labels/{labelId}"},{"label":"Delete label with given id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scala-api.openapi/labels/deletealabel","routeSlug":"/openapi/scala-api.openapi/labels/deletealabel","metadata":{"seo":{"title":"Delete label with given id","description":"DELETE /v2/labels/{labelId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteALabel","name":"Delete label with given id","isWebhook":false,"pointer":"/paths/~1labels~1{labelId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete label with given 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":" /v2/labels/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"op-path-parameter"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{labelId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API_Key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in your requests with ObservePoint API key as header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","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":"labelId","in":"path","schemaId":"schema_568","required":true}],"pointer":"/paths/~1labels~1{labelId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/labels/{labelId}","servers":[{"url":"https://api.observepoint.com/v2"}],"parameters":{"path":[{"name":"labelId","in":"path","required":true,"schemaId":"schema_568"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API_Key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/labels/{labelId}","href":"labels/deletealabel","openApiOperationId":"deleteALabel","summary":"Delete label with given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.observepoint.com/v2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Label deleted"},{"code":"404","description":"There is no label with id labelid"}],"pointer":"/paths/~1labels~1{labelId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels/deletealabel"}],"panels":[]}]},"httpPath":"/labels/{labelId}"}],"content":{"contentType":"group","meta":{"name":"Labels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Labels","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing labels including creation, assignment, and retrieval for organizing audits, journeys, and other resources"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/labels","summary":"Get list of all labels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/labels/getlabels","deprecated":false},{"title":"/labels","summary":"Create new label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels/createnewlabel","deprecated":false},{"title":"/labels/{labelId}","summary":"Update existing label name","prefix":{"name":"put","color":"put"},"badges":[],"link":"/labels/updatelabel","deprecated":false},{"title":"/labels/{labelId}","summary":"Delete label with given id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/labels/deletealabel","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"type":"object","required":["accountType","appTestsUsed","appsUsed","auditsUsed","customProxySupport","id","maxApps","maxAudits","maxUsers","maxWebJourneys","name","strongPasswordPolicy","urlsUsed","usersUsed","vpnSupport","webJourneysUsed"],"properties":{"accountType":{"format":"int32","type":"integer"},"appTestsUsed":{"format":"int32","type":"integer"},"appsUsed":{"format":"int32","type":"integer"},"auditPageLimit":{"type":"number"},"auditsUsed":{"format":"int32","type":"integer"},"customProxySupport":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"maxApps":{"format":"int32","type":"integer"},"maxAudits":{"format":"int32","type":"integer"},"maxUsers":{"format":"int32","type":"integer"},"maxWebJourneys":{"format":"int32","type":"integer"},"name":{"type":"string"},"strongPasswordPolicy":{"type":"boolean"},"subDomainIdentifier":{"type":"string"},"urlsUsed":{"format":"int32","type":"integer"},"usersUsed":{"format":"int32","type":"integer"},"vpnSupport":{"type":"boolean"},"webJourneyRunLimit":{"type":"number"},"webJourneysUsed":{"format":"int32","type":"integer"}},"description":"Account data"}},"components/schemas/AccountCapabilities":{"id":"components/schemas/AccountCapabilities","kind":"json-schema","title":"AccountCapabilities","data":{"type":"object","required":["customProxySupport","strongPasswordPolicy","vpnSupport"],"properties":{"customProxySupport":{"type":"boolean"},"strongPasswordPolicy":{"type":"boolean"},"vpnSupport":{"type":"boolean"}}}},"components/schemas/Action":{"id":"components/schemas/Action","kind":"json-schema","title":"Action","data":{"type":"object","required":["actionType","id","name","runId","sequence"],"properties":{"actionType":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"name":{"type":"string"},"note":{"type":"string"},"runId":{"format":"int32","type":"integer"},"sequence":{"format":"int32","type":"integer"}}}},"components/schemas/ActionSwaggerReference":{"id":"components/schemas/ActionSwaggerReference","kind":"json-schema","title":"ActionSwaggerReference","data":{"type":"object","required":["preventNav","selectors"],"properties":{"action":{"enum":["navto","click","input","select","check","uncheck","execute","watch","maskedInput","enterIframe","exitIframe"],"type":"string"},"js":{"type":"string"},"label":{"type":"string"},"maskedValue":{"type":"string"},"preventNav":{"type":"boolean"},"seconds":{"format":"int32","type":"integer"},"selectors":{"items":{"$ref":"#/components/schemas/WebActionSelectorSwaggerReference"},"type":"array"},"url":{"type":"string"},"value":{"type":"string"},"waitDuration":{"format":"int32","maximum":1800,"minimum":0,"type":"integer"}}}},"components/schemas/ActionTag":{"id":"components/schemas/ActionTag","kind":"json-schema","title":"ActionTag","data":{"type":"object","required":["duplicates","invalidVariables","multiples","position","responseAt","startedAt","statusCode","stoppedAt","tag","tagInstanceId","valid","variables"],"properties":{"account":{"type":"string"},"duplicates":{"format":"int32","type":"integer"},"invalidVariables":{"items":{"type":"string"},"type":"array"},"multiples":{"format":"int32","type":"integer"},"position":{"format":"double","type":"number"},"responseAt":{"format":"int64","type":"integer"},"startedAt":{"format":"int64","type":"integer"},"statusCode":{"format":"int32","type":"integer"},"stoppedAt":{"format":"int64","type":"integer"},"tag":{"$ref":"#/components/schemas/Tag"},"tagInstanceId":{"type":"string"},"valid":{"type":"boolean"},"variables":{"items":{"$ref":"#/components/schemas/TagVariable"},"type":"array"},"version":{"type":"string"}}}},"components/schemas/ApiRuleResult":{"id":"components/schemas/ApiRuleResult","kind":"json-schema","title":"ApiRuleResult","data":{"type":"object","required":["checkTimes","name","pageFilterResults","ruleId","tagResults"],"properties":{"checkTimes":{"$ref":"#/components/schemas/CheckTimesResult"},"name":{"type":"string"},"pageFilterResults":{"items":{"$ref":"#/components/schemas/PageFilterResult"},"type":"array"},"resultType":{"enum":["Passed","Failed","NotApplied","Broken"],"type":"string"},"ruleId":{"format":"int32","type":"integer"},"tagResults":{"items":{"$ref":"#/components/schemas/TagResult"},"type":"array"}}}},"components/schemas/AttributesSelector":{"id":"components/schemas/AttributesSelector","kind":"json-schema","title":"AttributesSelector","data":{"allOf":[{"$ref":"#/components/schemas/WebActionSelectorSwaggerReference"},{"type":"object","required":["selectorType","value"],"properties":{"selectorType":{"format":"int32","type":"integer"},"value":{"$ref":"#/components/schemas/WebActionElementDescriptionSwaggerReference"}}}]}},"components/schemas/Audit":{"id":"components/schemas/Audit","kind":"json-schema","title":"Audit","data":{"type":"object","required":["created","domainId","folderId","id","labels","lastUpdated","limit","name","ownerId","queued","recipients","runs","startingUrls"],"properties":{"created":{"format":"date-time","type":"string"},"domainId":{"format":"int32","type":"integer"},"filters":{"$ref":"#/components/schemas/AuditFilters"},"folderId":{"format":"int32","type":"integer"},"frequency":{"type":"string"},"id":{"format":"int32","type":"integer"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"lastRun":{"format":"date-time","type":"string"},"lastUpdated":{"format":"date-time","type":"string"},"limit":{"format":"int32","type":"integer"},"name":{"type":"string"},"nextRun":{"format":"date-time","type":"string"},"options":{"$ref":"#/components/schemas/AuditOptions"},"ownerId":{"format":"int32","type":"integer"},"queued":{"type":"boolean"},"recipients":{"items":{"type":"string"},"type":"array"},"rules":{"items":{"$ref":"#/components/schemas/RuleDescription"},"type":"array"},"runs":{"items":{"$ref":"#/components/schemas/AuditRunSwaggerReference"},"type":"array"},"schedule":{"type":"boolean"},"screenshot":{"type":"string"},"startingUrls":{"items":{"type":"string"},"type":"array"},"taggingPlans":{"items":{"type":"number"},"type":"array"},"webAuditRunning":{"type":"number"}},"description":"Web audit model"}},"components/schemas/AuditAction":{"id":"components/schemas/AuditAction","kind":"json-schema","title":"AuditAction","data":{"type":"object","required":["action","filter"],"properties":{"action":{"$ref":"#/components/schemas/SequencedActionSwaggerReference"},"filter":{"type":"string"}}}},"components/schemas/AuditActionArray":{"id":"components/schemas/AuditActionArray","kind":"json-schema","title":"AuditActionArray","data":{"type":"object","required":["actions"],"properties":{"actions":{"items":{"$ref":"#/components/schemas/AuditActionSwaggerReference"},"type":"array"}}}},"components/schemas/AuditActionSwaggerReference":{"id":"components/schemas/AuditActionSwaggerReference","kind":"json-schema","title":"AuditActionSwaggerReference","data":{"type":"object","required":["filter","preventNav","selectors","sequence"],"properties":{"action":{"enum":["navto","click","input","select","check","uncheck","execute","watch","maskedInput","enterIframe","exitIframe"],"type":"string"},"actionId":{"type":"number"},"filter":{"type":"string"},"js":{"type":"string"},"label":{"type":"string"},"maskedValue":{"type":"string"},"preventNav":{"type":"boolean"},"rules":{"items":{"type":"number"},"type":"array"},"seconds":{"format":"int32","type":"integer"},"selectors":{"items":{"$ref":"#/components/schemas/WebActionSelectorSwaggerReference"},"type":"array"},"sequence":{"format":"int32","type":"integer"},"url":{"type":"string"},"value":{"type":"string"},"waitDuration":{"format":"int32","maximum":1800,"minimum":0,"type":"integer"}}}},"components/schemas/AuditFilters":{"id":"components/schemas/AuditFilters","kind":"json-schema","title":"AuditFilters","data":{"type":"object","required":["exclude","include"],"properties":{"exclude":{"items":{"type":"string"},"type":"array"},"include":{"items":{"$ref":"#/components/schemas/IncludeFilter"},"type":"array"}}}},"components/schemas/AuditLogin":{"id":"components/schemas/AuditLogin","kind":"json-schema","title":"AuditLogin","data":{"type":"object","required":["actions","url"],"properties":{"actions":{"items":{"$ref":"#/components/schemas/SequencedActionSwaggerReference"},"type":"array"},"url":{"type":"string"}}}},"components/schemas/AuditOptions":{"id":"components/schemas/AuditOptions","kind":"json-schema","title":"AuditOptions","data":{"type":"object","required":["fireTags","loadFlash","location","requestRate","stripQueryString","userAgent"],"properties":{"adobeAuditor":{"type":"boolean"},"blockThirdPartyCookies":{"type":"boolean"},"browserHeight":{"format":"int32","type":"integer"},"browserWidth":{"format":"int32","type":"integer"},"customHttpHeaders":{"items":{"$ref":"#/components/schemas/CustomHttpHeaderAssignment"},"type":"array"},"customProxy":{"type":"string"},"discoverSitemap":{"type":"boolean"},"fireTags":{"type":"boolean"},"gpcEnabled":{"type":"boolean"},"loadFlash":{"type":"boolean"},"location":{"type":"string"},"remoteFileMapConfig":{"items":{"$ref":"#/components/schemas/RemoteFileMapping"},"type":"array"},"requestRate":{"format":"int32","type":"integer"},"sameUrlRunId":{"type":"number"},"stripQueryString":{"type":"boolean"},"userAgent":{"type":"string"},"vpnEnabled":{"type":"boolean"},"webHookUrl":{"type":"string"}}}},"components/schemas/AuditRun":{"id":"components/schemas/AuditRun","kind":"json-schema","title":"AuditRun","data":{"type":"object","required":["adobeAuditor","id","limit","silentMode","started","supportedFeatures","taggedUrl","totalUrl","userId","webAuditId"],"properties":{"adobeAuditor":{"type":"boolean"},"completed":{"format":"date-time","type":"string"},"completedAt":{"format":"date-time","type":"string"},"id":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"score":{"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":"/v3/web-audits/{auditId}/runs/{runId}/scores"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"format":"int32","type":"integer"},"silentMode":{"type":"boolean"},"started":{"format":"date-time","type":"string"},"stoppedEarlyByUserId":{"type":"number"},"supportedFeatures":{"items":{"$ref":"#/components/schemas/FeatureWhichCanBeSupportedByAuditRun"},"type":"array"},"taggedUrl":{"format":"int32","type":"integer"},"totalUrl":{"format":"int32","type":"integer"},"userId":{"format":"int32","type":"integer"},"webAuditId":{"format":"int32","type":"integer"}}}},"components/schemas/AuditRunSwaggerReference":{"id":"components/schemas/AuditRunSwaggerReference","kind":"json-schema","title":"AuditRunSwaggerReference","data":{"type":"object","required":["adobeAuditor","id","limit","silentMode","taggedUrl","totalUrl","userId","webAuditId"],"properties":{"adobeAuditor":{"type":"boolean"},"completed":{"format":"date-time","type":"string"},"id":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"score":{"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":"/v3/web-audits/{auditId}/runs/{runId}/scores"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"format":"int32","type":"integer"},"silentMode":{"type":"boolean"},"started":{"format":"date-time","type":"string"},"supportedFeatures":{"example":"[TagLoadtimeReport, ConsoleLogsReport]","items":{"type":"string"},"type":"array"},"taggedUrl":{"format":"int32","type":"integer"},"totalUrl":{"format":"int32","type":"integer"},"userId":{"format":"int32","type":"integer"},"webAuditId":{"format":"int32","type":"integer"}}}},"components/schemas/AuditRunWithRuleFailurePresence":{"id":"components/schemas/AuditRunWithRuleFailurePresence","kind":"json-schema","title":"AuditRunWithRuleFailurePresence","data":{"type":"object","required":["adobeAuditor","id","isRuleFailurePresent","limit","score","silentMode","started","supportedFeatures","taggedUrl","totalUrl","userId","webAuditId"],"properties":{"adobeAuditor":{"type":"boolean"},"completed":{"format":"date-time","type":"string"},"completedAt":{"format":"date-time","type":"string"},"id":{"format":"int32","type":"integer"},"isRuleFailurePresent":{"type":"boolean"},"limit":{"format":"int32","type":"integer"},"score":{"format":"int32","type":"integer"},"silentMode":{"type":"boolean"},"started":{"format":"date-time","type":"string"},"supportedFeatures":{"items":{"$ref":"#/components/schemas/FeatureWhichCanBeSupportedByAuditRun"},"type":"array"},"taggedUrl":{"format":"int32","type":"integer"},"totalUrl":{"format":"int32","type":"integer"},"userId":{"format":"int32","type":"integer"},"webAuditId":{"format":"int32","type":"integer"}}}},"components/schemas/AuditUpdate":{"id":"components/schemas/AuditUpdate","kind":"json-schema","title":"AuditUpdate","data":{"type":"object","required":["domainId","id","limit","name","recipients","startingUrls"],"properties":{"domainId":{"format":"int32","type":"integer"},"filters":{"$ref":"#/components/schemas/AuditFilters"},"frequency":{"type":"string"},"id":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"name":{"type":"string"},"nextRun":{"format":"date-time","type":"string"},"options":{"$ref":"#/components/schemas/AuditOptions"},"ownerId":{"format":"int32","type":"integer"},"recipients":{"items":{"type":"string"},"type":"array"},"schedule":{"$ref":"#/components/schemas/WritableItemSchedule"},"startingUrls":{"items":{"type":"string"},"type":"array"}}}},"components/schemas/AuthToken":{"id":"components/schemas/AuthToken","kind":"json-schema","title":"AuthToken","data":{"type":"object","required":["created","decryptedToken","token","tokenType","userId"],"properties":{"created":{"type":"string"},"decryptedToken":{"type":"string"},"token":{"type":"string"},"tokenType":{"$ref":"#/components/schemas/TokenType"},"userId":{"type":"string"}}}},"components/schemas/Authorization":{"id":"components/schemas/Authorization","kind":"json-schema","title":"Authorization","data":{"type":"object","required":["login","password"],"properties":{"login":{"type":"string"},"password":{"type":"string"}}}},"components/schemas/CardScheduleData":{"id":"components/schemas/CardScheduleData","kind":"json-schema","title":"CardScheduleData","data":{"type":"object","required":["description","isPaused","presetType"],"properties":{"description":{"type":"string"},"isPaused":{"type":"boolean"},"presetType":{"$ref":"#/components/schemas/SchedulePreset"}}}},"components/schemas/Certificate":{"id":"components/schemas/Certificate","kind":"json-schema","title":"Certificate","data":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"components/schemas/CheckTimesResult":{"id":"components/schemas/CheckTimesResult","kind":"json-schema","title":"CheckTimesResult","data":{"type":"object","required":["actual","expected"],"properties":{"actual":{"format":"int32","type":"integer"},"expected":{"format":"int32","type":"integer"}}}},"components/schemas/Chronology":{"id":"components/schemas/Chronology","kind":"json-schema","title":"Chronology","data":{"type":"object","required":["zone"],"properties":{"zone":{"$ref":"#/components/schemas/DateTimeZone"}}}},"components/schemas/CustomHttpHeaderAssignment":{"id":"components/schemas/CustomHttpHeaderAssignment","kind":"json-schema","title":"CustomHttpHeaderAssignment","data":{"type":"object","required":["groupId","isApplyToAll"],"properties":{"groupId":{"format":"int64","type":"integer"},"isApplyToAll":{"type":"boolean"}}}},"components/schemas/DateTimeField":{"id":"components/schemas/DateTimeField","kind":"json-schema","title":"DateTimeField","data":{"type":"object","required":["durationField","leapDurationField","lenient","maximumValue","minimumValue","name","rangeDurationField","supported","type"],"properties":{"durationField":{"$ref":"#/components/schemas/DurationField"},"leapDurationField":{"$ref":"#/components/schemas/DurationField"},"lenient":{"type":"boolean"},"maximumValue":{"format":"int32","type":"integer"},"minimumValue":{"format":"int32","type":"integer"},"name":{"type":"string"},"rangeDurationField":{"$ref":"#/components/schemas/DurationField"},"supported":{"type":"boolean"},"type":{"$ref":"#/components/schemas/DateTimeFieldType"}}}},"components/schemas/DateTimeFieldType":{"id":"components/schemas/DateTimeFieldType","kind":"json-schema","title":"DateTimeFieldType","data":{"type":"object","required":["durationType","name","rangeDurationType"],"properties":{"durationType":{"$ref":"#/components/schemas/DurationFieldType"},"name":{"type":"string"},"rangeDurationType":{"$ref":"#/components/schemas/DurationFieldType"}}}},"components/schemas/DateTimeZone":{"id":"components/schemas/DateTimeZone","kind":"json-schema","title":"DateTimeZone","data":{"type":"object","required":["fixed","id"],"properties":{"fixed":{"type":"boolean"},"id":{"type":"string"}}}},"components/schemas/Domain":{"id":"components/schemas/Domain","kind":"json-schema","title":"Domain","data":{"type":"object","required":["accountId","createdAt","domain","folderId","id","name","userId"],"properties":{"accountId":{"format":"int32","type":"integer"},"createdAt":{"format":"date-time","type":"string"},"domain":{"type":"string"},"folderId":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"name":{"type":"string"},"totals":{"$ref":"#/components/schemas/DomainTotals"},"userId":{"format":"int32","type":"integer"}},"description":"Domain model"}},"components/schemas/DomainTotals":{"id":"components/schemas/DomainTotals","kind":"json-schema","title":"DomainTotals","data":{"type":"object","required":["auditsRunning","automatedJourneys","averageScore","errors","guidedJourneys","pages","simulationsRunning"],"properties":{"auditsRunning":{"format":"int32","type":"integer"},"automatedJourneys":{"format":"int32","type":"integer"},"averageScore":{"format":"int32","type":"integer"},"errors":{"format":"int32","type":"integer"},"guidedJourneys":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"},"simulationsRunning":{"format":"int32","type":"integer"}}}},"components/schemas/DomainUpdate":{"id":"components/schemas/DomainUpdate","kind":"json-schema","title":"DomainUpdate","data":{"type":"object","required":["domain","folderId","name"],"properties":{"dataLayer":{"type":"string"},"domain":{"type":"string"},"folderId":{"format":"int32","type":"integer"},"name":{"type":"string"}},"description":"Domain update information"}},"components/schemas/DurationField":{"id":"components/schemas/DurationField","kind":"json-schema","title":"DurationField","data":{"type":"object","required":["name","precise","supported","type","unitMillis"],"properties":{"name":{"type":"string"},"precise":{"type":"boolean"},"supported":{"type":"boolean"},"type":{"$ref":"#/components/schemas/DurationFieldType"},"unitMillis":{"format":"int64","type":"integer"}}}},"components/schemas/DurationFieldType":{"id":"components/schemas/DurationFieldType","kind":"json-schema","title":"DurationFieldType","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}},"components/schemas/EntityCount":{"id":"components/schemas/EntityCount","kind":"json-schema","title":"EntityCount","data":{"type":"object","required":["count"],"properties":{"count":{"format":"int32","type":"integer"}},"description":"Entity count"}},"components/schemas/FeatureWhichCanBeSupportedByAuditRun":{"id":"components/schemas/FeatureWhichCanBeSupportedByAuditRun","kind":"json-schema","title":"FeatureWhichCanBeSupportedByAuditRun","data":{"type":"object","required":["value"],"properties":{"value":{"type":"string"}}}},"components/schemas/FileMappingResult":{"id":"components/schemas/FileMappingResult","kind":"json-schema","title":"FileMappingResult","data":{"type":"object","required":["config","fileUrl","mappedRequests"],"properties":{"config":{"$ref":"#/components/schemas/RemoteFileMapping"},"fileUrl":{"type":"string"},"mappedRequests":{"items":{"type":"string"},"type":"array"}}}},"components/schemas/FileSizeResult":{"id":"components/schemas/FileSizeResult","kind":"json-schema","title":"FileSizeResult","data":{"type":"object","required":["size"],"properties":{"size":{"format":"int64","type":"integer"}}}},"components/schemas/FileUploadResult":{"id":"components/schemas/FileUploadResult","kind":"json-schema","title":"FileUploadResult","data":{"type":"object","required":["fileId"],"properties":{"fileId":{"type":"string"}}}},"components/schemas/Folder":{"id":"components/schemas/Folder","kind":"json-schema","title":"Folder","data":{"type":"object","required":["accountId","appFailures","appRuleFailures","appsCount","appsInQueue","appsRunning","auditsCount","auditsRunning","createdAt","createdByUserId","createdByUserName","domainsCount","id","journeysCount","name","simulationErrors","simulationsRunning"],"properties":{"accountId":{"format":"int32","type":"integer"},"appFailures":{"format":"int32","type":"integer"},"appRuleFailures":{"format":"int32","type":"integer"},"appsCount":{"format":"int32","type":"integer"},"appsInQueue":{"format":"int32","type":"integer"},"appsRunning":{"format":"int32","type":"integer"},"auditsCount":{"format":"int32","type":"integer"},"auditsRunning":{"format":"int32","type":"integer"},"createdAt":{"format":"date-time","type":"string"},"createdByUserId":{"format":"int32","type":"integer"},"createdByUserName":{"type":"string"},"domainsCount":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"journeysCount":{"format":"int32","type":"integer"},"name":{"type":"string"},"simulationErrors":{"format":"int32","type":"integer"},"simulationsRunning":{"format":"int32","type":"integer"}},"description":"Folder model"}},"components/schemas/Function1":{"id":"components/schemas/Function1","kind":"json-schema","title":"Function1","data":{"type":"object"}},"components/schemas/Function1RequestContextFutureRouteResult":{"id":"components/schemas/Function1RequestContextFutureRouteResult","kind":"json-schema","title":"Function1RequestContextFutureRouteResult","data":{"type":"object"}},"components/schemas/GeneratedAction":{"id":"components/schemas/GeneratedAction","kind":"json-schema","title":"GeneratedAction","data":{"type":"object","required":["action","timestamp"],"properties":{"action":{"$ref":"#/components/schemas/ActionSwaggerReference"},"timestamp":{"format":"int64","type":"integer"}}}},"components/schemas/HarJourneyRunCreateRequest":{"id":"components/schemas/HarJourneyRunCreateRequest","kind":"json-schema","title":"HarJourneyRunCreateRequest","data":{"type":"object","required":["harFiles"],"properties":{"harFiles":{"items":{"$ref":"#/components/schemas/UploadedHarFile"},"type":"array"},"journeyRunName":{"type":"string"},"webhookUrl":{"type":"string"}},"description":"Model for creation of live connect run based on har files"}},"components/schemas/IncludeFilter":{"id":"components/schemas/IncludeFilter","kind":"json-schema","title":"IncludeFilter","data":{"type":"object","required":["includeLimit","value"],"properties":{"includeLimit":{"format":"int32","type":"integer"},"value":{"type":"string"}}}},"components/schemas/InitializedJourney":{"id":"components/schemas/InitializedJourney","kind":"json-schema","title":"InitializedJourney","data":{"type":"object","required":["journeyId","name","proxyInfo","runId"],"properties":{"certificate":{"$ref":"#/components/schemas/Certificate"},"journeyId":{"format":"int32","type":"integer"},"name":{"type":"string"},"proxyInfo":{"$ref":"#/components/schemas/ProxyInfo"},"runId":{"format":"int32","type":"integer"}}}},"components/schemas/ItemIsRunningApiError":{"id":"components/schemas/ItemIsRunningApiError","kind":"json-schema","title":"ItemIsRunningApiError","data":{"type":"object","required":["errorCode","message","runId"],"properties":{"errorCode":{"format":"int32","type":"integer"},"message":{"type":"string"},"runId":{"format":"int64","type":"integer"}}}},"components/schemas/ItemWithActiveRun":{"id":"components/schemas/ItemWithActiveRun","kind":"json-schema","title":"ItemWithActiveRun","data":{"type":"object","required":["itemId","itemName","itemType","runId"],"properties":{"itemId":{"format":"int64","type":"integer"},"itemName":{"type":"string"},"itemType":{"type":"string"},"runId":{"format":"int64","type":"integer"}}}},"components/schemas/ItemsAreRunningApiError":{"id":"components/schemas/ItemsAreRunningApiError","kind":"json-schema","title":"ItemsAreRunningApiError","data":{"type":"object","required":["errorCode","items","message"],"properties":{"errorCode":{"format":"int32","type":"integer"},"items":{"items":{"$ref":"#/components/schemas/ItemWithActiveRun"},"type":"array"},"message":{"type":"string"}}}},"components/schemas/Journey":{"id":"components/schemas/Journey","kind":"json-schema","title":"Journey","data":{"type":"object","required":["createdAt","emails","folderId","id","name","osOfDevice","updatedAt","userId","versionOfOs"],"properties":{"createdAt":{"format":"date-time","type":"string"},"emails":{"items":{"type":"string"},"type":"array"},"folderId":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"journeyType":{"format":"int32","type":"integer"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"name":{"type":"string"},"osOfDevice":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"},"userId":{"format":"int32","type":"integer"},"versionOfOs":{"type":"string"}}}},"components/schemas/JourneyRequest":{"id":"components/schemas/JourneyRequest","kind":"json-schema","title":"JourneyRequest","data":{"type":"object","required":["emails","folderId","name","osOfDevice","versionOfOs"],"properties":{"emails":{"items":{"type":"string"},"type":"array"},"folderId":{"format":"int32","type":"integer"},"journeyType":{"format":"int32","type":"integer"},"name":{"type":"string"},"osOfDevice":{"type":"string"},"versionOfOs":{"type":"string"}}}},"components/schemas/JourneyRun":{"id":"components/schemas/JourneyRun","kind":"json-schema","title":"JourneyRun","data":{"type":"object","required":["id","journeyId","manageSSL","name","osOfDevice","requestedAt","status","versionOfOs"],"properties":{"certificate":{"$ref":"#/components/schemas/Certificate"},"completedAt":{"format":"date-time","type":"string"},"id":{"format":"int32","type":"integer"},"journeyId":{"format":"int32","type":"integer"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"manageSSL":{"type":"boolean"},"name":{"type":"string"},"osOfDevice":{"type":"string"},"proxyInfo":{"type":"string"},"requestedAt":{"format":"date-time","type":"string"},"rulesDetails":{"$ref":"#/components/schemas/RunRuleDetails"},"startedAt":{"format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/Value"},"versionOfOs":{"type":"string"}}}},"components/schemas/Label":{"id":"components/schemas/Label","kind":"json-schema","title":"Label","data":{"type":"object","required":["id","name"],"properties":{"id":{"format":"int32","type":"integer"},"name":{"type":"string"}}}},"components/schemas/LabelId":{"id":"components/schemas/LabelId","kind":"json-schema","title":"LabelId","data":{"type":"object","required":["id"],"properties":{"id":{"format":"int32","type":"integer"}}}},"components/schemas/LabelWithSignedItems":{"id":"components/schemas/LabelWithSignedItems","kind":"json-schema","title":"LabelWithSignedItems","data":{"type":"object","required":["alerts","audits","consentCategories","emailInboxes","id","mobileJourney","name","rules","savedReports","webJourney"],"properties":{"alerts":{"items":{"type":"number"},"type":"array"},"audits":{"items":{"type":"number"},"type":"array"},"consentCategories":{"items":{"type":"number"},"type":"array"},"emailInboxes":{"items":{"type":"number"},"type":"array"},"id":{"format":"int32","type":"integer"},"mobileJourney":{"items":{"type":"number"},"type":"array"},"name":{"type":"string"},"rules":{"items":{"type":"number"},"type":"array"},"savedReports":{"items":{"type":"number"},"type":"array"},"webJourney":{"items":{"type":"number"},"type":"array"}},"description":"Label with all items to which it was assigned"}},"components/schemas/LocalDateTime":{"id":"components/schemas/LocalDateTime","kind":"json-schema","title":"LocalDateTime","data":{"type":"object","required":["centuryOfEra","chronology","dayOfMonth","dayOfWeek","dayOfYear","era","fieldTypes","fields","hourOfDay","millisOfDay","millisOfSecond","minuteOfHour","monthOfYear","secondOfMinute","values","weekOfWeekyear","weekyear","year","yearOfCentury","yearOfEra"],"properties":{"centuryOfEra":{"format":"int32","type":"integer"},"chronology":{"$ref":"#/components/schemas/Chronology"},"dayOfMonth":{"format":"int32","type":"integer"},"dayOfWeek":{"format":"int32","type":"integer"},"dayOfYear":{"format":"int32","type":"integer"},"era":{"format":"int32","type":"integer"},"fieldTypes":{"items":{"$ref":"#/components/schemas/DateTimeFieldType"},"type":"array"},"fields":{"items":{"$ref":"#/components/schemas/DateTimeField"},"type":"array"},"hourOfDay":{"format":"int32","type":"integer"},"millisOfDay":{"format":"int32","type":"integer"},"millisOfSecond":{"format":"int32","type":"integer"},"minuteOfHour":{"format":"int32","type":"integer"},"monthOfYear":{"format":"int32","type":"integer"},"secondOfMinute":{"format":"int32","type":"integer"},"values":{"items":{"format":"int32","type":"integer"},"type":"array"},"weekOfWeekyear":{"format":"int32","type":"integer"},"weekyear":{"format":"int32","type":"integer"},"year":{"format":"int32","type":"integer"},"yearOfCentury":{"format":"int32","type":"integer"},"yearOfEra":{"format":"int32","type":"integer"}}}},"components/schemas/Location":{"id":"components/schemas/Location","kind":"json-schema","title":"Location","data":{"type":"object","required":["countryCode","id","label","name"],"properties":{"countryCode":{"type":"string"},"id":{"format":"int32","type":"integer"},"label":{"type":"string"},"name":{"type":"string"}}}},"components/schemas/NewAudit":{"id":"components/schemas/NewAudit","kind":"json-schema","title":"NewAudit","data":{"type":"object","required":["domainId","limit","name","recipients","startingUrls"],"properties":{"domainId":{"format":"int32","type":"integer"},"filters":{"$ref":"#/components/schemas/AuditFilters"},"frequency":{"type":"string"},"limit":{"format":"int32","type":"integer"},"name":{"type":"string"},"nextRun":{"format":"date-time","type":"string"},"options":{"$ref":"#/components/schemas/AuditOptions"},"recipients":{"items":{"type":"string"},"type":"array"},"schedule":{"$ref":"#/components/schemas/WritableItemSchedule"},"startingUrls":{"items":{"type":"string"},"type":"array"}}}},"components/schemas/NewDomain":{"id":"components/schemas/NewDomain","kind":"json-schema","title":"NewDomain","data":{"type":"object","required":["domain","folderId","name"],"properties":{"dataLayer":{"type":"string"},"domain":{"type":"string"},"folderId":{"format":"int32","type":"integer"},"name":{"type":"string"}},"description":"Domain creation information"}},"components/schemas/NewFolder":{"id":"components/schemas/NewFolder","kind":"json-schema","title":"NewFolder","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"description":"Folder create information"}},"components/schemas/NewLabel":{"id":"components/schemas/NewLabel","kind":"json-schema","title":"NewLabel","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"description":"Label creation information"}},"components/schemas/NewPageFilter":{"id":"components/schemas/NewPageFilter","kind":"json-schema","title":"NewPageFilter","data":{"type":"object","properties":{"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"ruleId":{"format":"int32","type":"integer"},"type":{"description":"1 - url, 2 - status code, 3 - final url, 4 - final status code","enum":[1,2,3,4],"format":"int32","type":"integer"},"value":{"type":"string"}}}},"components/schemas/NewRule":{"id":"components/schemas/NewRule","kind":"json-schema","title":"NewRule","data":{"type":"object","required":["checkTimes","matchAllFilters","name"],"properties":{"checkTimes":{"format":"int32","type":"integer"},"isDefaultRule":{"type":"number"},"labels":{"items":{"$ref":"#/components/schemas/LabelId"},"type":"array"},"matchAllFilters":{"type":"boolean"},"name":{"type":"string"},"notes":{"type":"string"},"pageFilters":{"items":{"$ref":"#/components/schemas/NewPageFilter"},"type":"array"},"recipients":{"items":{"type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/NewRuleTag"},"type":"array"}},"description":"Rule create information"}},"components/schemas/NewRuleTag":{"id":"components/schemas/NewRuleTag","kind":"json-schema","title":"NewRuleTag","data":{"type":"object","required":["tagId"],"properties":{"account":{"type":"string"},"clause":{"enum":["If","Then","Else"],"type":"string"},"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"ruleId":{"format":"int32","type":"integer"},"statusCode":{"$ref":"#/components/schemas/RuleTagStatusCode"},"tagId":{"format":"int32","type":"integer"},"validationDescription":{"type":"string"},"variables":{"items":{"$ref":"#/components/schemas/NewRuleTagVariable"},"type":"array"}}}},"components/schemas/NewRuleTagVariable":{"id":"components/schemas/NewRuleTagVariable","kind":"json-schema","title":"NewRuleTagVariable","data":{"type":"object","required":["variable"],"properties":{"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"ruleTagId":{"format":"int32","type":"integer"},"selectorType":{"enum":["String","UrlParameter","DataLayer","Tag","FinalUrlParameter"],"type":"string"},"validationDescription":{"type":"string"},"value":{"type":"string"},"valueTagId":{"format":"int32","type":"integer"},"variable":{"type":"string"}}}},"components/schemas/Option":{"id":"components/schemas/Option","kind":"json-schema","title":"Option","data":{"type":"object","required":["defined","empty"],"properties":{"defined":{"type":"boolean"},"empty":{"type":"boolean"}}}},"components/schemas/OptionPagination":{"id":"components/schemas/OptionPagination","kind":"json-schema","title":"OptionPagination","data":{"type":"object","required":["defined","empty"],"properties":{"defined":{"type":"boolean"},"empty":{"type":"boolean"}}}},"components/schemas/PageFilter":{"id":"components/schemas/PageFilter","kind":"json-schema","title":"PageFilter","data":{"type":"object","required":["id","ruleId"],"properties":{"id":{"format":"int32","type":"integer"},"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"ruleId":{"format":"int32","type":"integer"},"type":{"description":"1 - url, 2 - status code, 3 - final url, 4 - final status code","enum":[1,2,3,4],"format":"int32","type":"integer"},"value":{"type":"string"}}}},"components/schemas/PageFilterResult":{"id":"components/schemas/PageFilterResult","kind":"json-schema","title":"PageFilterResult","data":{"type":"object","required":["actual","expected"],"properties":{"actual":{"type":"string"},"expected":{"type":"string"},"filterType":{"enum":["Url","StatusCode","FinalUrl","FinalStatusCode"],"type":"string"},"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"}}}},"components/schemas/PageInfo":{"id":"components/schemas/PageInfo","kind":"json-schema","title":"PageInfo","data":{"type":"object","required":["loadtime","size","statusCode","url"],"properties":{"loadtime":{"format":"int32","type":"integer"},"size":{"format":"int32","type":"integer"},"statusCode":{"format":"int32","type":"integer"},"url":{"type":"string"}}}},"components/schemas/PageRuleResult":{"id":"components/schemas/PageRuleResult","kind":"json-schema","title":"PageRuleResult","data":{"type":"object","required":["name","noOfChecks","pageFilterResults","ruleId","tagResults"],"properties":{"name":{"type":"string"},"noOfChecks":{"$ref":"#/components/schemas/CheckTimesResult"},"pageFilterResults":{"items":{"$ref":"#/components/schemas/PageFilterResult"},"type":"array"},"resultType":{"enum":["Passed","Failed","NotApplied","Broken"],"type":"string"},"ruleId":{"format":"int32","type":"integer"},"tagResults":{"items":{"$ref":"#/components/schemas/PageTagResult"},"type":"array"}}}},"components/schemas/PageRuleResultTag":{"id":"components/schemas/PageRuleResultTag","kind":"json-schema","title":"PageRuleResultTag","data":{"type":"object","required":["id","name","variables"],"properties":{"id":{"format":"int32","type":"integer"},"name":{"type":"string"},"tagAccount":{"type":"string"},"tagAccountMatchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"variables":{"items":{"$ref":"#/components/schemas/TagVariableResult"},"type":"array"}}}},"components/schemas/PageRuleResults":{"id":"components/schemas/PageRuleResults","kind":"json-schema","title":"PageRuleResults","data":{"type":"object","required":["results","summary"],"properties":{"results":{"items":{"$ref":"#/components/schemas/PageRuleResult"},"type":"array"},"summary":{"$ref":"#/components/schemas/PageRuleResultsSummary"}}}},"components/schemas/PageRuleResultsSummary":{"id":"components/schemas/PageRuleResultsSummary","kind":"json-schema","title":"PageRuleResultsSummary","data":{"type":"object","required":["totalNoOfRulesApplied","totalNoOfRulesFailed","totalNoOfRulesNotApplied","totalNoOfRulesPassed"],"properties":{"totalNoOfRulesApplied":{"format":"int32","type":"integer"},"totalNoOfRulesFailed":{"format":"int32","type":"integer"},"totalNoOfRulesNotApplied":{"format":"int32","type":"integer"},"totalNoOfRulesPassed":{"format":"int32","type":"integer"}}}},"components/schemas/PageTagResult":{"id":"components/schemas/PageTagResult","kind":"json-schema","title":"PageTagResult","data":{"type":"object","required":["conditionId","tag"],"properties":{"conditionId":{"format":"int32","type":"integer"},"resultType":{"enum":["Passed","TagMissing","IncorrectVariables"],"type":"string"},"tag":{"$ref":"#/components/schemas/PageRuleResultTag"}}}},"components/schemas/Pagination":{"id":"components/schemas/Pagination","kind":"json-schema","title":"Pagination","data":{"type":"object","required":["limit","offset"],"properties":{"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"}}}},"components/schemas/Permissions":{"id":"components/schemas/Permissions","kind":"json-schema","title":"Permissions","data":{"type":"object","required":["intValue","stringValue"],"properties":{"intValue":{"format":"int32","type":"integer"},"stringValue":{"type":"string"}}}},"components/schemas/ProxyInfo":{"id":"components/schemas/ProxyInfo","kind":"json-schema","title":"ProxyInfo","data":{"type":"object","required":["interface","port"],"properties":{"authorization":{"$ref":"#/components/schemas/Authorization"},"interface":{"type":"string"},"port":{"format":"int32","type":"integer"}}}},"components/schemas/RemoteFileMapping":{"id":"components/schemas/RemoteFileMapping","kind":"json-schema","title":"RemoteFileMapping","data":{"type":"object","required":["matchType","matchValue"],"properties":{"createdAt":{"format":"date-time","type":"string"},"createdBy":{"format":"int32","type":"integer"},"fileId":{"format":"int32","type":"integer"},"fileUrl":{"type":"string"},"id":{"format":"int32","type":"integer"},"matchType":{"enum":["[equals","regex]"],"type":"string"},"matchValue":{"type":"string"},"name":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"},"updatedBy":{"format":"int32","type":"integer"}}}},"components/schemas/RequestLog":{"id":"components/schemas/RequestLog","kind":"json-schema","title":"RequestLog","data":{"type":"object","required":["enabledSsl","id","journeyTagIds","requestInfo","requestLog","responseInfo","stepId","timestamp"],"properties":{"enabledSsl":{"type":"boolean"},"id":{"type":"string"},"journeyTagIds":{"items":{"type":"string"},"type":"array"},"requestInfo":{"items":{"$ref":"#/components/schemas/RequestLogProperty"},"type":"array"},"requestLog":{"type":"string"},"responseInfo":{"items":{"$ref":"#/components/schemas/RequestLogProperty"},"type":"array"},"stepId":{"format":"int32","type":"integer"},"timestamp":{"format":"int64","type":"integer"}}}},"components/schemas/RequestLogProperty":{"id":"components/schemas/RequestLogProperty","kind":"json-schema","title":"RequestLogProperty","data":{"type":"object","required":["propName","propValue"],"properties":{"propName":{"type":"string"},"propValue":{"type":"string"}}}},"components/schemas/Rule":{"id":"components/schemas/Rule","kind":"json-schema","title":"Rule","data":{"type":"object","required":["accountId","checkTimes","createdAt","createdBy","fromTemplate","id","isDefaultRule","matchAllFilters","name","updatedAt"],"properties":{"accountId":{"format":"int32","type":"integer"},"checkTimes":{"format":"int32","type":"integer"},"createdAt":{"format":"date-time","type":"string"},"createdBy":{"format":"int32","type":"integer"},"fromTemplate":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"isDefaultRule":{"type":"boolean"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"matchAllFilters":{"type":"boolean"},"name":{"type":"string"},"notes":{"type":"string"},"pageFilters":{"items":{"$ref":"#/components/schemas/PageFilter"},"type":"array"},"recipients":{"items":{"type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/RuleTag"},"type":"array"},"updatedAt":{"format":"date-time","type":"string"}},"description":"Rule model"}},"components/schemas/RuleDescription":{"id":"components/schemas/RuleDescription","kind":"json-schema","title":"RuleDescription","data":{"type":"object","required":["accountId","checkTimes","createdAt","id","matchAllFilters","name","updatedAt"],"properties":{"accountId":{"format":"int32","type":"integer"},"checkTimes":{"format":"int32","type":"integer"},"createdAt":{"format":"date-time","type":"string"},"id":{"format":"int32","type":"integer"},"matchAllFilters":{"type":"boolean"},"name":{"type":"string"},"recipients":{"items":{"type":"string"},"type":"array"},"updatedAt":{"format":"date-time","type":"string"}}}},"components/schemas/RulePreview":{"id":"components/schemas/RulePreview","kind":"json-schema","title":"RulePreview","data":{"type":"object","required":["id","isDefaultRule","labels","name"],"properties":{"id":{"format":"int32","type":"integer"},"isDefaultRule":{"type":"boolean"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"name":{"type":"string"}},"description":"Rule preview model"}},"components/schemas/RuleResultOverview":{"id":"components/schemas/RuleResultOverview","kind":"json-schema","title":"RuleResultOverview","data":{"type":"object","required":["broken","failed","notApplied","passed"],"properties":{"broken":{"format":"int32","type":"integer"},"failed":{"format":"int32","type":"integer"},"notApplied":{"format":"int32","type":"integer"},"passed":{"format":"int32","type":"integer"}}}},"components/schemas/RuleResultTag":{"id":"components/schemas/RuleResultTag","kind":"json-schema","title":"RuleResultTag","data":{"type":"object","required":["id","name"],"properties":{"id":{"format":"int32","type":"integer"},"name":{"type":"string"}}}},"components/schemas/RuleTag":{"id":"components/schemas/RuleTag","kind":"json-schema","title":"RuleTag","data":{"type":"object","required":["id","ruleId","tagId"],"properties":{"account":{"type":"string"},"clause":{"enum":["If","Then","Else"],"type":"string"},"id":{"format":"int32","type":"integer"},"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"ruleId":{"format":"int32","type":"integer"},"statusCode":{"$ref":"#/components/schemas/RuleTagStatusCode"},"tagId":{"format":"int32","type":"integer"},"validationDescription":{"type":"string"},"variables":{"items":{"$ref":"#/components/schemas/RuleTagVariable"},"type":"array"}}}},"components/schemas/RuleTagStatusCode":{"id":"components/schemas/RuleTagStatusCode","kind":"json-schema","title":"RuleTagStatusCode","data":{"type":"object","properties":{"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"value":{"format":"int32","type":"integer"},"valueType":{"enum":["Specific","SuccessAndRedirect","Broken"],"type":"string"}}}},"components/schemas/RuleTagVariable":{"id":"components/schemas/RuleTagVariable","kind":"json-schema","title":"RuleTagVariable","data":{"type":"object","required":["id","ruleTagId","variable"],"properties":{"id":{"format":"int32","type":"integer"},"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"ruleTagId":{"format":"int32","type":"integer"},"selectorType":{"enum":["String","UrlParameter","DataLayer","Tag","FinalUrlParameter"],"type":"string"},"validationDescription":{"type":"string"},"value":{"type":"string"},"valueTagId":{"format":"int32","type":"integer"},"variable":{"type":"string"}}}},"components/schemas/RunRuleDetails":{"id":"components/schemas/RunRuleDetails","kind":"json-schema","title":"RunRuleDetails","data":{"type":"object","required":["actionRuleOverview","globalRuleOverview"],"properties":{"actionRuleOverview":{"$ref":"#/components/schemas/RuleResultOverview"},"globalRuleOverview":{"$ref":"#/components/schemas/RuleResultOverview"}}}},"components/schemas/SchedulePreset":{"id":"components/schemas/SchedulePreset","kind":"json-schema","title":"SchedulePreset","data":{"type":"object"}},"components/schemas/ScriptServicesCounts":{"id":"components/schemas/ScriptServicesCounts","kind":"json-schema","title":"ScriptServicesCounts","data":{"type":"object","required":["journeyFixes","maxMonitoredJourneys","usedMonitoredJourneys"],"properties":{"journeyFixes":{"format":"int32","type":"integer"},"maxMonitoredJourneys":{"format":"int32","type":"integer"},"usedMonitoredJourneys":{"format":"int32","type":"integer"}}}},"components/schemas/SearchAppDomain":{"id":"components/schemas/SearchAppDomain","kind":"json-schema","title":"SearchAppDomain","data":{"type":"object","required":["folderId","folderName","id","name"],"properties":{"folderId":{"format":"int64","type":"integer"},"folderName":{"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"}},"description":"Found domains"}},"components/schemas/SearchFolder":{"id":"components/schemas/SearchFolder","kind":"json-schema","title":"SearchFolder","data":{"type":"object","required":["id","name"],"properties":{"id":{"format":"int64","type":"integer"},"name":{"type":"string"}},"description":"Found folders"}},"components/schemas/SearchJourney":{"id":"components/schemas/SearchJourney","kind":"json-schema","title":"SearchJourney","data":{"type":"object","required":["domainId","domainName","folderId","folderName","id","name","runId"],"properties":{"domainId":{"format":"int64","type":"integer"},"domainName":{"type":"string"},"folderId":{"format":"int64","type":"integer"},"folderName":{"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"},"runId":{"format":"int64","type":"integer"}},"description":"Found web journeys"}},"components/schemas/SearchResult":{"id":"components/schemas/SearchResult","kind":"json-schema","title":"SearchResult","data":{"type":"object","required":["audits","domains","folders","webJourneys"],"properties":{"audits":{"items":{"$ref":"#/components/schemas/SearchJourney"},"type":"array"},"domains":{"items":{"$ref":"#/components/schemas/SearchAppDomain"},"type":"array"},"folders":{"items":{"$ref":"#/components/schemas/SearchFolder"},"type":"array"},"webJourneys":{"items":{"$ref":"#/components/schemas/SearchJourney"},"type":"array"}},"description":"Global search results"}},"components/schemas/SeqObject":{"id":"components/schemas/SeqObject","kind":"json-schema","title":"SeqObject","data":{"type":"object","required":["empty","traversableAgain"],"properties":{"empty":{"type":"boolean"},"traversableAgain":{"type":"boolean"}}}},"components/schemas/SeqSequencedAction":{"id":"components/schemas/SeqSequencedAction","kind":"json-schema","title":"SeqSequencedAction","data":{"type":"object","required":["empty","traversableAgain"],"properties":{"empty":{"type":"boolean"},"traversableAgain":{"type":"boolean"}}}},"components/schemas/SeqString":{"id":"components/schemas/SeqString","kind":"json-schema","title":"SeqString","data":{"type":"object","required":["empty","traversableAgain"],"properties":{"empty":{"type":"boolean"},"traversableAgain":{"type":"boolean"}}}},"components/schemas/SeqValue":{"id":"components/schemas/SeqValue","kind":"json-schema","title":"SeqValue","data":{"type":"object","required":["empty","traversableAgain"],"properties":{"empty":{"type":"boolean"},"traversableAgain":{"type":"boolean"}}}},"components/schemas/SequencedAction":{"id":"components/schemas/SequencedAction","kind":"json-schema","title":"SequencedAction","data":{"type":"object","required":["action","sequence"],"properties":{"action":{"$ref":"#/components/schemas/ActionSwaggerReference"},"actionId":{"type":"number"},"rules":{"items":{"type":"number"},"type":"array"},"sequence":{"format":"int32","type":"integer"}}}},"components/schemas/SequencedActionSwaggerReference":{"id":"components/schemas/SequencedActionSwaggerReference","kind":"json-schema","title":"SequencedActionSwaggerReference","data":{"type":"object","required":["preventNav","selectors","sequence"],"properties":{"action":{"enum":["navto","click","input","select","check","uncheck","execute","watch","maskedInput","enterIframe","exitIframe"],"type":"string"},"actionId":{"type":"number"},"js":{"type":"string"},"label":{"type":"string"},"maskedValue":{"type":"string"},"preventNav":{"type":"boolean"},"rules":{"items":{"type":"number"},"type":"array"},"seconds":{"format":"int32","type":"integer"},"selectors":{"items":{"$ref":"#/components/schemas/WebActionSelectorSwaggerReference"},"type":"array"},"sequence":{"format":"int32","type":"integer"},"url":{"type":"string"},"value":{"type":"string"},"waitDuration":{"format":"int32","maximum":1800,"minimum":0,"type":"integer"}}}},"components/schemas/SimpleSelector":{"id":"components/schemas/SimpleSelector","kind":"json-schema","title":"SimpleSelector","data":{"allOf":[{"$ref":"#/components/schemas/WebActionSelectorSwaggerReference"},{"type":"object","required":["selectorType","value"],"properties":{"selectorType":{"format":"int32","type":"integer"},"value":{"type":"string"}}}]}},"components/schemas/SnowflakeUsage":{"id":"components/schemas/SnowflakeUsage","kind":"json-schema","title":"SnowflakeUsage","data":{"type":"object","required":["useForAdobeAuditor","useForAppJourneyRuleResults","useForAppJourneys","useForAudits","useForLiveConnect","useForLiveConnectRuleResults","useForWebJourneyRuleResults","useForWebJourneys","used"],"properties":{"useForAdobeAuditor":{"type":"boolean"},"useForAppJourneyRuleResults":{"type":"boolean"},"useForAppJourneys":{"type":"boolean"},"useForAudits":{"type":"boolean"},"useForLiveConnect":{"type":"boolean"},"useForLiveConnectRuleResults":{"type":"boolean"},"useForWebJourneyRuleResults":{"type":"boolean"},"useForWebJourneys":{"type":"boolean"},"used":{"type":"boolean"}}}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"type":"object","required":["category","duplicateScoring","icon","id","name"],"properties":{"category":{"$ref":"#/components/schemas/TagCategory"},"duplicateScoring":{"type":"boolean"},"icon":{"description":"Tag icon URI","type":"string"},"id":{"format":"int32","type":"integer"},"name":{"type":"string"},"numSignatures":{"type":"number"},"numVariables":{"type":"number"},"type":{"$ref":"#/components/schemas/TagType"},"vendor":{"$ref":"#/components/schemas/TagVendor"}},"description":"Tag data"}},"components/schemas/TagCategory":{"id":"components/schemas/TagCategory","kind":"json-schema","title":"TagCategory","data":{"type":"object","required":["id","name"],"properties":{"id":{"format":"int32","type":"integer"},"name":{"type":"string"}},"description":"Tag category data"}},"components/schemas/TagResult":{"id":"components/schemas/TagResult","kind":"json-schema","title":"TagResult","data":{"type":"object","required":["conditionId","tag","variables"],"properties":{"conditionId":{"format":"int32","type":"integer"},"resultType":{"enum":["Passed","TagMissing","IncorrectVariables"],"type":"string"},"tag":{"$ref":"#/components/schemas/RuleResultTag"},"tagAccount":{"type":"string"},"tagAccountMatchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"variables":{"items":{"$ref":"#/components/schemas/TagVariableResult"},"type":"array"}}}},"components/schemas/TagType":{"id":"components/schemas/TagType","kind":"json-schema","title":"TagType","data":{"type":"object"}},"components/schemas/TagVariable":{"id":"components/schemas/TagVariable","kind":"json-schema","title":"TagVariable","data":{"type":"object","required":["name","value"],"properties":{"description":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"components/schemas/TagVariableResult":{"id":"components/schemas/TagVariableResult","kind":"json-schema","title":"TagVariableResult","data":{"type":"object","required":["expectedValues","snapshotId"],"properties":{"actualValue":{"type":"string"},"expectedParamName":{"type":"string"},"expectedValues":{"items":{"type":"string"},"type":"array","uniqueItems":true},"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"name":{"type":"string"},"resultType":{"enum":["Passed","MissingVariable","BadValue"],"type":"string"},"selectorType":{"enum":["String","UrlParameter","DataLayer","Tag","FinalUrlParameter"],"type":"string"},"snapshotId":{"format":"int64","type":"integer"},"variableTag":{"$ref":"#/components/schemas/RuleResultTag"}}}},"components/schemas/TagVendor":{"id":"components/schemas/TagVendor","kind":"json-schema","title":"TagVendor","data":{"type":"object","required":["id","name"],"properties":{"id":{"format":"int32","type":"integer"},"name":{"type":"string"}}}},"components/schemas/TokenType":{"id":"components/schemas/TokenType","kind":"json-schema","title":"TokenType","data":{"type":"object"}},"components/schemas/UpdateFolder":{"id":"components/schemas/UpdateFolder","kind":"json-schema","title":"UpdateFolder","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"description":"Folder update information"}},"components/schemas/UpdatePageFilter":{"id":"components/schemas/UpdatePageFilter","kind":"json-schema","title":"UpdatePageFilter","data":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"ruleId":{"format":"int32","type":"integer"},"type":{"description":"1 - url, 2 - status code, 3 - final url, 4 - final status code","enum":[1,2,3,4],"format":"int32","type":"integer"},"value":{"type":"string"}}}},"components/schemas/UpdateRule":{"id":"components/schemas/UpdateRule","kind":"json-schema","title":"UpdateRule","data":{"type":"object","required":["checkTimes","matchAllFilters","name"],"properties":{"checkTimes":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"isDefaultRule":{"type":"number"},"labels":{"items":{"$ref":"#/components/schemas/LabelId"},"type":"array"},"matchAllFilters":{"type":"boolean"},"name":{"type":"string"},"notes":{"type":"string"},"pageFilters":{"items":{"$ref":"#/components/schemas/UpdatePageFilter"},"type":"array"},"recipients":{"items":{"type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/UpdateRuleTag"},"type":"array"}},"description":"Rule update information"}},"components/schemas/UpdateRuleTag":{"id":"components/schemas/UpdateRuleTag","kind":"json-schema","title":"UpdateRuleTag","data":{"type":"object","required":["tagId"],"properties":{"account":{"type":"string"},"clause":{"enum":["If","Then","Else"],"type":"string"},"id":{"format":"int32","type":"integer"},"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"ruleId":{"format":"int32","type":"integer"},"statusCode":{"$ref":"#/components/schemas/RuleTagStatusCode"},"tagId":{"format":"int32","type":"integer"},"validationDescription":{"type":"string"},"variables":{"items":{"$ref":"#/components/schemas/UpdateRuleTagVariable"},"type":"array"}}}},"components/schemas/UpdateRuleTagVariable":{"id":"components/schemas/UpdateRuleTagVariable","kind":"json-schema","title":"UpdateRuleTagVariable","data":{"type":"object","required":["variable"],"properties":{"id":{"format":"int32","type":"integer"},"matchType":{"enum":["Equals","DoesNotEqual","Contains","DoesNotContain","Regex","IsSet","IsNotSet","GreaterThanOrEqualTo","LessThanOrEqualTo"],"type":"string"},"ruleTagId":{"format":"int32","type":"integer"},"selectorType":{"enum":["String","UrlParameter","DataLayer","Tag","FinalUrlParameter"],"type":"string"},"validationDescription":{"type":"string"},"value":{"type":"string"},"valueTagId":{"format":"int32","type":"integer"},"variable":{"type":"string"}}}},"components/schemas/UploadedHarFile":{"id":"components/schemas/UploadedHarFile","kind":"json-schema","title":"UploadedHarFile","data":{"type":"object","required":["s3Key"],"properties":{"name":{"type":"string"},"s3Key":{"type":"string"}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":"object","required":["accountId","created","email","firstName","fullUsageDashboardAccess","id","lastName","maxPagesPerAudit","timezone","updated","username"],"properties":{"accountId":{"format":"int32","type":"integer"},"created":{"format":"date-time","type":"string"},"deleted":{"description":"ISO 8601 date time string with offset when user was deleted, null if not deleted","type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"fullUsageDashboardAccess":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"lastLogin":{"format":"date-time","type":"string"},"lastName":{"type":"string"},"maxPagesPerAudit":{"format":"int32","type":"integer"},"permissions":{"enum":["guest","user","admin"],"type":"string"},"timezone":{"type":"string"},"updated":{"format":"date-time","type":"string"},"username":{"type":"string"}},"description":"User model"}},"components/schemas/UserAction":{"id":"components/schemas/UserAction","kind":"json-schema","title":"UserAction","data":{"type":"object"}},"components/schemas/UserAgent":{"id":"components/schemas/UserAgent","kind":"json-schema","title":"UserAgent","data":{"type":"object","required":["label","name"],"properties":{"label":{"type":"string"},"name":{"type":"string"}}}},"components/schemas/UserContext":{"id":"components/schemas/UserContext","kind":"json-schema","title":"UserContext","data":{"type":"object","required":["accountId","accountStatus","accountType","capabilities","credsExpired","email","features","id","isAccountActive","isAccountAdmin","isLongTermToken","isOpAdmin","isOpSysAdmin","isReadOnly","isUser","isUserToken","isVisitor","permissions","rawToken","snowflakeUsage","timezone","tokenType"],"properties":{"accountId":{"format":"int32","type":"integer"},"accountStatus":{"enum":["ACTIVE","ACTIVE_BILLING_PROBLEM","INACTIVE_BILLING_FAILED","INACTIVE_USER_CANCELLED","INACTIVE","DEMO"],"type":"string"},"accountType":{"enum":["ADOBE_AUDITOR","FREE","CONTRACT","CPM_PARTNER","SAMPLE","INTERNAL","CONTRACT_SELF_SERVICE"],"type":"string"},"authToken":{"$ref":"#/components/schemas/AuthToken"},"capabilities":{"$ref":"#/components/schemas/AccountCapabilities"},"credsExpired":{"type":"boolean"},"email":{"type":"string"},"features":{"items":{"$ref":"#/components/schemas/Value"},"type":"array"},"id":{"format":"int32","type":"integer"},"isAccountActive":{"type":"boolean"},"isAccountAdmin":{"type":"boolean"},"isLongTermToken":{"type":"boolean"},"isOpAdmin":{"type":"boolean"},"isOpSysAdmin":{"type":"boolean"},"isReadOnly":{"type":"boolean"},"isUser":{"type":"boolean"},"isUserToken":{"type":"boolean"},"isVisitor":{"type":"boolean"},"loginAsRequestedByUserId":{"type":"number"},"permissions":{"$ref":"#/components/schemas/Permissions"},"rawToken":{"type":"string"},"snowflakeUsage":{"$ref":"#/components/schemas/SnowflakeUsage"},"timezone":{"$ref":"#/components/schemas/DateTimeZone"},"tokenType":{"$ref":"#/components/schemas/TokenType"}}}},"components/schemas/UserDocument":{"id":"components/schemas/UserDocument","kind":"json-schema","title":"UserDocument","data":{"type":"object","required":["email","firstName","lastName","timezone","username"],"properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullUsageDashboardAccess":{"type":"number"},"lastName":{"type":"string"},"maxPagesPerAudit":{"type":"number"},"permissions":{"enum":["guest","user","admin"],"type":"string"},"timezone":{"type":"string"},"username":{"type":"string"}},"description":"User create/update model"}},"components/schemas/UserFolder":{"id":"components/schemas/UserFolder","kind":"json-schema","title":"UserFolder","data":{"type":"object","required":["accountId","id","name"],"properties":{"accountId":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"name":{"type":"string"}},"description":"User folder model"}},"components/schemas/Value":{"id":"components/schemas/Value","kind":"json-schema","title":"Value","data":{"type":"object"}},"components/schemas/WebActionElementAttributeSwaggerReference":{"id":"components/schemas/WebActionElementAttributeSwaggerReference","kind":"json-schema","title":"WebActionElementAttributeSwaggerReference","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"components/schemas/WebActionElementDescriptionSwaggerReference":{"id":"components/schemas/WebActionElementDescriptionSwaggerReference","kind":"json-schema","title":"WebActionElementDescriptionSwaggerReference","data":{"type":"object","required":["attributes"],"properties":{"attributes":{"items":{"$ref":"#/components/schemas/WebActionElementAttributeSwaggerReference"},"type":"array"},"innerHTML":{"type":"string"},"tagName":{"type":"string"}}}},"components/schemas/WebActionSelectorSwaggerReference":{"id":"components/schemas/WebActionSelectorSwaggerReference","kind":"json-schema","title":"WebActionSelectorSwaggerReference","data":{"type":"object","discriminator":{"propertyName":"selectorType"},"properties":{"selectorType":{"format":"int32","type":"integer"}},"description":"Children: AttributesSelector, SimpleSelector"}},"components/schemas/WebJourney":{"id":"components/schemas/WebJourney","kind":"json-schema","title":"WebJourney","data":{"type":"object","required":["actions","domainId","emails","folderId","id","name","options","queued","userId"],"properties":{"actions":{"items":{"$ref":"#/components/schemas/SequencedActionSwaggerReference"},"type":"array"},"createdAt":{"format":"date-time","type":"string"},"domainId":{"format":"int64","type":"integer"},"emails":{"items":{"type":"string"},"type":"array"},"folderId":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"lastCheck":{"format":"date-time","type":"string"},"name":{"type":"string"},"nextCheck":{"format":"date-time","type":"string"},"options":{"$ref":"#/components/schemas/WebJourneyOptions"},"queued":{"type":"boolean"},"screenshot":{"type":"string"},"status":{"enum":["Ok","Failed","NotChecked","RulesFailed","ActionFailed","PageFailed","DataCollectionFailure"],"type":"string"},"userId":{"format":"int64","type":"integer"},"webJourneyRunning":{"type":"boolean"}},"description":"Web journey model"}},"components/schemas/WebJourneyCardData":{"id":"components/schemas/WebJourneyCardData","kind":"json-schema","title":"WebJourneyCardData","data":{"type":"object","required":["domain","domainId","emails","folderId","id","labels","name","options","queued","schedule","startingUrl","userId"],"properties":{"createdAt":{"format":"date-time","type":"string"},"domain":{"type":"string"},"domainId":{"format":"int64","type":"integer"},"emails":{"items":{"type":"string"},"type":"array"},"folderId":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"lastCheck":{"format":"date-time","type":"string"},"lastRun":{"$ref":"#/components/schemas/WebJourneyRun"},"name":{"type":"string"},"nextCheck":{"format":"date-time","type":"string"},"options":{"$ref":"#/components/schemas/WebJourneyOptions"},"queued":{"type":"boolean"},"schedule":{"$ref":"#/components/schemas/CardScheduleData"},"screenshot":{"type":"string"},"startingUrl":{"type":"string"},"status":{"enum":["Ok","Failed","NotChecked","RulesFailed","ActionFailed","PageFailed","DataCollectionFailure"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"},"userId":{"format":"int64","type":"integer"},"webJourneyRunning":{"type":"boolean"}},"description":"Web Journey with Last Run Info"}},"components/schemas/WebJourneyData":{"id":"components/schemas/WebJourneyData","kind":"json-schema","title":"WebJourneyData","data":{"type":"object","required":["actions","domainId","emails","name","options"],"properties":{"actions":{"items":{"$ref":"#/components/schemas/SequencedActionSwaggerReference"},"type":"array"},"domainId":{"format":"int64","type":"integer"},"emails":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/WebJourneyOptions"}}}},"components/schemas/WebJourneyOptions":{"id":"components/schemas/WebJourneyOptions","kind":"json-schema","title":"WebJourneyOptions","data":{"type":"object","required":["alerts","browserWidth","loadFlash","location","userAgent"],"properties":{"alerts":{"type":"boolean"},"browserWidth":{"format":"int32","type":"integer"},"customProxy":{"type":"string"},"flashLiveVideoEnabled":{"type":"boolean"},"frequency":{"type":"string"},"loadFlash":{"type":"boolean"},"location":{"type":"string"},"monitoredByScriptServices":{"type":"number"},"nextRun":{"format":"date-time","type":"string"},"remoteFileMapConfig":{"items":{"$ref":"#/components/schemas/RemoteFileMapping"},"type":"array"},"userAgent":{"type":"string"},"userAgentDescription":{"type":"string"},"vpnEnabled":{"type":"boolean"},"webHookUrl":{"type":"string"}}}},"components/schemas/WebJourneyRun":{"id":"components/schemas/WebJourneyRun","kind":"json-schema","title":"WebJourneyRun","data":{"type":"object","required":["id","webJourneyId"],"properties":{"completedAt":{"format":"date-time","type":"string"},"id":{"format":"int64","type":"integer"},"startedAt":{"format":"date-time","type":"string"},"status":{"enum":["Ok","Failed","NotChecked","RulesFailed","ActionFailed","PageFailed","DataCollectionFailure"],"type":"string"},"webJourneyId":{"format":"int64","type":"integer"}}}},"components/schemas/WebJourneyRunActionResult":{"id":"components/schemas/WebJourneyRunActionResult","kind":"json-schema","title":"WebJourneyRunActionResult","data":{"type":"object","required":["action","actionId","fileMappingResults","generatedActions","ruleResults","screenshot","simplifiedRuleSetupAllowed","success","tags","thumbnail","timelineId","timestamp"],"properties":{"action":{"$ref":"#/components/schemas/ActionSwaggerReference"},"actionId":{"format":"int64","type":"integer"},"actionSetId":{"type":"number"},"failureMessage":{"type":"string"},"failureType":{"type":"string"},"fileMappingResults":{"items":{"$ref":"#/components/schemas/FileMappingResult"},"type":"array"},"finishPageUrl":{"type":"string"},"generatedActions":{"items":{"$ref":"#/components/schemas/GeneratedAction"},"type":"array"},"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"result":{"type":"string"},"ruleResults":{"items":{"$ref":"#/components/schemas/ApiRuleResult"},"type":"array"},"screenshot":{"type":"string"},"simplifiedRuleSetupAllowed":{"type":"boolean"},"startPageUrl":{"type":"string"},"success":{"type":"boolean"},"tags":{"items":{"$ref":"#/components/schemas/ActionTag"},"type":"array"},"thumbnail":{"type":"string"},"timelineId":{"format":"int32","type":"integer"},"timestamp":{"format":"int64","type":"integer"}}}},"components/schemas/WebJourneyRunResult":{"id":"components/schemas/WebJourneyRunResult","kind":"json-schema","title":"WebJourneyRunResult","data":{"type":"object","required":["actions","globalRuleResults"],"properties":{"actions":{"items":{"$ref":"#/components/schemas/WebJourneyRunActionResult"},"type":"array"},"globalRuleResults":{"items":{"$ref":"#/components/schemas/ApiRuleResult"},"type":"array"}}}},"components/schemas/WebJourneyWithInfo":{"id":"components/schemas/WebJourneyWithInfo","kind":"json-schema","title":"WebJourneyWithInfo","data":{"type":"object","required":["domain","domainId","emails","folderId","id","labels","name","options","queued","runs","startingUrl","userId"],"properties":{"createdAt":{"format":"date-time","type":"string"},"domain":{"type":"string"},"domainId":{"format":"int64","type":"integer"},"emails":{"items":{"type":"string"},"type":"array"},"folderId":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"lastCheck":{"format":"date-time","type":"string"},"name":{"type":"string"},"nextCheck":{"format":"date-time","type":"string"},"options":{"$ref":"#/components/schemas/WebJourneyOptions"},"queued":{"type":"boolean"},"runs":{"items":{"$ref":"#/components/schemas/WebJourneyRun"},"type":"array"},"screenshot":{"type":"string"},"startingUrl":{"type":"string"},"status":{"enum":["Ok","Failed","NotChecked","RulesFailed","ActionFailed","PageFailed","DataCollectionFailure"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"},"userId":{"format":"int64","type":"integer"},"webJourneyRunning":{"type":"boolean"}},"description":"Web journey with run info model"}},"components/schemas/WritableItemSchedule":{"id":"components/schemas/WritableItemSchedule","kind":"json-schema","title":"WritableItemSchedule","data":{"type":"object","required":["dtStart","isPaused","recurrenceRule","tzId"],"properties":{"dtStart":{"$ref":"#/components/schemas/LocalDateTime"},"id":{"type":"number"},"isPaused":{"type":"boolean"},"recurrenceRule":{"type":"string"},"tzId":{"type":"string"}}}},"schema_567":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RulePreview"},"type":"array"},"id":"schema_567"},"schema_568":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_568"},"schema_569":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_569"},"schema_570":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/WebJourney"},"type":"array"},"id":"schema_570"},"schema_571":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"id":"schema_571"},"schema_572":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_572"},"schema_573":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"id":"schema_573"},"schema_574":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/UserFolder"},"type":"array"},"id":"schema_574"},"schema_575":{"kind":"json-schema","data":{"items":{"format":"int32","type":"integer"},"type":"array"},"id":"schema_575"},"schema_576":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Journey"},"type":"array"},"id":"schema_576"},"schema_577":{"kind":"json-schema","data":{"items":{"type":"number"},"type":"array"},"id":"schema_577"},"schema_578":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"id":"schema_578"},"schema_579":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/JourneyRun"},"type":"array"},"id":"schema_579"},"schema_580":{"kind":"json-schema","data":{"items":{"type":"string"},"type":"array"},"id":"schema_580"},"schema_581":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RequestLog"},"type":"array"},"id":"schema_581"},"schema_582":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Folder"},"type":"array"},"id":"schema_582"},"schema_583":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Domain"},"type":"array"},"id":"schema_583"},"schema_584":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_584"},"schema_585":{"kind":"json-schema","data":{"type":"string"},"id":"schema_585"},"schema_586":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Audit"},"type":"array"},"id":"schema_586"},"schema_587":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Location"},"type":"array"},"id":"schema_587"},"schema_588":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/UserAgent"},"type":"array"},"id":"schema_588"},"schema_589":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RuleDescription"},"type":"array"},"id":"schema_589"},"schema_590":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AuditRunWithRuleFailurePresence"},"type":"array"},"id":"schema_590"},"schema_591":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/LabelWithSignedItems"},"type":"array"},"id":"schema_591"}},"exampleStore":{},"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/v2"}]},"options":{"hideSchemaTitles":true,"corsProxyUrl":"","hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/SCALA-API.openapi.json?download"},{"url":"/_bundle/openapi/SCALA-API.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"V2 API","description":""}},"baseSlug":"/openapi/scala-api.openapi","routesMapping":{}}