pylon/get

Retrieve details of one or all of your interaction filters.

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

An HTTP GET request sent to:

https://api.datasift.com/v1.3/pylon/get

A successful call to this endpoint returns: 200 OK plus a JSON object.

Remember that you are using an identity-based API key. Make sure you take a look at our Account API Step-by-Step guide. If you use an Identity API key you will only see details of the interaction filters related to that key. If you use your main account API key you will see details of the interaction filters for all your identities.

Parameters

Parameter Description
per_page
optional

Number of results to return per page.

Default: 25

page
optional

The page you want to retrieve. For example, if you set this parameter to 3, the API will return page 3 only (if there is sufficient data to fill more than 2 pages).

Default: 1

id
optional

The id of the recording you want to request details for. If you omit it, you receive details of all your recordings.

Example values: d1b7d73b47c639ea3cc290595bca888ca4388afe

Examples

Sample requests

Make sure that you use the correct API key. See the Notes section below for guidance.

With no id:

curl -X GET https://api.datasift.com/v1.3/pylon/get 
  -H 'Authorization: username:api_key'

With an id:

curl -X GET https://api.datasift.com/v1.3/pylon/get?id=d1b7d73b47c639ea3cc290595bca888ca4388afe 
  -H 'Authorization: username:api_key'

Output

With no id:

HTTP/1.1 200 OK

{
"count": 2,
"page": 1,
"pages": 1,
"per_page": 25,
"subscriptions": [{
        "id": "d33fa735576d205ca737b0705ddf67e6e3a2b458",
        "volume": 0,
        "start": 1453899094,
        "end": 1453899239,
        "status": "stopped",
        "name": "Workbench v3",
        "reached_capacity": false,
        "identity_id": "58d7838888dd888bc7a39d73928fa7cf",
        "hash": "52c575234fa4354fd4cf60038e5a6e13",
        "remaining_index_capacity": 1000000,
        "remaining_account_capacity": 1000000
}, {
        "id": "d1b7d73b47c639ea3cc290595bca818ca4348afe",
        "volume": 0,
        "start": 1453824025,
        "end": null,
        "status": "running",
        "name": "ed02",
        "reached_capacity": false,
        "identity_id": "58d7838888dd888bc7a39d73928fa7cf",
        "hash": "fca23bfd90a1142009767a570e42e4ef",
        "remaining_index_capacity": 1000000,
        "remaining_account_capacity": 1000000
}]
}

With an id:

HTTP/1.1 200 OK

{
"id": "d1b7d73b47c639ea3cc290595bca888ca4388afe",
"volume": 0,
"start": 1453824025,
"end": null,
"status": "running",
"name": "my_test",
"reached_capacity": false,
"identity_id": "58d7838888dd888bc7a39d73928fa7cf",
"hash": "fca23bfd90a1142009767a570e42e4ef",
"remaining_index_capacity": 1000000,
"remaining_account_capacity": 1000000
}

Output fields

Property Type Description
count int The total number of recordings.
page int The page number for the current page.
pages int The total number of pages.
per_page int The number of recordings to display per page.
id string The recording id.
hash string The hash for this interaction filter.
volume int

The number of items recorded to your index by this interaction filter.

For privacy, the volume appears as 0 until your interaction filter has collected content from at least 1,000 unique authors. Once you have 1,000 authors the actual volume is returned.

start int A Unix timestamp showing when the recording started.
end int A Unix timestamp showing when the recording stopped. Can be blank/null.
status string Either "running" or "stopped".
name string The name of the recording.
reached_capacity bool True if your index hash reached its capacity.
remaining_index_capacity int The space remaining in your index (specified as the number of interactions that you can add).
remaining_account_capacity int The space left in all your indexes.
subscriptions array(string) An array containing details of each individual recordings.

Responses

Response code Description
Status 200 OK

If you include the hash parameter you receive a JSON object.

If you do not include the hash parameter, you receive an array of objects.

See examples above.

Status 404 Not Found

The recording cannot be found:

{
    "error":"<error message>",
    "original_error":"<if caused by an underlying Exception, that Exception's message>"
}

Notes

  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. If a recording has been stopped for more than 32 days, it is not shown in the /pylon/get response.
  4. Take a look at our Changelog page to review the changes we've made to the DataSift API over time.
  5. There is a brief delay (typically not more than 30 seconds) following a call to /pylon/start, /pylon/stop, or /pylon/update before data is available to this endpoint. For example, if you start a new recording and immediately hit /pylon/get, details of the recording might not be available yet. Wait a few seconds and hit the endpoint again.

Revision history

v1.2

In the output, we added fields for:

  • count
  • page
  • pages
  • per_page

The array of individual recordings now has a key called subscriptions. Scroll up to see an example where we receive multiple recordings in the case when we do not supply a hash.

v1.3

Up to v1.2 this endpoint allowed you to select details of an individual recording by the hash of its CSDL.

From v1.3 it uses the recording id instead. The id is supplied in the JSON returned by your call to the /pylon/start endpoint.

Resource information

Rate limit cost: 25

Requires authentication: Yes

Response formats: JSON, JSONP