push/resume

Set a paused job running again.

An HTTP PUT request sent to:

https://api.datasift.com/v1.3/push/resume

A successful call to this endpoint returns: 200 OK.

Parameters

Parameter Description
id
required

The id of an existing Subscription.

Example values: 08b923395b6ce8bfa4d96f57f863a1c3

Examples

  1. Resume a live stream or a Historics query:

curl -X PUT 'https://api.datasift.com/v1.3/push/resume' 
    -d 'id=d468655cfe5f93741ddcd30bb309a8c7' 
    -H 'Authorization: datasift-user:your-datasift-api-key'

Here's an example of the JSON output.

{
    "id": "d468655cfe5f93741ddcd30bb309a8c7",
    "output_type": "dynamodb",
    "name": "mypushsubscription",
    "created_at": 1365430066,
    "user_id": 12635,
    "hash": "42d388f8b1db997faaf7dab487f11290",
    "hash_type": "stream",
    "output_params": {
        "table": "datasift-dynamodb",
        "region": "dynamodb.eu-west-1.amazonaws.com"
    },
    "status": "active",
    "last_request": 1365432842,
    "last_success": 1365432842,
    "remaining_bytes": null,
    "lost_data": false,
    "start": null,
    "end": null
}

Property: Description:
id A unique ID of this Push subscription. Each new subscription has a different ID, even when they are based on the same stream and the data is delivered to the same destination.
output_type The name of the output type. See the list of the values of the output_type parameter elsewhere on this page.
name A user-defined name of the subscription.
created_at A Unix timestamp that represents the date and time the subscription was created at.
user_id The DataSift ID of the user who created the subscription.
hash A stream ID or Historics query ID.
hash_type Can be either "hash" (when the hash element represents a stream) or "historics" (when the hash element represents a Historics query).
output_params output_parameters used in the call to /push/create.
status Subscription status.
last_request The time of the most recent Push delivery request sent to the associate data destination. A Unix timestamp.
last_success The time of the most recent successful delivery. A Unix timestamp.
remaining_bytes The number of bytes queued for delivery.
lost_data Set to true if data was removed from the Push delivery queue because it could not be delivered.
start Subscription start time/date. A Unix timestamp.
end Subscription end time. A Unix timestamp.

Notes

  1. All calls to the API must be properly authenticated with a DataSift username and API key.
  2. When a Subscription is paused, it continues to buffer data but that data is not delivered. In other words, data is flowing into the Push engine but it is not being delivered to you. The /push/resume endpoint allows you to change the status of a Subscription from paused to active.
  3. Take a look at our status codes page for a full list of the statuses that you might see.
  4. For more details, take a look at the Push API overview.
  5. All calls to the API must be versioned. The current version is v1.3.

Resource information

Rate limit cost: 1

Requires authentication: Yes

Response formats: JSON, JSONP