MapsData API

Cancel a scrape

Cancel a queued or running scrape.

Cancelling a RUNNING scrape still bills the leads already delivered, the same as in the dashboard. A queued scrape costs nothing.

post/api/v1/jobs/{job_id}/cancel

Request

  • Base URL: https://mapsdata.ai (the document declares no server; this is the origin it was published from)
  • URL: https://mapsdata.ai/api/v1/jobs/{job_id}/cancel
  • Auth: MapsData API key (a scheme the document does not define)

Path parameters

job_idstring required

Response

Successful Response

idstring required
statusstring required

One of: queued, running, cancelling, cancelled, completed, failed.

progressinteger

Percent complete, 0-100.

querystring nullable
list_namestring nullable
countrystring nullable
statesstring[]
citiesobject[]
total_limitinteger nullable
lead_countinteger

Rows scraped so far. Live during a run.

email_countinteger

Rows carrying an email. Set when the job settles, and the figure your usage is billed on.

stop_reasonstring nullable

Why the scrape stopped. Set on essentially every completed scrape, so compare it against specific values rather than testing whether it is present. One of: 'limit_reached' (hit the requested total), 'coverage_exhausted' (covered every area selected and that was all there was), 'diminishing_returns' (results thinned out, so it stopped rather than walk the long tail), 'barren_query' (the densest areas returned almost nothing), 'user_cancel', 'stall', or 'memory_checkpoint'. The middle three all mean the area genuinely did not hold that many businesses and re-running returns the same count, so a result short of total_limit is expected rather than a failure. NULL means no reason was recorded: the scrape either finished before this field existed, or was cancelled or failed before it was set. Read it with status, never on its own.

error_messagestring nullable
export_errorstring nullable
created_atstring nullable
started_atstring nullable
completed_atstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.