Criar tarefa de rastreamento

Crie uma tarefa de rastreamento para rastrear a URL fornecida com os limites de profundidade e páginas especificados.

Cabeçalhos

xi-api-keystringOpcional

Solicitação

This endpoint expects an object.
urlstringObrigatório

URL de uma página de documentação à qual o agente terá acesso para interagir com os usuários.

max_pagesintegerOpcional1-10000Padrão é 1000

Número máximo de páginas a rastrear (1 a 10.000). O padrão é 1.000.

patternstring or nullOpcional<=2048 characters

Se definido, somente URLs que correspondam a este padrão serão incluídas.

sitemap_urlslist of strings or nullOpcional

Lista de URLs para rastrear a partir do sitemap (opcional, substitui a descoberta automática de URLs).

parent_folder_idstring or nullOpcional

Se definido, o documento ou pasta criado será colocado dentro da pasta informada.

enable_auto_syncbooleanOpcionalPadrão é false

Indica se deve ativar a sincronização automática para este documento de URL.

auto_removebooleanOpcionalPadrão é false

Indica se deve remover automaticamente o documento caso a URL fique indisponível. Aplicável apenas quando a sincronização automática está ativada.

auto_discoverbooleanOpcionalPadrão é false

Descubra e adicione automaticamente novas páginas vinculadas a páginas já rastreadas durante a sincronização automática. Requer enable_auto_sync=true.

minimum_frequency_daysinteger or nullOpcional1-180

Frequência mínima (em dias) para atualização dos documentos qualificados subjacentes. O intervalo real pode ser menor, mas nunca maior. O padrão é 7 e será ajustado à frequência da pasta pai caso ela seja mais restritiva. Aplicável apenas quando a sincronização automática estiver ativada.

max_depthintegerOpcionalPadrão é 3Deprecated

Descontinuado — este campo não tem efeito e será removido em uma versão futura.

Resposta

Resposta bem-sucedida

idstring
typeenumPadrão é discovery
Valores permitidos:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsOpcional

Os segmentos do caminho da pasta que levam à pasta raiz, da raiz até a pasta pai.

Erros

422
Unprocessable Entity Error