Publisher Blacklist API for Singular Fraud Prevention

Follow
Avatar
Product Team
Updated

Get Publisher Black List

Usage

Use this endpoint to retrieve the publisher blacklist configured in Singular's fraud product.

GET https://api.singular.net/api/fraud/blacklists

Query Parameters

Parameter Required Format Description Example
api_key v String API key provided in the Singular console  
blacklist_type v String The type of blacklist. Should be set to "publisher" publisher
csv v String Will format output in csv if "true" true

Example Output

{
  "data": {
    "Google AdWords": [
      {
        "publisher_name": "AdMob Publisher",
        "publisher_id": "ca-app-pub-123456789"
      },
      {
        "publisher_hashed_id": "abc123def456",
        "sub_publisher": "sub_pub_001"
      }
    ]
  }
}

Set Publisher Black List

Usage

Use this endpoint upload a publisher blacklist for use in Singular's fraud product. Uploading a blacklist will overwrite the existing blacklist.

To apply incremental changes:

  1. Use the GET endpoint to retrieve the current blacklist
  2. Modify the retrieved "data" payload to reflect your updates
  3. Re-upload the full modified payload using POST
POST https://api.singular.net/api/fraud/blacklists?api_key=[api_key]&blacklist_type=publisher
Body

The request body must include a "data" object. Within this object, each key represents a partner name ("source" in Singular reporting) and the value is an array of publisher objects associated with the partner. Each publisher object must include at least one or both of "publisher_name" and "publisher_id".

{
  "data": {
    "<Partner Name>": [
      {
        "publisher_name": "<Publisher Name>",
        "publisher_id": "<Publisher ID>"
      },
      ..
    ],
    "<Another Partner Name>": [
      {
        "publisher_name": "<Publisher Name>",
        "publisher_id": "<Publisher ID>"
      },
      ..
  }
}

      

Sample Request Body

{
  "data": {
    "Google AdWords": [
      {
        "publisher_name": "AdMob Publisher",
        "publisher_id": "ca-app-pub-123456789"
      },
      {
        "publisher_hashed_id": "abc123def456",
        "sub_publisher": "sub_pub_001"
      }
    ]
  }
}