The purpose of this API is to provide risk ratings and reputational data across thousands of websites in a batch mode.
Posted data should be in CSV format where each line consists of a single field which is the Domain. The request MIME type should be text/plain.
Once request data is submitted, a URL to a newline-delimited JSON formatted report is provided as a response. While the resulting resource is public, the URL contains a randomly generated identifier that ensures the data is relatively secure unless the URL itself is made public by the user.
The report will not be available for download at the returned URL location until processing has been completed. While creating the report, a request to retrieve the report using the response URL will return an HTTP status code Not Found (404). Once asynchronous processing has completed, the report is returned as normal. If asynchronous processing of a report fails because of an invalid query the request to retrieve the report using the response URL will return an HTTP status code Bad Request (400). Or, if the submitted file contained more than 5000 domains, then an HTTP status code Request Entity Too Large (413) is returned. Or, if the account's quota limit has been exceeded, then an HTTP status code Forbidden (403) is returned. For all other errors, a request to retrieve the report using the response URL will return an HTTP status code Internal Service Error (500). Client systems should poll the response URL until the report is available, or a non 404 HTTP status code is returned.
This operation requires an Enterprise subscription. Please reach out to us at [email protected] for details on how to enable this for your account.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
400Bad Request - Invalid parameters in request.
401Unauthorized - Invalid API Key.
403Forbidden - Quota has been exhausted, Subscription expired or needs upgrade.
5XXServer Error - The API experienced an internal error. Contact support.