jobs

Api Create Job

post/api/jobs

Request

  • Base URL: https://outsend.xyz
  • URL: https://outsend.xyz/api/jobs
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

queriesstring[] required
zonesstring[] required
countrystring
include_reviewsboolean
scrap_mode'fast' | 'normal' | 'ultra'
extra_columnsstring[]
stop_atinteger nullable
max_per_phoneinteger
exclude_foreign_phonesboolean

Response

Successful Response

idstring required
job_typestring
queriesstring[] required
zonesstring[] required
countrystring nullable
include_reviewsboolean required
status'pending' | 'running' | 'done' | 'failed' | 'cancelled' | 'expired' required
grid_points_countinteger required
processed_pointsinteger required
results_countinteger required
error_countinteger required
ef_costnumber required
created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
expires_atstring date-time nullable
error_messagestring nullable
output_filenamestring nullable
download_availableboolean
source_job_idstring nullable
pipeline_idstring nullable
email_modestring nullable
breakdownobject nullable
dead_queriesstring[] nullable
flagged_tiles_countinteger
total_attempts_countinteger
query_statsobject nullable
scrap_modestring nullable
stop_atinteger nullable
max_per_phoneinteger
exclude_foreign_phonesboolean
max_reviewsinteger nullable
period_monthsinteger nullable
extra_columnsstring[] nullable
sub_tiles_queuedinteger
noticestring nullable
user_idinteger nullable
user_emailstring nullable

Changes

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