GET /account/identity/{identity_id}/limit/{service}

Retrieve the service limits set for an identity.

An HTTPS GET request sent to:

https://api.datasift.com/v1.3/account/identity/{identity_id}/limit/{service}

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

Parameters

Parameter Description

Examples

  1. Retrive details for limits for the identity 1234567890abcdef1234567890abcdef being used with Facebook:

curl -X GET https://api.datasift.com/v1.3/account/identity/1234567890abcdef1234567890abcdef/limit/facebook 
    -H 'Authorization: username:api_key'

A successful call returns:

HTTP/1.1 200 OK

{
    "identity_id": "<string>",
    "service": "facebook",
    "total_allowance": <positive integer>,
    "analyze_queries": <positive integer>
}

Output Fields

Property Type Description
identity_id string The id of the identity.
service string The service these limits apply to.
total_allowance int The daily recording limit set for the identity for this service.
analyze_queries int The hourly analyze query limit set for the identity for this service

Responses

Response code Description
Status 200 OK

The call was successful.

{
    "identity_id": "1234567890abcdef1234567890abcdef",
    "service": "facebook",
    "total_allowance": 50000,
    "analyze_queries": 100
}
Status 400 Bad Request Occurs if any of the parameters are malformed.
Status 404 Not Found

The identity was not found:

{
    "error": "An Identity with the supplied id was not found"
}

No limits are currently set for the identity:

{
    "error": "Limit not found"
}
Status 410 Gone
{
    "error": "The Identity with the supplied id has been deleted"
}

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: 25

Requires authentication: Yes

Response formats: JSON, JSONP