Test crawl a URL

Tests a URL with the crawler’s configuration and shows the extracted records.

POST /1/crawlers/{id}/test

200

{
  "endDate": "2024-04-02T15:34:29Z",
  "links": [
    "https://www.algolia.com/blog/engineering/challenging-migration-heroku-google-kubernetes-engine",
    "https://www.algolia.com/blog/engineering/a-tale-of-two-engines-algolia-unity"
  ],
  "logs": [
    [
      "Processing url 'https://www.algolia.com/blog'"
    ]
  ],
  "records": [
    {
      "indexName": "testIndex",
      "records": [
        {
          "objectID": "https://www.algolia.com/blog",
          "numberOfLinks": 2
        }
      ],
      "recordsPerExtractor": [
        {
          "index": 0,
          "type": "custom",
          "records": [
            {
              "objectID": "https://www.algolia.com/blog"
            }
          ]
        }
      ]
    }
  ],
  "startDate": "2024-04-02T15:34:29Z",
  "error": {},
  "externalData": {
    "externalData1": {
      "data1": "val1",
      "data2": "val2"
    },
    "externalData2": {
      "data1": "val1",
      "data2": "val2"
    }
  }
}

{
  "error": {
    "code": "malformed_id"
  }
}

You can test configuration changes by overriding specific parts before updating the full configuration.

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id · string · required

Crawler ID. Universally unique identifier (UUID) of the crawler.

Example:

"e0f6db8a-24f5-4092-83a4-1b2c6cb6d809"

Body

application/json

url · string · required

URL to test.

Example:

"https://www.algolia.com/blog"

config · object

Crawler configuration to update. You can only update top-level configuration properties. To update a nested configuration, such as actions.recordExtractor, you must provide the complete top-level object such as actions.

Show child attributes

Response

200

application/json

OK

endDate · string · required

Date and time when the test crawl finished, in RFC 3339 format.

Example:

"2024-04-02T15:34:29Z"

links · string[] · required

Links found on the page, which match the configuration and would be processed.

Example:

[
  "https://www.algolia.com/blog/engineering/challenging-migration-heroku-google-kubernetes-engine",
  "https://www.algolia.com/blog/engineering/a-tale-of-two-engines-algolia-unity"
]

logs · string[][] · required

Logs from the record extraction.

Parameters associated with each log.

records · extractedRecords · object[] · required

Extracted records from the URL.

Show child attributes

startDate · string · required

Date and time when the test crawl started, in RFC 3339 format.

Example:

"2024-04-02T15:34:29Z"

error · urlTestError · object

An error.

Show child attributes

Example:

{}

externalData · object

External data associated with the tested URL.

External data is refreshed automatically at the beginning of the crawl.

Example:

{
  "externalData1": { "data1": "val1", "data2": "val2" },
  "externalData2": { "data1": "val1", "data2": "val2" }
}