historics/pause

Pause an existing Historics query.

An HTTP PUT request sent to:

https://api.datasift.com/v1.3/historics/pause

A successful call to this endpoint returns: 204 No Content. No JSON-encoded data will be sent to you.

Parameters

Parameter Description
id
required

The id of a Historics query. This is the id returned by the call you made to /historics/prepare.

Example values: 6cc90a14f570c4acdd22

reason
optional

Your reason for pausing the Historics query.

Example values: May not require this data any more

Examples

  1. Pause a Historics query and supply a reason:

curl -X PUT 'https://api.datasift.com/v1.3/historics/pause' 
    -d 'reason=Changed the CSDL' 
    -d 'id=6cc90a14f570c4acdd22' 
    -H 'Authorization: datasift-user:your-datasift-api-key'

Notes

  1. Take a look at the endpoint dependencies.
  2. Use the /historics/resume endpoint to resume a paused Historics job.
  3. Use the /historics/stop endpoint to permanently stop a job.
  4. Be sure to read our introduction to the Historics API to get started with these endpoints.
  5. All calls to the API must be properly authenticated with a DataSift username and API key.
  6. For efficiency, Historics jobs are chunked and the individual chunks are run separately. If you attempt to pause a Historics job, any chunks that have not yet started will be paused immediately. However, chunks that have started execution will run to completion.
  7. All calls to the API must be versioned. The current version is v1.3.

Resource information

Rate limit cost: 5

Requires authentication: Yes

Response formats: JSON, JSONP