push/validate

Check that a Subscription is defined correctly.

An HTTPS POST request sent to:

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

A successful call to this endpoint returns: 200 OK.

Parameters

Parameter Description
output_type
required

The output destination type. It is one of the connectors.

Example values: s3

output_params.*
required

The output parameters are documented individually for each of DataSift's connectors

Example values: output_params.format=json

Examples

  1. Validate a request before using these API parameters with the /v1.3/push/create endpoint. This string includes the output parameters to make an HTTP request to the domain example.com:

curl -X POST https://api.datasift.com/v1.3/push/validate 
    -d 'output_type=HTTP' 
    -d 'output_params.delivery_frequency=60' 
    -d 'output_params.url=http://www.example.com' 
    -d 'output_params.auth.type=basic' 
    -H 'Authorization:username:apikey'

If unsuccessful, the endpoint returns an error message in a JSON object with a 400 status code. For example:

{
    "error": "Bad request,Could not access the destination URL. We were unable to connect the endpoint"
}

The /push/create endpoint automatically makes a call to /push/validate behind the scenes, so you are not required to make this call yourself. We've made it available for checking and debugging purposes.

For more details, take a look at the Push API overview.

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.

Resource information

Rate limit cost: 5

Requires authentication: Yes

Response formats: JSON, JSONP