DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility data.
OnPage API Force Stop
Stops a running crawl by id. Returns no results of its own. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Use it when a crawl was submitted with too high a max_crawl_pages and is still consuming budget; what has already been crawled stays queryable through get_dataforseo_on_page_summary and the rest of this family.
- 型: array object[]
- id型: string必須
ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” note: you can set up to 1000 id values as separate objects in the POST array
- 型: object200
Successful response
- 型: numbercost
total tasks cost, USD
- 型: integerstatus
_code general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
- 型: stringstatus
_message general informational message you can find the full list of general informational messages here
- 型: array string[]tasks
array of tasks
- 型: integertasks
_count the number of tasks in the tasks array
- 型: integertasks
_error the number of tasks in the tasks array returned with an error
- 型: numbertasks
.cost cost of the task, USD
- 型: objecttasks
.data contains the same parameters that you specified in the POST request
- 型: stringtasks
.id task identifier unique task identifier in our system in the UUID format
- 型: array string[]tasks
.path URL path
- 型: array string[]tasks
.result array of results
- 型: integertasks
.result _count number of elements in the result array
- 型: integertasks
.status _code status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
- 型: stringtasks
.status _message informational message of the task you can find the full list of general informational messages here
- 型: stringtasks
.time execution time, seconds
- 型: stringtime
execution time, seconds
- 型: stringversion
the current version of the API
application/json - 400
Bad request
- 401
Unauthorized
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
Rate limit exceeded
- 500
Internal server error
- 502
The service could not complete the request.
- 503
The API or billing service is temporarily unavailable.
- 504
The service timed out while processing the request.
- default
The operation failed. Keep the response request ID when contacting Felo support.
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/force_stop \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{
"id": ""
}
]'
{
"version": "string",
"status_code": 1,
"status_message": "string",
"time": "string",
"cost": 1,
"tasks_count": 1,
"tasks_error": 1,
"tasks": [
"string"
],
"tasks.id": "string",
"tasks.status_code": 1,
"tasks.status_message": "string",
"tasks.time": "string",
"tasks.cost": 1,
"tasks.result_count": 1,
"tasks.path": [
"string"
],
"tasks.data": {},
"tasks.result": [
"string"
]
}