Start recording an interaction filter to your index. Or restart a recording that has stopped.

To learn how to use the endpoints together take a look at our PYLON API step-by-step page.

An HTTPS PUT request sent to:

A successful call to this endpoint to start or restart a recording returns: 200 plus a JSON object.


Parameter Description

The hash of the filter you want to start recording.

Example values: 4d314afa81778be8888e2b032032f2ed


A name for your interaction filter. If you are restarting a filter, the name is optional.


The id of the recording you want to restart. It is a required parameter if you are restarting a recording. If you are starting a recording for the first time, use the hash of the CSDL instead.

Example values: abcdef1234abcdef1234abcdef1234abcdef1234


Sample request

Start a recording.

curl -X PUT 
    -d '{"hash":"1a4268c9b924d2c48ed8946d6a7e6272","name":"my_test"}' 
    -H "Content-type: application/json" 
    -H 'Authorization: username:api_key'

Restart a recording.

curl -X PUT 
    -d '{"id":"d1b7d73b47c639ea3cc290595bca888ca4388afe","name":"my_test2"}' 
    -H "Content-type: application/json" 
    -H 'Authorization: username:api_key'


When you start or restart a recording.

HTTP/1.1 200 OK
  "id": "d1b7d73b47c639ea3cc290595bca888ca4388afe"


Response code Description
Status 200 OK The recording was successfully started.
Status 400 Bad Request No hash was supplied.
Status 402 Payment Required You have reached your maximum allowed number of concurrent interaction filters.
Status 404 Not Found No definition with the given hash could be found.
Status 405 Client Error An incorrect HTTP method was used.
Status 409 Conflict

The recording is already running.

    "error" : "Subscription already running"


  1. All calls to the API must be properly authenticated with a DataSift username and API key.
  2. All calls to the API must be versioned. The current version is v1.3.
  3. Note that the username is the one you use to log in to and to make calls to any of the REST endpoints but the API key is the one that was returned by your call to the  POST /account/identity endpoint. That is, it is an identity-based API key.
  4. Take a look at our Changelog page to review the changes we've made to the DataSift API over time.

Revision history


Up to v1.2, this endpoint returned 204 No content. From v1.3 it returns 200 plus a JSON object containing the id of the recording.

Resource information

Rate limit cost: 25

Requires authentication: Yes

Response formats: JSON, JSONP