Reputation API
Note After July 1, 2020, requests to the v0.4 endpoints will no longer be supported and may stop to responses. As a result, before July 1, 2020, you will need to update your requests to use the v3 endpoint. How to upgrade from v0.4 request to v3 requests
targets
The targets API is used for requesting reputations for one or multiple targets.
Method: GET
Host: scorecard.api.mywot.com
Path: /v3/targets
Query structure and parameters
t - a target name. This parameter can appear once or multiple times (Per plan).
For example: /v3/targets?t=target1&t=target2&t=target3
Note
- the full request path must also be less than 8 KiB or it will be rejected.
- All plans limited to 10 targets (if you need more, reach our team here).
Headers information
‘x-user-id’ - your WOT ID (How to find my ID)
‘x-api-key’ - API Key (Your API key)
Curl example
curl -H "x-user-id: userID" -H "x-api-key: api-key" -X
GET https://scorecard.api.mywot.com/v3/targets?t=hbo.com&t=google.com
Return codes
Success:
Upon success, HTTP status code 200 OK is returned.
Error Cases:
- If the request included an invalid API key, HTTP status code 403 is returned
- If the request includes incorrect or missing required parameters, HTTP status code 400 is returned.
- If you have exceeded your request quota, HTTP status code 429 is returned.
- If a server-side error occurred, HTTP status code 500 is returned.
Output
The API returns an array of results (1 per target) in a JSON format. Each result contains reputations, categories, and third-party blacklist information. Each target result contains the following:
- The response object has one attribute for each target, named by the unchanged target name given in the host's parameter.
- Each target object has a target attribute, which contains the normalized target name.
- Safety and ChildSafety attributes which consist of:
- status - One of the predefined strings representing if the target is generally safe/safe (Currently not supported for ChildSafety). Possible values are: SAFE, NOT_SAFE, UNKNOWN, SUSPICIOUS
- reputation - integer between 0-100. The target’s reputation score for safety/child safety.
- confidence - integer between 0-100. The confidence WOT’s algorithm attributes to the above score.
- Each target object also may have a categories array, which contains one or more category identifier attributes, the category friendly name, and their confidence values.
Example of use
Request:
curl -H "x-user-id: userID" -H "x-api-key: api-key" -X
GET https://scorecard.api.mywot.com/v3/targets?t=test-example.com?t=blacklist-example.co.tz&t=adult-example.com
Response:
[
{
"target": "test-example.com",
"safety": {
"status": "UNKNOWN",
"reputations": 40,
"confidence": 28
},
"childSafety": {
"reputations": 45,
"confidence": 29
},
"categories": [
{
"id": 103,
"name": "phishing",
"confidence": 4
},
{
"id": 104,
"name": "scam",
"confidence": 3
}
]
},
{
"target": "blacklist-example.co.tz",
"safety": {
"status": "NOT_SAFE",
"reputations": 27,
"confidence": 8
},
"childSafety": {},
"categories": [
{
"id": 103,
"name": "phishing",
"confidence": 51
}
],
"blackList": [
"phishing"
]
},
{
"target": "adult-example.com",
"safety": {
"status": "SAFE",
"reputations": 85,
"confidence": 49
},
"childSafety": {
"reputations": 9,
"confidence": 50
},
"categories": [
{
"id": 401,
"name": "adult content",
"confidence": 96
},
{
"id": 501,
"name": "good site",
"confidence": 51
}
]
}
]
Comments
0 comments
Article is closed for comments.