Crear tarea de rastreo

Crea una tarea de rastreo para rastrear la URL indicada con los límites de profundidad y páginas especificados.

Encabezados

xi-api-keystringOpcional

Solicitud

This endpoint expects an object.
urlstringRequerido

URL de una página de documentación a la que el agente tendrá acceso para interactuar con usuarios.

max_pagesintegerOpcional1-10000Valor predeterminado: 1000

Número máximo de páginas que rastrear (1-10.000); el valor predeterminado es 1000.

patternstring or nullOpcional<=2048 characters

Si se establece, solo se incluirán las URL que coincidan con este patrón.

sitemap_urlslist of strings or nullOpcional

Lista de URL que rastrear desde el mapa del sitio (opcional; sustituye al descubrimiento automático de URL).

parent_folder_idstring or nullOpcional

Si se establece, el documento o la carpeta creados se colocarán dentro de la carpeta indicada.

enable_auto_syncbooleanOpcionalValor predeterminado: false

Indica si se debe activar la sincronización automática para este documento de URL.

auto_removebooleanOpcionalValor predeterminado: false

Indica si se debe eliminar automáticamente el documento si la URL deja de estar disponible. Solo se aplica cuando la sincronización automática está activada.

auto_discoverbooleanOpcionalValor predeterminado: false

Descubre y añade automáticamente nuevas páginas enlazadas desde páginas ya rastreadas durante la sincronización automática. Requiere enable_auto_sync=true.

minimum_frequency_daysinteger or nullOpcional1-180

Frecuencia mínima (en días) con la que se actualizan los documentos subyacentes aptos. El intervalo real puede ser más corto, pero nunca más largo. El valor predeterminado es 7 y se ajusta a la frecuencia de la carpeta principal si esta es más estricta. Solo se aplica cuando la sincronización automática está activada.

max_depthintegerOpcionalValor predeterminado: 3Deprecated

Obsoleto: este campo no tiene efecto y se eliminará en una versión futura.

Respuesta

Respuesta correcta.
idstring
typeenumValor predeterminado: discovery
Valores permitidos:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsOpcional

Los segmentos de la ruta de la carpeta que llevan a la carpeta raíz, desde la raíz hasta la carpeta principal.

Errores

422
Unprocessable Entity Error