Skip to main content
GET
/
1
/
crawlers
/
{id}
/
crawl_runs
List crawler runs
curl --request GET \
  --url https://crawler.algolia.com/api/1/crawlers/{id}/crawl_runs \
  --header 'Authorization: Basic <encoded-value>'
{
  "logs": [
    {
      "id": "<string>",
      "configId": "<string>",
      "reindexId": "<string>",
      "fileSizeBytes": 123,
      "uncompressedSizeBytes": 123,
      "crawlStartedAt": "<string>",
      "crawlCompletedAt": "<string>",
      "fileCreatedAt": "<string>",
      "expiresAt": "<string>",
      "status": "<string>",
      "accessCount": 123,
      "lastAccessedAt": "<string>",
      "urlsDone": 123,
      "urlsSkipped": 123,
      "urlsFailed": 123
    }
  ],
  "meta": {
    "total": 123
  }
}
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

​
until
string

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

Example:

1762264044

​
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
​
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

Response

List Response of Crawler Logs.

​
logs
crawlerLogItem · object[]
required
​
meta
crawlerLogsMeta · object
required