Retry a Collection V2

POST https://www.hashscraper.com/api/retry_collect Content-Type: application/json; version=2

Re-run an existing dataset under the same ID.

Re-runs an existing dataset in place using the same schedule_result_id, instead of creating a new one. The dataset's parameter snapshot and result-column configuration are kept from the original run; existing results are preserved and the records collected by this retry are appended to the same dataset.

Because retries enqueue a new collection job, the same service-ticket/credit checks as collect apply. If the service ticket has expired or available credits are exhausted, the request is rejected and the response uses the error_message key.

You can poll progress via collect_status using the same schedule_result_id.

Request Parameters

  • api_key: String
    HashScraper API key
    Example YOUR_API_KEY
  • schedule_result_id: Integer
    ID of the dataset to retry. Typically the value returned by collect.
    Example YOUR_SCHEDULE_RESULT_ID

Response Fields

  • result: String
    Request outcome.
    Allowed success, error
  • version: String
    API version.
    Example v2
  • retry_info: Object
    Details about the retry request.
    • schedule_result_id: Integer
      Dataset ID echoed from the request.
    • schedule_id: String
      Identifier of the scraper that owns this dataset. Unlike collect, the value is read from the server rather than echoed from the request.
    • param_info: Object
      Snapshot of the parameters from the original collection. Only param1~param5 that were enabled are included, and keys carry the scraper's parameter labels (e.g. param1(keyword)). When the scraper has no label configured, the label slot may be empty (param1()) or a placeholder (param1(param1)).
  • elapsed_time: Float
    Server-side processing time (seconds, as a numeric value).
    Example 0.4521

Error Responses

  • schedule_result_id missing
    Required parameter schedule_result_id was not provided.
    {
      "result": "error",
      "version": "v2",
      "message": "`schedule_result_id` parameter is required"
    }
  • Schedule result not found
    No dataset matches the provided schedule_result_id, or it is not accessible.
    {
      "result": "error",
      "version": "v2",
      "message": "schedule_result(id: YOUR_SCHEDULE_RESULT_ID) not found"
    }
  • Service ticket expired
    The service ticket has expired, so the retry was rejected. The response uses the error_message key.
    {
      "result": "error",
      "version": "v2",
      "error_message": "서비스 이용권의 기간이 만료되었습니다."
    }
  • Credit exhausted
    Available credits are exhausted, so the retry was rejected. The response uses the error_message key.
    {
      "result": "error",
      "version": "v2",
      "error_message": "보유하신 크레딧을 모두 사용하셨습니다."
    }
  • Retry blocked
    The retry cannot start due to the service ticket or credit state. The message includes a specific reason; possible values are No active service ticket, Credit exhausted, Service ticket expired, and Invalid service ticket.
    {
      "result": "error",
      "version": "v2",
      "message": "Retry blocked: ..."
    }

Related Guides

Example Request
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
Example Response 200
{
  "result": "success",
  "version": "v2",
  "retry_info": {
    "schedule_result_id": 13229289,
    "schedule_id": "사람인_채용공고_수집_1697441449957",
    "param_info": {
      "param1(검색할 키워드)": "개발자",
      "param2(최대 수집 개수)": "10"
    }
  },
  "elapsed_time": 0.4521
}