List crawler runs

The Crawler Logs feature lets you monitor and debug your crawler’s activity by recording detailed logs for each crawl run.

GET /1/crawlers/{id}/crawl_runs

List crawler runs

cURL

curl --request GET \
  --url https://crawler.algolia.com/api/1/crawlers/{id}/crawl_runs \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "logs": [
    {
      "accessCount": 123,
      "configId": "<string>",
      "crawlCompletedAt": "<string>",
      "crawlStartedAt": "<string>",
      "expiresAt": "<string>",
      "fileCreatedAt": "<string>",
      "fileSizeBytes": 123,
      "id": "<string>",
      "lastAccessedAt": "<string>",
      "reindexId": "<string>",
      "status": "<string>",
      "uncompressedSizeBytes": 123,
      "urlsDone": 123,
      "urlsFailed": 123,
      "urlsSkipped": 123
    }
  ],
  "meta": {
    "total": 123
  }
}

Logs are useful for troubleshooting crawl issues, verifying site coverage, and monitoring crawler performance over time.

Required ACL: settings

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"

Query Parameters

from · string

Date 'from' filter. Unix string 'from' date.

Example:

1762264044

limit · integer · default: 10

Limit of the query results.

Required range: 1 <= x <= 1000

Example:

10

offset · integer

Offset of the query results.

Example:

11

order · enum<string>

Order of the query 'ASC' or 'DESC'. Order of the query.

Available options: ASC, DESC

status · enum<string>

Status to filter 'DONE', 'SKIPPED' or 'FAILED'. Crawled URL status.

For more information, see Troubleshooting by crawl status.

Available options: DONE, SKIPPED, FAILED

until · string

Date 'until' filter. Unix string 'until' date.

Example:

1762264044

Response

200

application/json

List Response of Crawler Logs.

logs · crawlerLogItem · object[] · required

Show child attributes

meta · crawlerLogsMeta · object · required

Show child attributes