SubmitURLsToCrawl

Status

Command status: Active
Supported by OpenApps API: Yes
Supported by Internal/Reseller API: Yes
Possibly queued processing: n/a

Purpose

This command submits URLs for our webcrawler to crawl. We cannot guarantee that every URL can be crawled.

Resources consumed

Resource Description

AnalysisResUnits

50 per queried item

Parameters

Parameter Description

cmd

Required: must be set to: SubmitURLsToCrawl

datasource

Optional - defaults to historic
Either: "fresh" - to query against Fresh Index, or "historic" - to query against Historic Index.

item0, item1, item2, item3 ... item999

All items can belong to URL, subdomain or root domain levels.
Up to 1000 items can be added

Sample queries and response

XML response

<?xml version="1.0" encoding="UTF-8"?>
<Result Code="OK" ErrorMessage="" FullError="">
   <GlobalVars IndexBuildDate="2013-02-24 21:47:24" IndexType="1" ServerBuild="2017-10-18 15:56:19" ServerName="XSTHEMACHINE" ServerVersion="1.0.6500.26889" UniqueIndexID="20130224214724-FRESH" URLsAdded="2" />
</Result>

JSON response

{
  "Code": "OK",
  "ErrorMessage": "",
  "FullError": "",
  "IndexBuildDate": "2013-02-24 21:47:24",
  "IndexType": 1,
  "ServerBuild": "2017-10-18 15:56:19",
  "ServerName": "XSTHEMACHINE",
  "ServerVersion": "1.0.6500.26889",
  "UniqueIndexID": "20130224214724-FRESH",
  "URLsAdded": 2
}

Returned values

Return value Description
Code Code indicating if this command executed successfully.
ErrorMessage A message explaining the error. This will be blank if the code is "OK".
FullError Verbose explanation of error.
IndexBuildDate Date/time the index that was queried was last updated.
IndexType Indicates if the index was Historic (0) or Fresh (1).
ServerBuild Date/time the server was built.
ServerName Name of the server queried.
ServerVersion Version of the server queried.
UniqueIndexID Unique identifier for the index consisting of the date and index type.
URLsAdded Number of URLs submitted.