Website Audit
Get a Website Audit target
Last updated 30 October 2026
get
/v1/website-audit/targets/{targetId}Authentication
- bearerAuth
bearerAuth: http / bearer — Use an Inth API key or OAuth access token in the Authorization header. Product operations need a capability. Feedback intake only requires authentication. An OAuth access token carries the capabilities it was granted as scopes; an organization API key carries a fixed set (`organizations.read`, `projects.read`, `projects.write`, `api-keys.read`, `inbox.read`, `billing.read`), so writes that name the person who made them, such as `inbox.write` and `vendors.write`, need a user token. A credential without the capability an operation needs is answered with `403 INSUFFICIENT_SCOPE`. `GET /v1/me` reports the capabilities of the calling credential. OAuth scopes: - `organizations.read`: List the organizations you belong to. - `organizations.write`: Create organizations you will own. - `projects.read`: Read projects, their consent configuration, and the vendors seen on them. - `projects.write`: Create, update, and delete projects and their consent configuration. - `members.read`: Read member names, email addresses, profile images, roles, and pending invitation email addresses. - `members.write`: Invite members, change member roles, remove members, and cancel invitations. - `api-keys.read`: List organization API keys. - `api-keys.write`: Create, roll, and delete organization API keys. - `code-audit.read`: Read Code Audit scans, their findings, and connected repositories. - `code-audit.write`: Start Code Audit scans and unlock their reports. - `inbox.read`: Read Inbox findings. - `inbox.write`: Change Inbox status or assignment and open GitHub issues for findings. - `vendors.write`: Approve or ignore vendors detected on your projects, which resolves their Inbox findings. - `billing.read`: Read the plan and credit balance of an organization. - `billing.details.read`: Read invoices, billing profiles, and payment method summaries for organizations you own. - `consent.read`: Read consent records, analytics, configuration, and runtime status. - `consent.write`: Update consent settings, translations, IAB configuration, and policies. - `consent.keys.read`: Read consent runtime key metadata. Secret values are never returned. - `website-audit.read`: Read website audit targets, scans, reports, cookies, and evidence. - `website-audit.write`: Manage website audit targets, verify domains, review findings, and start scans. - `account.read`: Read your account profile. - `notifications.read`: Read your notification preferences and organization routing. - `organization-retention.read`: Read organization provider data retention policy. - `support.read`: Read support conversations you own or can access through sharing. - `support.write`: Create support conversations, send messages, share or close them, and upload support attachments. - `consent.lifecycle.write`: Update, upgrade or delete Consent runtimes. - `consent.keys.write`: Create, rotate and revoke Consent runtime keys. - `billing.write`: Preview and change plans, buy credits, manage billing details and subscriptions, and open hosted payment flows. - `account.security.read`: Read your active browser sessions and connected device grants. - `account.security.write`: Revoke your browser sessions and connected device grants. - `integrations.read`: Read connected integration accounts, repositories, provider properties and project links. - `integrations.write`: Connect and sync providers, manage repository settings, project links and paid pull request monitoring. - `account.write`: Update your name, avatar and PII masking preference. - `account.delete`: Permanently delete your account after ownership checks and confirmation. - `notifications.write`: Update your notification preferences. - `notifications.routing.write`: Manage organization notification routing. - `organization-retention.write`: Change organization provider data retention policy. - `organizations.settings.write`: Update organization name, logo and slug. - `organizations.delete`: Permanently delete organizations you own after confirmation. - `agents.read`: Read your Inth Agent chats and chats shared with your organization. - `agents.write`: Start Inth Agent chats, send messages, share your chats with the organization, and delete your chats. Agent replies use organization credits.
Request
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
targetId | string | Required | — |
Responses
200
Success
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | unknown | Required | — |
data | object | Required | — |
data.approvedAuditPolicy | object | Optional | — |
data.approvedAuditPolicy.version | 1 | Required | — |
data.approvedAuditPolicy.revision | string | Required | — |
data.approvedAuditPolicy.origin | string | Required | — |
data.approvedAuditPolicy.approvedAt | string | Required | — |
data.approvedAuditPolicy.approvalReference | string | Required | — |
data.approvedAuditPolicy.cookies | object[] | Required | — |
data.approvedAuditPolicy.cookies[].name | string | Required | — |
data.approvedAuditPolicy.cookies[].ownerHost | string | Required | — |
data.approvedAuditPolicy.cookies[].partitionKey | string | null | Required | — |
data.approvedAuditPolicy.cookies[].maxRemainingSeconds | number | Optional | — |
data.approvedAuditPolicy.cookies[].sessionOnly | boolean | Optional | — |
data.approvedAuditPolicy.cookies[].security | object | Optional | — |
data.approvedAuditPolicy.cookies[].security.secure | boolean | Optional | — |
data.approvedAuditPolicy.cookies[].security.httpOnly | boolean | Optional | — |
data.approvedAuditPolicy.cookies[].security.sameSite | "Strict" | "Lax" | "None" | Optional | — |
data.approvedAuditPolicy.cookies[].security.domain | string | Optional | — |
data.approvedAuditPolicy.cookies[].security.path | string | Optional | — |
data.approvedAuditPolicy.cookies[].security.hostOnly | boolean | Optional | — |
data.approvedAuditPolicy.cookies[].security.partitioned | boolean | Optional | — |
data.approvedAuditPolicy.cookies[].priorConsent | object | Optional | — |
data.approvedAuditPolicy.cookies[].priorConsent.purpose | "advertising" | "measurement" | Required | — |
data.approvedAuditPolicy.cookies[].priorConsent.path | string | Required | — |
data.approvedAuditPolicy.cookies[].priorConsent.countries | string[] | Required | — |
data.approvedAuditPolicy.cookies[].priorConsent.requirement | object | object | object | Required | — |
data.approvedAuditPolicy.cookies[].afterWithdrawal | object | Optional | — |
data.approvedAuditPolicy.cookies[].afterWithdrawal.removal | "required" | Required | — |
data.approvedAuditPolicy.cookies[].afterWithdrawal.purposeId | string | Required | — |
data.approvedAuditPolicy.cookies[].afterWithdrawal.reference | string | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal | object | Optional | — |
data.approvedAuditPolicy.cookies[].afterRefusal.role | "identifier" | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal.documentScope | "root" | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal.purposeId | string | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal.channels | "cookie_read" | "cookie_header"[] | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal.transmission | object | Optional | — |
data.approvedAuditPolicy.cookies[].afterRefusal.transmission.kind | "cookie_header" | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal.transmission.origin | string | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal.transmission.path | string | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal.transmission.method | "GET" | "POST" | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal.transmission.reference | string | Required | — |
data.approvedAuditPolicy.cookies[].afterRefusal.reference | string | Required | — |
data.approvedAuditPolicy.cookies[].embeddedDocument | object | Optional | — |
data.approvedAuditPolicy.cookies[].embeddedDocument.url | string | Required | — |
data.approvedAuditPolicy.cookies[].embeddedDocument.reference | string | Required | — |
data.approvedAuditPolicy.cookies[].refreshApproval | object | Optional | — |
data.approvedAuditPolicy.cookies[].refreshApproval.reference | string | Required | — |
data.approvedAuditPolicy.collections | object[] | Optional | — |
data.approvedAuditPolicy.collections[].vendor | "google-analytics" | "posthog" | "plausible" | "databuddy" | "linkedin-insight-tag" | "x-pixel" | "custom" | Required | — |
data.approvedAuditPolicy.collections[].origin | string | Required | — |
data.approvedAuditPolicy.collections[].path | string | Required | — |
data.approvedAuditPolicy.collections[].method | "GET" | "POST" | Required | — |
data.approvedAuditPolicy.collections[].initiatorUrl | string | Required | — |
data.approvedAuditPolicy.collections[].purpose | "advertising" | "measurement" | Required | — |
data.approvedAuditPolicy.collections[].countries | string[] | Required | — |
data.approvedAuditPolicy.collections[].requirement | object | object | object | Required | — |
data.approvedAuditPolicy.collections[].payloadFields | string[] | Required | — |
data.approvedAuditPolicy.collections[].replayProbe | object | Optional | — |
data.approvedAuditPolicy.collections[].replayProbe.eventType | string | Required | — |
data.approvedAuditPolicy.collections[].replayProbe.markerField | string | Required | — |
data.approvedAuditPolicy.collections[].replayProbe.purposeId | string | Required | — |
data.approvedAuditPolicy.collections[].replayProbe.permittedBehaviour | "discard_denied_events" | Required | — |
data.approvedAuditPolicy.collections[].replayProbe.reference | string | Required | — |
data.approvedAuditPolicy.collections[].embeddedDocument | object | Optional | — |
data.approvedAuditPolicy.collections[].embeddedDocument.url | string | Required | — |
data.approvedAuditPolicy.collections[].embeddedDocument.source | "script" | "parser" | "document" | Required | — |
data.approvedAuditPolicy.collections[].embeddedDocument.reference | string | Required | — |
data.approvedAuditPolicy.collections[].identifyingSignal | object | Optional | — |
data.approvedAuditPolicy.collections[].identifyingSignal.kind | "pixel" | "fingerprint" | Required | — |
data.approvedAuditPolicy.collections[].identifyingSignal.source | "script" | "parser" | "document" | Required | — |
data.approvedAuditPolicy.collections[].identifyingSignal.fields | string[] | Required | — |
data.approvedAuditPolicy.collections[].identifyingSignal.reference | string | Required | — |
data.approvedAuditPolicy.collections[].afterWithdrawal | object | Optional | — |
data.approvedAuditPolicy.collections[].afterWithdrawal.purposeId | string | Required | — |
data.approvedAuditPolicy.collections[].afterWithdrawal.reference | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting | object | Optional | — |
data.approvedAuditPolicy.collections[].proxyRouting.kind | "server_proxy" | "cname" | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.forwarding | "unconditional" | "conditional" | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.reference | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.revision | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.digest | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.observedAt | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.validUntil | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.recipient | object | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.recipient.origin | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.recipient.path | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.recipient.relationship | "third_party" | "first_party" | "unresolved" | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.recipient.method | "GET" | "POST" | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.fields | object[] | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.fields[].source | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.fields[].destination | string | Required | — |
data.approvedAuditPolicy.collections[].proxyRouting.cnameChain | string[] | Optional | — |
data.approvedAuditPolicy.storage | object[] | Optional | — |
data.approvedAuditPolicy.storage[].mechanism | "local" | "session" | "indexeddb" | "cache" | Required | — |
data.approvedAuditPolicy.storage[].accessScope | "document-native-methods" | Required | — |
data.approvedAuditPolicy.storage[].origin | string | Required | — |
data.approvedAuditPolicy.storage[].key | string | Required | — |
data.approvedAuditPolicy.storage[].database | string | null | Required | — |
data.approvedAuditPolicy.storage[].store | string | null | Required | — |
data.approvedAuditPolicy.storage[].purpose | "advertising" | "measurement" | Required | — |
data.approvedAuditPolicy.storage[].countries | string[] | Required | — |
data.approvedAuditPolicy.storage[].requirement | object | object | object | Required | — |
data.approvedAuditPolicy.storage[].embeddedDocument | object | Optional | — |
data.approvedAuditPolicy.storage[].embeddedDocument.url | string | Required | — |
data.approvedAuditPolicy.storage[].embeddedDocument.reference | string | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal | object | Optional | — |
data.approvedAuditPolicy.storage[].afterRefusal.role | "identifier" | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal.documentScope | "root" | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal.purposeId | string | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal.channels | "native_read" | "transmission" | "property_read" | "worker"[] | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal.transmission | object | Optional | — |
data.approvedAuditPolicy.storage[].afterRefusal.transmission.kind | "fetch_get_query" | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal.transmission.origin | string | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal.transmission.path | string | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal.transmission.parameter | string | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal.transmission.reference | string | Required | — |
data.approvedAuditPolicy.storage[].afterRefusal.reference | string | Required | — |
data.approvedAuditPolicy.withdrawal | object | Optional | — |
data.approvedAuditPolicy.withdrawal.reference | string | Required | — |
data.approvedAuditPolicy.withdrawal.countries | string[] | Required | — |
data.approvedAuditPolicy.withdrawal.route | object | Optional | — |
data.approvedAuditPolicy.withdrawal.route.selector | string | Optional | — |
data.approvedAuditPolicy.withdrawal.route.label | string | Optional | — |
data.approvedAuditPolicy.withdrawal.route.reference | string | Required | — |
data.approvedAuditPolicy.googleInitialization | object | Optional | — |
data.approvedAuditPolicy.googleInitialization.reference | string | Required | — |
data.approvedAuditPolicy.googleInitialization.transport | "native_data_layer_push" | Required | — |
data.approvedAuditPolicy.googleInitialization.dataLayerName | "dataLayer" | Required | — |
data.approvedAuditPolicy.googleInitialization.requiredDefault | true | Required | — |
data.approvedAuditPolicy.googleInitialization.countries | string[] | Required | — |
data.approvedAuditPolicy.googleInitialization.consentTypes | "ad_storage" | "analytics_storage" | "ad_user_data" | "ad_personalization"[] | Required | — |
data.approvedAuditPolicy.googleInitialization.defaultStates | object[] | Optional | — |
data.approvedAuditPolicy.googleInitialization.defaultStates[].type | "ad_storage" | "analytics_storage" | "ad_user_data" | "ad_personalization" | "functionality_storage" | "personalization_storage" | "security_storage" | Required | — |
data.approvedAuditPolicy.googleInitialization.defaultStates[].state | "denied" | "granted" | Required | — |
data.approvedAuditPolicy.googleInitialization.choiceStates | object[] | Optional | — |
data.approvedAuditPolicy.googleInitialization.choiceStates[].choice | "accept_all" | "reject_all" | "accept_measurement_only" | "accept_functionality_only" | "accept_marketing_only" | Required | — |
data.approvedAuditPolicy.googleInitialization.choiceStates[].updateRequired | boolean | Required | — |
data.approvedAuditPolicy.googleInitialization.choiceStates[].states | object[] | Required | — |
data.approvedAuditPolicy.googleInitialization.choiceStates[].states[].type | "ad_storage" | "analytics_storage" | "ad_user_data" | "ad_personalization" | "functionality_storage" | "personalization_storage" | "security_storage" | Required | — |
data.approvedAuditPolicy.googleInitialization.choiceStates[].states[].state | "denied" | "granted" | Required | — |
data.approvedAuditPolicy.googleInitialization.categoryMapping | object | Optional | — |
data.approvedAuditPolicy.googleInitialization.categoryMapping.reference | string | Required | — |
data.approvedAuditPolicy.googleInitialization.categoryMapping.categories | object[] | Required | — |
data.approvedAuditPolicy.googleInitialization.categoryMapping.categories[].categoryId | string | Required | — |
data.approvedAuditPolicy.googleInitialization.categoryMapping.categories[].consentTypes | "ad_storage" | "analytics_storage" | "ad_user_data" | "ad_personalization" | "functionality_storage" | "personalization_storage" | "security_storage"[] | Required | — |
data.approvedAuditPolicy.googleInitialization.adsDataRedaction | object | Optional | — |
data.approvedAuditPolicy.googleInitialization.adsDataRedaction.reference | string | Required | — |
data.approvedAuditPolicy.googleInitialization.adsDataRedaction.required | true | Required | — |
data.approvedAuditPolicy.googleInitialization.implementationMode | object | Optional | — |
data.approvedAuditPolicy.googleInitialization.implementationMode.reference | string | Required | — |
data.approvedAuditPolicy.googleInitialization.implementationMode.mode | "basic" | "advanced" | Required | — |
data.approvedAuditPolicy.auditExpectations | object | Optional | — |
data.approvedAuditPolicy.auditExpectations.regionalBanner | object[] | Optional | — |
data.approvedAuditPolicy.auditExpectations.regionalBanner[].countries | string[] | Required | — |
data.approvedAuditPolicy.auditExpectations.regionalBanner[].banner | "required" | "not_expected" | Required | — |
data.approvedAuditPolicy.auditExpectations.regionalBanner[].reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.noticeAtCollection | object | Optional | — |
data.approvedAuditPolicy.auditExpectations.noticeAtCollection.countries | string[] | Required | — |
data.approvedAuditPolicy.auditExpectations.noticeAtCollection.notice | object | Required | — |
data.approvedAuditPolicy.auditExpectations.noticeAtCollection.notice.selector | string | Optional | — |
data.approvedAuditPolicy.auditExpectations.noticeAtCollection.notice.label | string | Optional | — |
data.approvedAuditPolicy.auditExpectations.noticeAtCollection.notice.reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.noticeAtCollection.reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.consentStorageScope | object | Optional | — |
data.approvedAuditPolicy.auditExpectations.consentStorageScope.scope | "host_only" | Required | — |
data.approvedAuditPolicy.auditExpectations.consentStorageScope.countries | string[] | Required | — |
data.approvedAuditPolicy.auditExpectations.consentStorageScope.reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.statisticalException | object | Optional | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.countries | string[] | Required | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.purposeIds | string[] | Required | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.notice | object | Required | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.notice.selector | string | Optional | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.notice.label | string | Optional | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.notice.reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.objection | object | Required | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.objection.selector | string | Optional | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.objection.label | string | Optional | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.objection.reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.statisticalException.reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.disclosedVendors | object | Optional | — |
data.approvedAuditPolicy.auditExpectations.disclosedVendors.vendors | string[] | Required | — |
data.approvedAuditPolicy.auditExpectations.disclosedVendors.reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.cmpMaintenance | object | Optional | — |
data.approvedAuditPolicy.auditExpectations.cmpMaintenance.platform | string | Required | — |
data.approvedAuditPolicy.auditExpectations.cmpMaintenance.minimumVersion | string | Required | — |
data.approvedAuditPolicy.auditExpectations.cmpMaintenance.reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.downstreamAssurance | object | Optional | — |
data.approvedAuditPolicy.auditExpectations.downstreamAssurance.recipients | string[] | Required | — |
data.approvedAuditPolicy.auditExpectations.downstreamAssurance.reference | string | Required | — |
data.approvedAuditPolicy.auditExpectations.instrumentedEvidence | object | Optional | — |
data.approvedAuditPolicy.auditExpectations.instrumentedEvidence.rules | "N06" | "D10" | "D13" | "X01" | "X04" | "X06" | "X07" | "X08"[] | Required | — |
data.approvedAuditPolicy.auditExpectations.instrumentedEvidence.reference | string | Required | — |
data.approvedAuditPolicy.selectedActivity | object | Optional | — |
data.approvedAuditPolicy.selectedActivity.reference | string | Required | — |
data.approvedAuditPolicy.selectedActivity.countries | string[] | Required | — |
data.approvedAuditPolicy.selectedActivity.categories | object[] | Required | — |
data.approvedAuditPolicy.selectedActivity.categories[].categoryId | string | Required | — |
data.approvedAuditPolicy.selectedActivity.categories[].collection | true | Optional | — |
data.approvedAuditPolicy.selectedActivity.categories[].cookies | string[] | Optional | — |
data.approvedAuditPolicy.choiceInterface | object | Optional | — |
data.approvedAuditPolicy.choiceInterface.reference | string | Required | — |
data.approvedAuditPolicy.choiceInterface.countries | string[] | Required | — |
data.approvedAuditPolicy.choiceInterface.affirmativeOptIn | true | Optional | — |
data.approvedAuditPolicy.choiceInterface.privacyNoticeUrl | string | Optional | — |
data.approvedAuditPolicy.choiceInterface.accessibility | "wcag_2_1_aa" | Optional | — |
data.approvedAuditPolicy.choiceInterface.acceptAllOffered | true | Optional | — |
data.approvedAuditPolicy.refusalPersistence | object | Optional | — |
data.approvedAuditPolicy.refusalPersistence.reference | string | Required | — |
data.approvedAuditPolicy.refusalPersistence.countries | string[] | Required | — |
data.approvedAuditPolicy.refusalPersistence.scopes | "reload" | "same_session_return"[] | Required | — |
data.approvedAuditPolicy.tcf | object | Optional | — |
data.approvedAuditPolicy.tcf.reference | string | Required | — |
data.approvedAuditPolicy.tcf.countries | string[] | Required | — |
data.approvedAuditPolicy.tcf.choices | object | Optional | — |
data.approvedAuditPolicy.tcf.choices.acceptAll | object | Optional | — |
data.approvedAuditPolicy.tcf.choices.acceptAll.purposeConsents | integer[] | Required | — |
data.approvedAuditPolicy.tcf.choices.acceptAll.vendorConsents | unknown | Required | — |
data.approvedAuditPolicy.tcf.choices.acceptAll.specialFeatureOptins | integer[] | Required | — |
data.approvedAuditPolicy.tcf.choices.rejectAll | object | Optional | — |
data.approvedAuditPolicy.tcf.choices.rejectAll.allowedPurposeConsents | integer[] | Required | — |
data.approvedAuditPolicy.tcf.choices.rejectAll.allowedVendorConsents | unknown | Required | — |
data.approvedAuditPolicy.tcf.choices.rejectAll.allowedSpecialFeatureOptins | integer[] | Required | — |
data.approvedAuditPolicy.tcf.publisherRestrictions | object[] | Optional | — |
data.approvedAuditPolicy.tcf.publisherRestrictions[].purposeId | integer | Required | — |
data.approvedAuditPolicy.tcf.publisherRestrictions[].restrictionType | 0 | 1 | 2 | Required | — |
data.approvedAuditPolicy.tcf.publisherRestrictions[].vendorIds | unknown | Required | — |
data.approvedAuditPolicy.tcf.consentModeMapping | object | Optional | — |
data.approvedAuditPolicy.tcf.consentModeMapping.reference | string | Required | — |
data.approvedAuditPolicy.tcf.consentModeMapping.transport | "native_data_layer_push" | Required | — |
data.approvedAuditPolicy.tcf.consentModeMapping.dataLayerName | "dataLayer" | Required | — |
data.approvedAuditPolicy.tcf.consentModeMapping.types | object[] | Required | — |
data.approvedAuditPolicy.tcf.consentModeMapping.types[].type | "ad_storage" | "analytics_storage" | "ad_user_data" | "ad_personalization" | "functionality_storage" | "personalization_storage" | "security_storage" | Required | — |
data.approvedAuditPolicy.tcf.consentModeMapping.types[].purposeConsents | integer[] | Required | — |
data.approvedAuditPolicy.usPrivacy | object | Optional | — |
data.approvedAuditPolicy.usPrivacy.reference | string | Required | — |
data.approvedAuditPolicy.usPrivacy.subdivisions | string[] | Required | — |
data.approvedAuditPolicy.usPrivacy.optOutChoice | "saved_rejection" | Optional | — |
data.approvedAuditPolicy.usPrivacy.gpp | object | Optional | — |
data.approvedAuditPolicy.usPrivacy.gpp.sections | object[] | Required | — |
data.approvedAuditPolicy.usPrivacy.gpp.sections[].api | "usnat" | "usca" | "usva" | "usco" | "usut" | "usct" | Required | — |
data.approvedAuditPolicy.usPrivacy.gpp.sections[].subdivisions | string[] | Required | — |
data.approvedAuditPolicy.usPrivacy.gpp.optOutFields | "SaleOptOut" | "SharingOptOut" | "TargetedAdvertisingOptOut"[] | Required | — |
data.approvedAuditPolicy.usPrivacy.usp | object | Optional | — |
data.approvedAuditPolicy.usPrivacy.usp.optOutFlag | "required" | Required | — |
data.approvedAuditPolicy.usPrivacy.saleSharing | object | Optional | — |
data.approvedAuditPolicy.usPrivacy.saleSharing.transports | object[] | Required | — |
data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].origin | string | Required | — |
data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].path | string | Required | — |
data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].method | "GET" | "POST" | Required | — |
data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].activity | "sale" | "sharing" | "targeted_advertising" | Required | — |
data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].reference | string | Required | — |
data.approvedAuditPolicy.usPrivacy.optOutRoute | object | object | Optional | — |
data.crawlMode | string | Required | — |
data.enabled | boolean | Required | — |
data.id | string | Required | — |
data.includeUrls | string[] | Optional | — |
data.lastRunAt | string | null | Required | — |
data.lastRunStatus | string | null | Required | — |
data.maxDepth | integer | Required | — |
data.maxPages | integer | Required | — |
data.monitoring | object | null | Optional | — |
data.organizationId | string | Required | — |
data.origin | string | Required | — |
data.policyUrls | string[] | Optional | — |
data.projectId | string | Required | — |
data.projectName | string | Required | — |
data.projectSlug | string | Required | — |
data.regionProfiles | "uk_gdpr" | "eu_eea_gdpr" | "us_ca_cpra" | "us_tx_baseline" | "custom"[] | Optional | — |
data.scheduleCadence | string | Required | — |
data.ownership | object | Optional | — |
data.ownership.domain | string | Required | — |
data.ownership.method | "dns" | "http" | "email" | "search_console" | null | Required | — |
data.ownership.status | "unverified" | "pending" | "verified" | "recheck_failed" | "third_party" | Required | — |
data.ownership.tier | "unverified" | "verified" | "third_party" | Required | — |
data.ownership.verifiedAt | string | null | Required | — |
View JSON schema
400
The request payload or parameters are invalid.
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | boolean | Required | — |
error | object | Required | — |
error.code | "UNAUTHORIZED" | "FORBIDDEN" | "INSUFFICIENT_SCOPE" | "PLAN_LIMIT_REACHED" | "PLAN_REQUIRED" | "INVALID_ORIGIN" | "INVALID_REGION" | "INVALID_PAYLOAD" | "NOT_FOUND" | "CONFLICT" | "KEY_LIMIT_REACHED" | "INSUFFICIENT_CREDITS" | "SCAN_IN_PROGRESS" | "UNLOCK_REQUIRED" | "REPOSITORY_NOT_LINKED" | "PAYLOAD_TOO_LARGE" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_ERROR" | Required | — |
error.message | string | Required | — |
error.details | unknown | Optional | Optional structured error details. |
View JSON schema
401
Authentication is missing, invalid, or expired.
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | boolean | Required | — |
error | object | Required | — |
error.code | "UNAUTHORIZED" | "FORBIDDEN" | "INSUFFICIENT_SCOPE" | "PLAN_LIMIT_REACHED" | "PLAN_REQUIRED" | "INVALID_ORIGIN" | "INVALID_REGION" | "INVALID_PAYLOAD" | "NOT_FOUND" | "CONFLICT" | "KEY_LIMIT_REACHED" | "INSUFFICIENT_CREDITS" | "SCAN_IN_PROGRESS" | "UNLOCK_REQUIRED" | "REPOSITORY_NOT_LINKED" | "PAYLOAD_TOO_LARGE" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_ERROR" | Required | — |
error.message | string | Required | — |
error.details | unknown | Optional | Optional structured error details. |
View JSON schema
403
The credential is valid but may not perform the operation. `INSUFFICIENT_SCOPE`: the credential was never granted the capability the operation needs. `details.requiredScope` names it, and the `WWW-Authenticate` header carries `Bearer error="insufficient_scope"`. An OAuth client fixes this by requesting the scope; an organization API key cannot gain it. `FORBIDDEN`: the capability is present but the membership behind the credential lacks the role, or the resource belongs to another organization.
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | boolean | Required | — |
error | object | Required | — |
error.code | "UNAUTHORIZED" | "FORBIDDEN" | "INSUFFICIENT_SCOPE" | "PLAN_LIMIT_REACHED" | "PLAN_REQUIRED" | "INVALID_ORIGIN" | "INVALID_REGION" | "INVALID_PAYLOAD" | "NOT_FOUND" | "CONFLICT" | "KEY_LIMIT_REACHED" | "INSUFFICIENT_CREDITS" | "SCAN_IN_PROGRESS" | "UNLOCK_REQUIRED" | "REPOSITORY_NOT_LINKED" | "PAYLOAD_TOO_LARGE" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_ERROR" | Required | — |
error.message | string | Required | — |
error.details | unknown | Optional | Optional structured error details. |
View JSON schema
Headers
| Name | Type | Description |
|---|---|---|
WWW-Authenticate | string | Present on `INSUFFICIENT_SCOPE`: `Bearer error="insufficient_scope", scope="<required scope>"`. |
404
The requested resource was not found.
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | boolean | Required | — |
error | object | Required | — |
error.code | "UNAUTHORIZED" | "FORBIDDEN" | "INSUFFICIENT_SCOPE" | "PLAN_LIMIT_REACHED" | "PLAN_REQUIRED" | "INVALID_ORIGIN" | "INVALID_REGION" | "INVALID_PAYLOAD" | "NOT_FOUND" | "CONFLICT" | "KEY_LIMIT_REACHED" | "INSUFFICIENT_CREDITS" | "SCAN_IN_PROGRESS" | "UNLOCK_REQUIRED" | "REPOSITORY_NOT_LINKED" | "PAYLOAD_TOO_LARGE" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_ERROR" | Required | — |
error.message | string | Required | — |
error.details | unknown | Optional | Optional structured error details. |
View JSON schema
Related
- REST API overview: Every operation in this API.