Retrieve crawler details

{ "blocked": true, "createdAt": "2023-07-04T12:49:15Z", "lastReindexEndedAt": "<string>", "lastReindexStartAt": "2024-04-07T09:16:04Z", "name": "test-crawler", "reindexing": true, "running": true, "updatedAt": "2023-07-04T12:49:15Z", "blockingError": "Error: Failed to fetch external data for source 'testCSV': 404\n", "blockingTaskId": "<string>" }

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

string

required

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

Example:

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

Query Parameters

withConfig

boolean

Whether the response should include the crawler's configuration.

Response

Without configuration
With configuration

blocked

boolean

required

Whether this crawler is blocked.

If true, you can unblock it from the Crawler page in the Algolia dashboard or by cancelling the blocking task.

createdAt

string

required

Date and time when the object was created, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"

lastReindexEndedAt

string | null

required

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

lastReindexStartAt

string | null

required

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

Example:

"2024-04-07T09:16:04Z"

name

string

required

Name of the crawler.

Maximum string length: 64

Example:

"test-crawler"

reindexing

boolean

required

Whether this crawler is completely reindexing your content.

running

boolean

required

Whether this crawler is active.

updatedAt

string

required

Date and time when the object was updated, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"

blockingError

string

Reason why the crawler is blocked.

Example:

"Error: Failed to fetch external data for source 'testCSV': 404\n"

blockingTaskId

string

ID of the task that's blocking the crawler.