Saltar al contenido principal

CookieSite

CookieSite

idstringrequired
Example: csite_wAspvmEr4ACDZaPUtfwjsA
namestringrequired
Example: Sitio principal
registrable_domainstringrequired
Example: example.com
enabledbooleanrequired
scan_enabledbooleanrequired

Controla los rescans aunque el banner esté deshabilitado.

scan_interval_daysintegerrequired

Possible values: >= 1 and <= 90

scan_report_recipientsemail[]nullable

Possible values: <= 20

next_scan_atdate-timenullable
latest_scan objectnullable
idstringrequired
Example: cscan_wAspvmEr4ACDZaPUtfwjsA
statusstringrequired

Estado del escaneo. queued espera ejecución; running está en curso; succeeded terminó sin incidencias; partial terminó con cobertura parcial; failed no pudo completarse (revisa failure_code).

Possible values: [queued, running, succeeded, partial, failed]

triggerstringrequired

Origen del escaneo. initial es el primer escaneo del sitio; manual fue solicitado por API o dashboard; scheduled proviene de la programación periódica; retry reintenta un escaneo previo.

Possible values: [initial, manual, scheduled, retry]

started_atdate-timenullable
completed_atdate-timenullable
observed_atdate-timenullable
complete_snapshotbooleannullable
coverage objectrequired

Cobertura del escaneo. Incluye pages_scanned, pages_failed y consent_interaction, que indica si el crawler pudo interactuar con el banner de consentimiento.

property name*any

Cobertura del escaneo. Incluye pages_scanned, pages_failed y consent_interaction, que indica si el crawler pudo interactuar con el banner de consentimiento.

catalog_versionstringnullable
warningsstring[]required

Advertencias no bloqueantes, por ejemplo page_limit_reached cuando se alcanzó el límite de páginas o anti_bot_blocked cuando el sitio bloqueó al crawler.

failure_codestringnullable

Motivo del fallo cuando status es failed. Valores posibles: scanner_unavailable (el scanner no respondió, devolvió un error 5xx o superó el tiempo de espera; el API reintenta los errores transitorios y registra este código cuando el reintento no prospera, incluida la indisponibilidad del catálogo), invalid_scanner_response (respuesta con formato inesperado), blocked_destination (el dominio o un redirect apunta a un destino no público, bloqueado por la protección SSRF) y scanner_failure (error permanente no clasificado, por ejemplo una solicitud inválida).

change_summary objectrequired

Cambios detectados frente al escaneo anterior. Las claves agrupan cookies new, reappeared, stale y reclassified.

property name* object[]
  • Array [
  • property name*any
  • ]
  • created_atdate-timerequired
    updated_atdate-timerequired
    active_banner_config_lineage_idstringnullable
    Example: cbcfg_wAspvmEr4ACDZaPUtfwjsA
    active_banner_config_versionintegernullable
    Example: 3
    active_banner_config_integrity_hashstringnullable
    inventory_items_countinteger

    Cantidad de cookies activas en el inventario del sitio.

    Possible values: >= 0

    inventory_categoriesCookieCategory[]

    Categorías presentes en las cookies activas detectadas para el sitio.

    Possible values: [essential, functional, analytics, marketing, personalize]

    latest_banner_config_statusstringnullable

    Possible values: [draft, published, archived]

    created_atdate-timerequired
    updated_atdate-timerequired
    CookieSite
    {
    "id": "csite_wAspvmEr4ACDZaPUtfwjsA",
    "name": "Sitio principal",
    "registrable_domain": "example.com",
    "enabled": true,
    "scan_enabled": true,
    "scan_interval_days": 0,
    "scan_report_recipients": [
    "user@example.com"
    ],
    "next_scan_at": "2024-07-29T15:51:28.071Z",
    "latest_scan": {
    "id": "cscan_wAspvmEr4ACDZaPUtfwjsA",
    "status": "queued",
    "trigger": "initial",
    "started_at": "2024-07-29T15:51:28.071Z",
    "completed_at": "2024-07-29T15:51:28.071Z",
    "observed_at": "2024-07-29T15:51:28.071Z",
    "complete_snapshot": true,
    "coverage": {},
    "catalog_version": "string",
    "warnings": [
    "string"
    ],
    "failure_code": "string",
    "change_summary": {},
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    },
    "active_banner_config_lineage_id": "cbcfg_wAspvmEr4ACDZaPUtfwjsA",
    "active_banner_config_version": 3,
    "active_banner_config_integrity_hash": "string",
    "inventory_items_count": 0,
    "inventory_categories": [
    "essential"
    ],
    "latest_banner_config_status": "draft",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }