historics/stop

Stop an existing Historics query.

An HTTP PUT request sent to:

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

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: 2459b03a13577579bca7

reason
optional

Your reason for stopping the Historics query.

Example values: Needed to change the filtering logic

Examples

  1. Stop a Historics query and supply a reason:

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

Notes

  1. If you stop a Historics job, you cannot restart it.
  2. Be sure to read our introduction to the Historics API to get started with these endpoints.
  3. Also, take a look at the endpoint dependencies.
  4. All calls to the API must be properly authenticated with a DataSift username and API key.
  5. 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