Skip to main content
POST
/
crawls
/
query
cURL
curl --request POST \
  --url https://api.olyptik.io/crawls/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 0,
  "status": [
    "running"
  ],
  "startUrls": [
    "<string>"
  ]
}
'
{
  "page": 0,
  "results": [
    {
      "startUrl": "https://example.com",
      "maxResults": 55,
      "maxDepth": 10,
      "useSitemap": false,
      "entireWebsite": false,
      "excludeNonMainTags": true,
      "includeLinks": true,
      "deduplicateContent": true,
      "extraction": "Extract only pricing info",
      "engineType": "auto",
      "useStaticIps": false,
      "timeout": 1800,
      "id": "6870e36787c81925622df818",
      "createdAt": "2023-11-07T05:31:56Z",
      "status": "timed_out",
      "completedAt": "2023-11-07T05:31:56Z",
      "durationInSeconds": 1800,
      "brandId": "<string>",
      "startUrls": [
        "https://example.com"
      ],
      "totalPages": 100,
      "origin": "web"
    }
  ],
  "totalPages": 0,
  "totalResults": 0,
  "limit": 20
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Query crawls

​
page
integer
default:0
required

Page number to query

Required range: x >= 0
​
status
enum<string>[]

Status of the crawls to query, if left empty all statuses will be queried

Available options:
running,
succeeded,
failed,
aborted,
timed_out,
error
​
startUrls
string<uri>[]

Start URLs of the crawls to query, if left empty all start URLs will be queried

Response

Paginated results with matching crawls

​
page
integer
default:0
Required range: x >= 0
​
results
object[]
​
totalPages
integer
default:0
Required range: x >= 0
​
totalResults
integer
default:0
Required range: x >= 0
​
limit
integer
default:20
Required range: x >= 0