Job ID Status

Prev Next
GET /explore/job/{job_id}

Get the status of the running job or the results from the completed job.

Parameters

Description

Query Parameters

  • job_id (string) (required) –

    • Job ID

  • max_wait = (int) (optional) –

    • max number of seconds to wait for results before returning status of running job

    • use when results are preferred over job status information, when job is likely to complete soon

      • 25 (default)

      • value in the range from 0 to 25

  • status_only =<0|1> (int) (optional) –

    • always return job status, even if job is complete

      • 0 (default) - return results, if available, otherwise curren job status

      • 1 - always return job status, even if results are available

  • force_metadata_on =<0|1> (int) (optional) –

    • always return query metadata, even if original request did not include metadata

      • 0 (default) - return original request

      • 1 - always return metadata

  • force_metadata_off =<0|1> (int) (optional) –

    • never return query metadata, even if original request did include metadata

      • 0 (default) - return original request

      • 1 - never return metadata

Request Headers

X-API-KEY – api-key

Example request

https://api.silentpush.com/api/v1/merge-api/explore/job/d4067541-eafb-424c-98d3-de12d7a91331

Example response

{
    "status_code": 200,
    "error": null,
    "response": {
        "job_status": {
            "get": "https://api.silentpush.com/api/v1/merge-api/explore/job/cd4067541-eafb-424c-98d3-de12d7a91331",
            "job_id": "d4067541-eafb-424c-98d3-de12d7a91331",
            "status": "STARTED"
        }
    }
}