Enrichment API - Domains v2.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The purpose of this API is to provide risk ratings and reputational data for websites. The response is a JSON formatted object containing a list of website information partitioned by region and device. Any fields included in the response, but not documented herein are subject to change without notice.

Base URLs:

https://api.pixalate.com/api/v2

Email: Pixalate, Inc. Web: Pixalate, Inc.

Authentication

API Key (ApiKey)
- Parameter Name: x-api-key, in: header. Authentication and authorization is achieved by supplying your Pixalate provided API key in the header of the request. An API key may be obtained by signing up for an account on the Pixalate developer website.

Domains

Get Domains Metadata

Code samples

# You can also use wget
        curl -X GET https://api.pixalate.com/api/v2/mrt/domains \
          -H 'Accept: application/json' \
          -H 'x-api-key: API_KEY'

using System;
        using System.Collections.Generic;
        using System.Net.Http;
        using System.Net.Http.Headers;
        using System.Text;
        using System.Threading.Tasks;
        using Newtonsoft.Json;
        
        /// <<summary>>
        /// Example of Http Client
        /// <</summary>>
        public class HttpExample
        {
            private HttpClient Client { get; set; }
        
            /// <<summary>>
            /// Setup http client
            /// <</summary>>
            public HttpExample()
            {
              Client = new HttpClient();
            }
        
            /// Make a dummy request
            public async Task MakeGetRequest()
            {
              string url = "https://api.pixalate.com/api/v2/mrt/domains";
              var result = await GetAsync(url);
            }
        
            /// Performs a GET Request
            public async Task GetAsync(string url)
            {
                //Start the request
                HttpResponseMessage response = await Client.GetAsync(url);
        
                //Validate result
                response.EnsureSuccessStatusCode();
        
            }
        
        
        
        
            /// Deserialize object from request response
            private async Task DeserializeObject(HttpResponseMessage response)
            {
                //Read body 
                string responseBody = await response.Content.ReadAsStringAsync();
        
                //Deserialize Body to object
                var result = JsonConvert.DeserializeObject(responseBody);
            }
        }

package main
        
        import (
               "bytes"
               "net/http"
        )
        
        func main() {
        
            headers := map[string][]string{
                "Accept": []string{"application/json"},
                "x-api-key": []string{"API_KEY"},
            }
        
            data := bytes.NewBuffer([]byte{jsonReq})
            req, err := http.NewRequest("GET", "https://api.pixalate.com/api/v2/mrt/domains", data)
            req.Header = headers
        
            client := &http.Client{}
            resp, err := client.Do(req)
            // ...
        }


        const headers = {
          'Accept':'application/json',
          'x-api-key':'API_KEY'
        };
        
        fetch('https://api.pixalate.com/api/v2/mrt/domains',
        {
          method: 'GET',
        
          headers: headers
        })
        .then(function(res) {
            return res.json();
        }).then(function(body) {
            console.log(body);
        });

const fetch = require('node-fetch');
        
        const headers = {
          'Accept':'application/json',
          'x-api-key':'API_KEY'
        };
        
        fetch('https://api.pixalate.com/api/v2/mrt/domains',
        {
          method: 'GET',
        
          headers: headers
        })
        .then(function(res) {
            return res.json();
        }).then(function(body) {
            console.log(body);
        });

import requests
        headers = {
          'Accept': 'application/json',
          'x-api-key': 'API_KEY'
        }
        
        r = requests.get('https://api.pixalate.com/api/v2/mrt/domains', headers = headers)
        
        print(r.json())

GET /mrt/domains

The purpose of this API is to provide metadata information for domains in general. The response is a JSON formatted object containing the current user's quota state and the date the domains database was last updated.

Parameters

Name	In	Type	Required	Description
pretty	query	boolean	false	If true, return pretty JSON. Default is false.

Example responses

200 Response

{
          "database": {
            "lastUpdated": "2022-04-30"
          },
          "quota": {
            "available": 480,
            "used": 520,
            "expiry": "2022-05-01T12:45:23.234Z",
            "limit": 1000,
            "interval": 1000,
            "timeUnit": "month"
          }
        }

Responses

Status	Meaning	Description	Schema
200	OK	OK	Metadata
400	Bad Request	Bad Request - Invalid parameters in request.	None
401	Unauthorized	Unauthorized - Invalid API Key.	None
403	Forbidden	Forbidden - Quota has been exhausted, Subscription expired or needs upgrade.	None
5XX	Unknown	Server Error - The API experienced an internal error. Contact support.	None

Batch Get Domains data

Code samples

# You can also use wget
        curl -X POST https://api.pixalate.com/api/v2/mrt/domains \
          -H 'Accept: application/json' \
          -H 'x-api-key: API_KEY'

using System;
        using System.Collections.Generic;
        using System.Net.Http;
        using System.Net.Http.Headers;
        using System.Text;
        using System.Threading.Tasks;
        using Newtonsoft.Json;
        
        /// <<summary>>
        /// Example of Http Client
        /// <</summary>>
        public class HttpExample
        {
            private HttpClient Client { get; set; }
        
            /// <<summary>>
            /// Setup http client
            /// <</summary>>
            public HttpExample()
            {
              Client = new HttpClient();
            }
        
        
            /// Make a dummy request
            public async Task MakePostRequest()
            {
              string url = "https://api.pixalate.com/api/v2/mrt/domains";
        
        
              await PostAsync(null, url);
        
            }
        
            /// Performs a POST Request
            public async Task PostAsync(undefined content, string url)
            {
                //Serialize Object
                StringContent jsonContent = SerializeObject(content);
        
                //Execute POST request
                HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
            }
        
        
        
            /// Serialize an object to Json
            private StringContent SerializeObject(undefined content)
            {
                //Serialize Object
                string jsonObject = JsonConvert.SerializeObject(content);
        
                //Create Json UTF8 String Content
                return new StringContent(jsonObject, Encoding.UTF8, "application/json");
            }
        
            /// Deserialize object from request response
            private async Task DeserializeObject(HttpResponseMessage response)
            {
                //Read body 
                string responseBody = await response.Content.ReadAsStringAsync();
        
                //Deserialize Body to object
                var result = JsonConvert.DeserializeObject(responseBody);
            }
        }

package main
        
        import (
               "bytes"
               "net/http"
        )
        
        func main() {
        
            headers := map[string][]string{
                "Accept": []string{"application/json"},
                "x-api-key": []string{"API_KEY"},
            }
        
            data := bytes.NewBuffer([]byte{jsonReq})
            req, err := http.NewRequest("POST", "https://api.pixalate.com/api/v2/mrt/domains", data)
            req.Header = headers
        
            client := &http.Client{}
            resp, err := client.Do(req)
            // ...
        }


        const headers = {
          'Accept':'application/json',
          'x-api-key':'API_KEY'
        };
        
        fetch('https://api.pixalate.com/api/v2/mrt/domains',
        {
          method: 'POST',
        
          headers: headers
        })
        .then(function(res) {
            return res.json();
        }).then(function(body) {
            console.log(body);
        });

const fetch = require('node-fetch');
        
        const headers = {
          'Accept':'application/json',
          'x-api-key':'API_KEY'
        };
        
        fetch('https://api.pixalate.com/api/v2/mrt/domains',
        {
          method: 'POST',
        
          headers: headers
        })
        .then(function(res) {
            return res.json();
        }).then(function(body) {
            console.log(body);
        });

import requests
        headers = {
          'Accept': 'application/json',
          'x-api-key': 'API_KEY'
        }
        
        r = requests.post('https://api.pixalate.com/api/v2/mrt/domains', headers = headers)
        
        print(r.json())

POST /mrt/domains

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 support@pixalate.com for details on how to enable this for your account.

Parameters

Name	In	Type	Required	Description
pretty	query	boolean	false	If true, return pretty JSON. Default is false.

Example responses

200 Response

"https://dashboardcdn.pixalate.com/www/exported/Client/2022-04-12/qprdbkr9dfeoostip8ltqgmecd/apps_2022-04-12"

Responses

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request - Invalid parameters in request.	None
401	Unauthorized	Unauthorized - Invalid API Key.	None
403	Forbidden	Forbidden - Quota has been exhausted, Subscription expired or needs upgrade.	None
5XX	Unknown	Server Error - The API experienced an internal error. Contact support.	None

Get Domain Data

Code samples

# You can also use wget
        curl -X GET https://api.pixalate.com/api/v2/mrt/domains/{adDomain} \
          -H 'Accept: application/json' \
          -H 'x-api-key: API_KEY'

using System;
        using System.Collections.Generic;
        using System.Net.Http;
        using System.Net.Http.Headers;
        using System.Text;
        using System.Threading.Tasks;
        using Newtonsoft.Json;
        
        /// <<summary>>
        /// Example of Http Client
        /// <</summary>>
        public class HttpExample
        {
            private HttpClient Client { get; set; }
        
            /// <<summary>>
            /// Setup http client
            /// <</summary>>
            public HttpExample()
            {
              Client = new HttpClient();
            }
        
            /// Make a dummy request
            public async Task MakeGetRequest()
            {
              string url = "https://api.pixalate.com/api/v2/mrt/domains/{adDomain}";
              var result = await GetAsync(url);
            }
        
            /// Performs a GET Request
            public async Task GetAsync(string url)
            {
                //Start the request
                HttpResponseMessage response = await Client.GetAsync(url);
        
                //Validate result
                response.EnsureSuccessStatusCode();
        
            }
        
        
        
        
            /// Deserialize object from request response
            private async Task DeserializeObject(HttpResponseMessage response)
            {
                //Read body 
                string responseBody = await response.Content.ReadAsStringAsync();
        
                //Deserialize Body to object
                var result = JsonConvert.DeserializeObject(responseBody);
            }
        }

package main
        
        import (
               "bytes"
               "net/http"
        )
        
        func main() {
        
            headers := map[string][]string{
                "Accept": []string{"application/json"},
                "x-api-key": []string{"API_KEY"},
            }
        
            data := bytes.NewBuffer([]byte{jsonReq})
            req, err := http.NewRequest("GET", "https://api.pixalate.com/api/v2/mrt/domains/{adDomain}", data)
            req.Header = headers
        
            client := &http.Client{}
            resp, err := client.Do(req)
            // ...
        }


        const headers = {
          'Accept':'application/json',
          'x-api-key':'API_KEY'
        };
        
        fetch('https://api.pixalate.com/api/v2/mrt/domains/{adDomain}',
        {
          method: 'GET',
        
          headers: headers
        })
        .then(function(res) {
            return res.json();
        }).then(function(body) {
            console.log(body);
        });

const fetch = require('node-fetch');
        
        const headers = {
          'Accept':'application/json',
          'x-api-key':'API_KEY'
        };
        
        fetch('https://api.pixalate.com/api/v2/mrt/domains/{adDomain}',
        {
          method: 'GET',
        
          headers: headers
        })
        .then(function(res) {
            return res.json();
        }).then(function(body) {
            console.log(body);
        });

import requests
        headers = {
          'Accept': 'application/json',
          'x-api-key': 'API_KEY'
        }
        
        r = requests.get('https://api.pixalate.com/api/v2/mrt/domains/{adDomain}', headers = headers)
        
        print(r.json())

GET /mrt/domains/{adDomain}

The purpose of this API is to provide risk ratings and reputational data for websites. The response is a JSON formatted object containing a list of app information partitioned by region and device.

Parameters

Name	In	Type	Required	Description
adDomain	path	string	true	The domain name.
widget	query	array[string]	false	Filter by comma-separated list of widgets to return. All widgets are returned by default.
region	query	Region	false	Filter by region. All regions are returned by default. GLOBAL indicates aggregated traffic from all regions.
device	query	Device	false	Filter by device. All devices are returned by default.
pretty	query	boolean	false	If true, return pretty JSON. Default is false.

Enumerated Values

Parameter	Value
widget	domainOverview
widget	riskOverview
widget	domainDetails
widget	trafficQualityRisk
widget	siteRisk
widget	siteInfo
widget	brandSafetyRisk
widget	socialMediaRisk
widget	invalidTraffic
widget	inventory
widget	authorizedSellers
widget	viewability
widget	ctr
widget	trafficSources
widget	subDomains
widget	deviceDistribution
region	GLOBAL
region	US
region	NON-US
device	GLOBAL
device	desktop
device	mobile

Example responses

200 Response

{
          "status": "OK",
          "numFound": 1,
          "docs": [
            {
              "AdDomain": "example.org",
              "region": "US",
              "device": "desktop",
              "domainOverview": {
                "iabPrimaryCategory": [
                  "News"
                ],
                "iabSubCategory": [
                  null
                ],
                "hasAdsTxt": true
              },
              "riskOverview": {
                "ivt": 6.7,
                "ivtRisk": "medium",
                "viewability": 53.95,
                "viewabilityRisk": "medium",
                "brandSafetyRisk": "low",
                "risk": [
                  {
                    "region": "string",
                    "device": "string",
                    "pixalateRisk": "medium",
                    "pixalateRiskReasons": [
                      "Significantly Elevated IVT Percentage",
                      "Ad Traffic Shows Some Suspicious Characteristics"
                    ]
                  }
                ]
              },
              "domainDetails": {
                "inventory": 892920,
                "desktopTrafficRatio": 94.13,
                "mobileTrafficRatio": 5.64,
                "videoTrafficRatio": 3.16,
                "ctr": 0.05,
                "familyOfSites": 36773,
                "pixalateRisk": "low",
                "bidPriceLow": 0,
                "bidPriceHigh": 0,
                "trustedSeller": "Example Ad Seller",
                "trueReach": 6602
              },
              "trafficQualityRisk": {
                "ivtRisk": "medium",
                "clickFraudRisk": "medium",
                "viewabilityRisk": "low",
                "domainMaskingRisk": "low",
                "majorTrafficSource": "Direct"
              },
              "siteRisk": {
                "domainAge": 0,
                "hasPrivacyPolicy": true,
                "hasTermsAndConditions": true,
                "privateDomain": false,
                "corporateEmail": true,
                "adInjectionRisk": "low"
              },
              "siteInfo": {
                "owner": "Example, Inc.",
                "emailAddress": "jdoe@example.org",
                "contactNumber": "14085551212",
                "mailingAddress": "1234 Main Street, USA."
              },
              "brandSafetyRisk": {
                "adultContentRisk": "high",
                "alcoholContentRisk": "medium",
                "drugContentRisk": "medium",
                "hateSpeechRisk": "low",
                "phishingRisk": "medium",
                "malwareRisk": "medium"
              },
              "socialMediaRisk": {
                "facebookRisk": "medium",
                "linkedInRisk": "medium",
                "twitterRisk": "medium",
                "socialTrafficRatio": 0.11
              },
              "invalidTraffic": {
                "ivt": 7.76,
                "givt": 0.29,
                "sivt": 7.47,
                "givtTypes": [
                  {
                    "fraudType": "Data Center",
                    "givt": 0.29
                  }
                ],
                "sivtTypes": [
                  {
                    "fraudType": "AppSpoofing",
                    "sivt": 2.78
                  }
                ]
              },
              "inventory": {
                "byRegion": [
                  {
                    "region": "APAC",
                    "inventory": null,
                    "inventoryRatio": 6.39,
                    "ivt": 8.02,
                    "viewability": 73.3
                  }
                ],
                "byCountry": [
                  {
                    "countryName": "Romania",
                    "inventory": null,
                    "inventoryRatio": 4.01,
                    "ivt": 17.21,
                    "viewability": 57.2
                  }
                ],
                "byState": [
                  {
                    "stateName": "United States, California",
                    "inventory": null,
                    "inventoryRatio": 15.62,
                    "ivt": 5.94,
                    "viewability": 53.38
                  }
                ],
                "byAdsize": [
                  {
                    "adSize": "320x50",
                    "inventory": null,
                    "inventoryRatio": 0.1,
                    "ivt": 3.22,
                    "viewability": 56.44
                  }
                ],
                "byDma": [
                  {
                    "dma": "NEW YORK",
                    "inventory": null,
                    "inventoryRatio": 6.39,
                    "ivt": 5.45,
                    "viewability": 54.79
                  }
                ]
              },
              "authorizedSellers": [
                {
                  "exchange": "Acme Exchange",
                  "paymentType": "Direct",
                  "inventory": 30039,
                  "inventoryRatio": 12.87,
                  "ivt": 0.9,
                  "estBidLow": null,
                  "estBidHigh": null,
                  "viewability": 2.6
                }
              ],
              "viewability": {
                "viewability": 53.95,
                "byAdSize": [
                  {
                    "adSize": "728x90",
                    "inventory": 7893,
                    "inventoryRatio": 61.05,
                    "viewability": 56.04
                  }
                ]
              },
              "ctr": {
                "ctr": 6.03,
                "byAdSize": [
                  {
                    "adSize": "320x50",
                    "ctr": 1.45
                  }
                ]
              },
              "trafficSources": [
                {
                  "trafficSource": "Discovery",
                  "inventory": null,
                  "inventoryRatio": 6.39,
                  "ivt": 8.02,
                  "viewability": 73.3
                }
              ],
              "subDomains": [
                {
                  "subDomain": "mail.example.org",
                  "inventory": null,
                  "inventoryRatio": 52.39,
                  "maskingRatio": 52.39,
                  "ivt": 8.02,
                  "viewability": 73.3
                }
              ],
              "deviceDistribution": {
                "byDevice": [
                  {
                    "device": "desktop",
                    "inventory": null,
                    "inventoryRatio": 94.3,
                    "maskingRatio": 52.39,
                    "ivt": 8.02,
                    "viewability": 73.3
                  }
                ],
                "byDesktopOs": [
                  {
                    "os": "Windows 10",
                    "inventory": null,
                    "inventoryRatio": 13.63
                  }
                ],
                "byMobileOs": [
                  {
                    "os": "Android 1.x",
                    "inventory": null,
                    "inventoryRatio": 9.29
                  }
                ]
              }
            }
          ]
        }

Responses

Status	Meaning	Description	Schema
200	OK	OK	DomainList
400	Bad Request	Bad Request - Invalid parameters in request.	None
401	Unauthorized	Unauthorized - Invalid API Key.	None
403	Forbidden	Forbidden - Quota has been exhausted, Subscription expired or needs upgrade.	None
5XX	Unknown	Server Error - The API experienced an internal error. Contact support.	None

Schemas

Metadata

{
          "database": {
            "lastUpdated": "2022-04-30"
          },
          "quota": {
            "available": 480,
            "used": 520,
            "expiry": "2022-05-01T12:45:23.234Z",
            "limit": 1000,
            "interval": 1000,
            "timeUnit": "month"
          }
        }

Domains metadata information.

Properties

Name	Type	Required	Restrictions	Description
database	object	false	none	The Domains database state information.
» lastUpdated	string(date)	false	none	The date when the Domains database was last updated. The date format is YYYY-MM-DD.
quota	object	false	none	Quota state information.
» available	integer	false	none	The amount of quota available for use.
» used	integer	false	none	The amount of quota used.
» expiry	string(date)	false	none	The datetime when the quota will be refreshed back to the limit. The datetime format is YYYY-MM-DDTHH:MM:SS.SSSZ.
» limit	integer	false	none	The amount of quota to be made available for use when the quota is refreshed.
» interval	integer	false	none	The number of time units used in calculating the quota refresh datetime.
» timeUnit	string	false	none	The time unit used in calculating the quota refresh datetime.

Enumerated Values

Property	Value
timeUnit	minute
timeUnit	hour
timeUnit	day
timeUnit	week
timeUnit	month

DomainList

{
          "status": "OK",
          "numFound": 1,
          "docs": [
            {
              "AdDomain": "example.org",
              "region": "US",
              "device": "desktop",
              "domainOverview": {
                "iabPrimaryCategory": [
                  "News"
                ],
                "iabSubCategory": [
                  null
                ],
                "hasAdsTxt": true
              },
              "riskOverview": {
                "ivt": 6.7,
                "ivtRisk": "medium",
                "viewability": 53.95,
                "viewabilityRisk": "medium",
                "brandSafetyRisk": "low",
                "risk": [
                  {
                    "region": "string",
                    "device": "string",
                    "pixalateRisk": "medium",
                    "pixalateRiskReasons": [
                      "Significantly Elevated IVT Percentage",
                      "Ad Traffic Shows Some Suspicious Characteristics"
                    ]
                  }
                ]
              },
              "domainDetails": {
                "inventory": 892920,
                "desktopTrafficRatio": 94.13,
                "mobileTrafficRatio": 5.64,
                "videoTrafficRatio": 3.16,
                "ctr": 0.05,
                "familyOfSites": 36773,
                "pixalateRisk": "low",
                "bidPriceLow": 0,
                "bidPriceHigh": 0,
                "trustedSeller": "Example Ad Seller",
                "trueReach": 6602
              },
              "trafficQualityRisk": {
                "ivtRisk": "medium",
                "clickFraudRisk": "medium",
                "viewabilityRisk": "low",
                "domainMaskingRisk": "low",
                "majorTrafficSource": "Direct"
              },
              "siteRisk": {
                "domainAge": 0,
                "hasPrivacyPolicy": true,
                "hasTermsAndConditions": true,
                "privateDomain": false,
                "corporateEmail": true,
                "adInjectionRisk": "low"
              },
              "siteInfo": {
                "owner": "Example, Inc.",
                "emailAddress": "jdoe@example.org",
                "contactNumber": "14085551212",
                "mailingAddress": "1234 Main Street, USA."
              },
              "brandSafetyRisk": {
                "adultContentRisk": "high",
                "alcoholContentRisk": "medium",
                "drugContentRisk": "medium",
                "hateSpeechRisk": "low",
                "phishingRisk": "medium",
                "malwareRisk": "medium"
              },
              "socialMediaRisk": {
                "facebookRisk": "medium",
                "linkedInRisk": "medium",
                "twitterRisk": "medium",
                "socialTrafficRatio": 0.11
              },
              "invalidTraffic": {
                "ivt": 7.76,
                "givt": 0.29,
                "sivt": 7.47,
                "givtTypes": [
                  {
                    "fraudType": "Data Center",
                    "givt": 0.29
                  }
                ],
                "sivtTypes": [
                  {
                    "fraudType": "AppSpoofing",
                    "sivt": 2.78
                  }
                ]
              },
              "inventory": {
                "byRegion": [
                  {
                    "region": "APAC",
                    "inventory": null,
                    "inventoryRatio": 6.39,
                    "ivt": 8.02,
                    "viewability": 73.3
                  }
                ],
                "byCountry": [
                  {
                    "countryName": "Romania",
                    "inventory": null,
                    "inventoryRatio": 4.01,
                    "ivt": 17.21,
                    "viewability": 57.2
                  }
                ],
                "byState": [
                  {
                    "stateName": "United States, California",
                    "inventory": null,
                    "inventoryRatio": 15.62,
                    "ivt": 5.94,
                    "viewability": 53.38
                  }
                ],
                "byAdsize": [
                  {
                    "adSize": "320x50",
                    "inventory": null,
                    "inventoryRatio": 0.1,
                    "ivt": 3.22,
                    "viewability": 56.44
                  }
                ],
                "byDma": [
                  {
                    "dma": "NEW YORK",
                    "inventory": null,
                    "inventoryRatio": 6.39,
                    "ivt": 5.45,
                    "viewability": 54.79
                  }
                ]
              },
              "authorizedSellers": [
                {
                  "exchange": "Acme Exchange",
                  "paymentType": "Direct",
                  "inventory": 30039,
                  "inventoryRatio": 12.87,
                  "ivt": 0.9,
                  "estBidLow": null,
                  "estBidHigh": null,
                  "viewability": 2.6
                }
              ],
              "viewability": {
                "viewability": 53.95,
                "byAdSize": [
                  {
                    "adSize": "728x90",
                    "inventory": 7893,
                    "inventoryRatio": 61.05,
                    "viewability": 56.04
                  }
                ]
              },
              "ctr": {
                "ctr": 6.03,
                "byAdSize": [
                  {
                    "adSize": "320x50",
                    "ctr": 1.45
                  }
                ]
              },
              "trafficSources": [
                {
                  "trafficSource": "Discovery",
                  "inventory": null,
                  "inventoryRatio": 6.39,
                  "ivt": 8.02,
                  "viewability": 73.3
                }
              ],
              "subDomains": [
                {
                  "subDomain": "mail.example.org",
                  "inventory": null,
                  "inventoryRatio": 52.39,
                  "maskingRatio": 52.39,
                  "ivt": 8.02,
                  "viewability": 73.3
                }
              ],
              "deviceDistribution": {
                "byDevice": [
                  {
                    "device": "desktop",
                    "inventory": null,
                    "inventoryRatio": 94.3,
                    "maskingRatio": 52.39,
                    "ivt": 8.02,
                    "viewability": 73.3
                  }
                ],
                "byDesktopOs": [
                  {
                    "os": "Windows 10",
                    "inventory": null,
                    "inventoryRatio": 13.63
                  }
                ],
                "byMobileOs": [
                  {
                    "os": "Android 1.x",
                    "inventory": null,
                    "inventoryRatio": 9.29
                  }
                ]
              }
            }
          ]
        }

A list of domains.

Properties

Name	Type	Required	Restrictions	Description
status	Status	false	none	The returned status.
numFound	integer	false	none	The total number of matching domains.
docs	[Domain]	false	none	A list of domains.

Domain

{
          "AdDomain": "example.org",
          "region": "US",
          "device": "desktop",
          "domainOverview": {
            "iabPrimaryCategory": [
              "News"
            ],
            "iabSubCategory": [
              null
            ],
            "hasAdsTxt": true
          },
          "riskOverview": {
            "ivt": 6.7,
            "ivtRisk": "medium",
            "viewability": 53.95,
            "viewabilityRisk": "medium",
            "brandSafetyRisk": "low",
            "risk": [
              {
                "region": "string",
                "device": "string",
                "pixalateRisk": "medium",
                "pixalateRiskReasons": [
                  "Significantly Elevated IVT Percentage",
                  "Ad Traffic Shows Some Suspicious Characteristics"
                ]
              }
            ]
          },
          "domainDetails": {
            "inventory": 892920,
            "desktopTrafficRatio": 94.13,
            "mobileTrafficRatio": 5.64,
            "videoTrafficRatio": 3.16,
            "ctr": 0.05,
            "familyOfSites": 36773,
            "pixalateRisk": "low",
            "bidPriceLow": 0,
            "bidPriceHigh": 0,
            "trustedSeller": "Example Ad Seller",
            "trueReach": 6602
          },
          "trafficQualityRisk": {
            "ivtRisk": "medium",
            "clickFraudRisk": "medium",
            "viewabilityRisk": "low",
            "domainMaskingRisk": "low",
            "majorTrafficSource": "Direct"
          },
          "siteRisk": {
            "domainAge": 0,
            "hasPrivacyPolicy": true,
            "hasTermsAndConditions": true,
            "privateDomain": false,
            "corporateEmail": true,
            "adInjectionRisk": "low"
          },
          "siteInfo": {
            "owner": "Example, Inc.",
            "emailAddress": "jdoe@example.org",
            "contactNumber": "14085551212",
            "mailingAddress": "1234 Main Street, USA."
          },
          "brandSafetyRisk": {
            "adultContentRisk": "high",
            "alcoholContentRisk": "medium",
            "drugContentRisk": "medium",
            "hateSpeechRisk": "low",
            "phishingRisk": "medium",
            "malwareRisk": "medium"
          },
          "socialMediaRisk": {
            "facebookRisk": "medium",
            "linkedInRisk": "medium",
            "twitterRisk": "medium",
            "socialTrafficRatio": 0.11
          },
          "invalidTraffic": {
            "ivt": 7.76,
            "givt": 0.29,
            "sivt": 7.47,
            "givtTypes": [
              {
                "fraudType": "Data Center",
                "givt": 0.29
              }
            ],
            "sivtTypes": [
              {
                "fraudType": "AppSpoofing",
                "sivt": 2.78
              }
            ]
          },
          "inventory": {
            "byRegion": [
              {
                "region": "APAC",
                "inventory": null,
                "inventoryRatio": 6.39,
                "ivt": 8.02,
                "viewability": 73.3
              }
            ],
            "byCountry": [
              {
                "countryName": "Romania",
                "inventory": null,
                "inventoryRatio": 4.01,
                "ivt": 17.21,
                "viewability": 57.2
              }
            ],
            "byState": [
              {
                "stateName": "United States, California",
                "inventory": null,
                "inventoryRatio": 15.62,
                "ivt": 5.94,
                "viewability": 53.38
              }
            ],
            "byAdsize": [
              {
                "adSize": "320x50",
                "inventory": null,
                "inventoryRatio": 0.1,
                "ivt": 3.22,
                "viewability": 56.44
              }
            ],
            "byDma": [
              {
                "dma": "NEW YORK",
                "inventory": null,
                "inventoryRatio": 6.39,
                "ivt": 5.45,
                "viewability": 54.79
              }
            ]
          },
          "authorizedSellers": [
            {
              "exchange": "Acme Exchange",
              "paymentType": "Direct",
              "inventory": 30039,
              "inventoryRatio": 12.87,
              "ivt": 0.9,
              "estBidLow": null,
              "estBidHigh": null,
              "viewability": 2.6
            }
          ],
          "viewability": {
            "viewability": 53.95,
            "byAdSize": [
              {
                "adSize": "728x90",
                "inventory": 7893,
                "inventoryRatio": 61.05,
                "viewability": 56.04
              }
            ]
          },
          "ctr": {
            "ctr": 6.03,
            "byAdSize": [
              {
                "adSize": "320x50",
                "ctr": 1.45
              }
            ]
          },
          "trafficSources": [
            {
              "trafficSource": "Discovery",
              "inventory": null,
              "inventoryRatio": 6.39,
              "ivt": 8.02,
              "viewability": 73.3
            }
          ],
          "subDomains": [
            {
              "subDomain": "mail.example.org",
              "inventory": null,
              "inventoryRatio": 52.39,
              "maskingRatio": 52.39,
              "ivt": 8.02,
              "viewability": 73.3
            }
          ],
          "deviceDistribution": {
            "byDevice": [
              {
                "device": "desktop",
                "inventory": null,
                "inventoryRatio": 94.3,
                "maskingRatio": 52.39,
                "ivt": 8.02,
                "viewability": 73.3
              }
            ],
            "byDesktopOs": [
              {
                "os": "Windows 10",
                "inventory": null,
                "inventoryRatio": 13.63
              }
            ],
            "byMobileOs": [
              {
                "os": "Android 1.x",
                "inventory": null,
                "inventoryRatio": 9.29
              }
            ]
          }
        }

A domain.

Properties

Name	Type	Required	Restrictions	Description
AdDomain	string	false	none	The domain name.
region	Region	false	none	A geographic region. GLOBAL indicates an aggregate of all regions.
device	Device	false	none	The device. GLOBAL indicates an aggregate of all devices.
domainOverview	DomainOverview	false	none	An overview of risk for the domain.
riskOverview	RiskOverview	false	none	An overview of risk for the domain.
domainDetails	DomainDetails	false	none	Detailed information about the domain.
trafficQualityRisk	TrafficQualityRisk	false	none	An overview of domain's traffic quality.
siteRisk	SiteRisk	false	none	The risk associated with the domain name and website.
siteInfo	SiteInfo	false	none	General domain information.
brandSafetyRisk	BrandSafetyRisk	false	none	Brand safety information.
socialMediaRisk	SocialMediaRisk	false	none	Brand safety information.
invalidTraffic	InvalidTraffic	false	none	The percentage of invalid traffic associated with each Pixalate's taxonomy of GIVT and SIVT invalid traffic types.
inventory	Inventory	false	none	The estimated volume of programmatic ad impressions broken down by device, region, country, DMA.
authorizedSellers	AuthorizedSellers	false	none	The contribution of various sell side platforms to programmatic ad impressions sold on the app.
viewability	Viewability	false	none	The average viewability, according the IAB standard of 50% in view for at least 1 second, for display advertisements in the domain.
ctr	Ctr	false	none	Information about Click Through Rate for this domain.
trafficSources	TrafficSources	false	none	The volume of programmatic ad impressions broken down by traffic source.
subDomains	SubDomains	false	none	The volume of programmatic ad impressions broken down by sub domains.
deviceDistribution	DeviceDistribution	false	none	The estimated volume of programmatic ad impressions broken down by device (desktop, mobile), by desktop OS, and by mobile OS.

DomainOverview

{
          "iabPrimaryCategory": [
            "News"
          ],
          "iabSubCategory": [
            null
          ],
          "hasAdsTxt": true
        }

An overview of risk for the domain.

Properties

Name	Type	Required	Restrictions	Description
iabPrimaryCategory	[string]	false	none	The IAB primary categories.
iabSubCategory	[string]	false	none	The IAB sub categories.
hasAdsTxt	boolean	false	none	A true indicates Ads.txt is enabled for the domain.

RiskOverview

{
          "ivt": 6.7,
          "ivtRisk": "medium",
          "viewability": 53.95,
          "viewabilityRisk": "medium",
          "brandSafetyRisk": "low",
          "risk": [
            {
              "region": "string",
              "device": "string",
              "pixalateRisk": "medium",
              "pixalateRiskReasons": [
                "Significantly Elevated IVT Percentage",
                "Ad Traffic Shows Some Suspicious Characteristics"
              ]
            }
          ]
        }

An overview of risk for the domain.

Properties

Name	Type	Required	Restrictions	Description
ivt	number	false	none	Percentage of Invalid traffic associated with advertising transactions for the domain.
ivtRisk	string	false	none	The invalid traffic risk for the domain.
viewability	number	false	none	Percentage of invalid traffic associated with advertising transactions for the domain.
viewabilityRisk	string	false	none	The viewability risk for the domain.
brandSafetyRisk	string	false	none	The overall risk to advertise Brand Safety from the domain.
risk	[object]	false	none	Overall pixalate's unique advertising risk assessment based on blended risk factors including brand safety, invalid traffic and inventory for all regions and devices. Risk is broken down by region and device.
» region	string	false	none	The region.
» device	string	false	none	The device.
» pixalateRisk	string	false	none	Pixalate's unique overall risk assessment for the domain.
» pixalateRiskReasons	RiskReasons	false	none	A list of reasons that the domain is at risk.

Enumerated Values

Property	Value
ivtRisk	low
ivtRisk	medium
ivtRisk	high
viewabilityRisk	low
viewabilityRisk	medium
viewabilityRisk	high
brandSafetyRisk	low
brandSafetyRisk	medium
brandSafetyRisk	high
pixalateRisk	low
pixalateRisk	medium
pixalateRisk	high

DomainDetails

{
          "inventory": 892920,
          "desktopTrafficRatio": 94.13,
          "mobileTrafficRatio": 5.64,
          "videoTrafficRatio": 3.16,
          "ctr": 0.05,
          "familyOfSites": 36773,
          "pixalateRisk": "low",
          "bidPriceLow": 0,
          "bidPriceHigh": 0,
          "trustedSeller": "Example Ad Seller",
          "trueReach": 6602
        }

Detailed information about the domain.

Properties

Name	Type	Required	Restrictions	Description
inventory	integer	false	none	The estimated number of monthly impressions this domain makes available programmatically.
desktopTrafficRatio	number	false	none	The percentage of desktop ads trafficked on the domain.
mobileTrafficRatio	number	false	none	The percentage of mobile ads trafficked on the domain.
videoTrafficRatio	number	false	none	The percentage of video ads trafficked on the domain.
ctr	number	false	none	Average CTR of the domain
familyOfSites	integer	false	none	The number of related websites.
pixalateRisk	string	false	none	Overall pixalate's unique advertising risk assessment based on blended risk factors including brand safety, invalid traffic and inventory.
bidPriceLow	string	false	none	Low bid price in US dollars.
bidPriceHigh	string	false	none	High bid price in US dollars.
trustedSeller	string	false	none	Authorized trusted seller.
trueReach	string	false	none	The estimated number of unique users per 1 Million internet users that can be reached on this domain.

Enumerated Values

Property	Value
pixalateRisk	low
pixalateRisk	medium
pixalateRisk	high

TrafficQualityRisk

{
          "ivtRisk": "medium",
          "clickFraudRisk": "medium",
          "viewabilityRisk": "low",
          "domainMaskingRisk": "low",
          "majorTrafficSource": "Direct"
        }

An overview of domain's traffic quality.

Properties

Name	Type	Required	Restrictions	Description
ivtRisk	string	false	none	The invalid traffic risk for the domain.
clickFraudRisk	string	false	none	The click fraud risk for the domain.
viewabilityRisk	string	false	none	The viewability Risk for the domain.
domainMaskingRisk	string	false	none	The domain masking risk for the domain.
majorTrafficSource	string	false	none	The major traffic source for the domain.

Enumerated Values

Property	Value
ivtRisk	low
ivtRisk	medium
ivtRisk	high
clickFraudRisk	low
clickFraudRisk	medium
clickFraudRisk	high
viewabilityRisk	low
viewabilityRisk	medium
viewabilityRisk	high
domainMaskingRisk	low
domainMaskingRisk	medium
domainMaskingRisk	high

SiteRisk

{
          "domainAge": 0,
          "hasPrivacyPolicy": true,
          "hasTermsAndConditions": true,
          "privateDomain": false,
          "corporateEmail": true,
          "adInjectionRisk": "low"
        }

The risk associated with the domain name and website.

Properties

Name	Type	Required	Restrictions	Description
domainAge	number	false	none	The age of the domain in years.
hasPrivacyPolicy	boolean	false	none	A true indicates that the website has a privacy policy.
hasTermsAndConditions	boolean	false	none	A true indicates that the website has terms and conditions.
privateDomain	boolean	false	none	A true indicates that the domain is privately registered.
corporateEmail	boolean	false	none	A true indicates that the domain has been registered with a corporate email.
adInjectionRisk	string	false	none	The ad injection risk of the domain.

Enumerated Values

Property	Value
adInjectionRisk	low
adInjectionRisk	medium
adInjectionRisk	high

SiteInfo

{
          "owner": "Example, Inc.",
          "emailAddress": "jdoe@example.org",
          "contactNumber": "14085551212",
          "mailingAddress": "1234 Main Street, USA."
        }

General domain information.

Properties

Name	Type	Required	Restrictions	Description
owner	string	false	none	Owner of the domain.
emailAddress	string	false	none	The contact email address.
contactNumber	string	false	none	The contact phone number.
mailingAddress	string	false	none	The mailing address.

BrandSafetyRisk

{
          "adultContentRisk": "high",
          "alcoholContentRisk": "medium",
          "drugContentRisk": "medium",
          "hateSpeechRisk": "low",
          "phishingRisk": "medium",
          "malwareRisk": "medium"
        }

Brand safety information.

Properties

Name	Type	Required	Restrictions	Description
adultContentRisk	string	false	none	The risk to brand safety from adult themed content based on textual analysis of the domain and its descriptive content.
alcoholContentRisk	string	false	none	The risk to brand safety from Alcohol themed content based on textual analysis of the domain and its descriptive content.
drugContentRisk	string	false	none	The risk to brand safety from drug themed content based on textual analysis of the domain and its descriptive content.
hateSpeechRisk	string	false	none	The risk to brand safety from hate speech content based on textual analysis of the domain and its descriptive content.
phishingRisk	string	false	none	The risk to brand safety from phishing.
malwareRisk	string	false	none	The risk to brand safety from malware.

Enumerated Values

Property	Value
adultContentRisk	low
adultContentRisk	medium
adultContentRisk	high
alcoholContentRisk	low
alcoholContentRisk	medium
alcoholContentRisk	high
drugContentRisk	low
drugContentRisk	medium
drugContentRisk	high
hateSpeechRisk	low
hateSpeechRisk	medium
hateSpeechRisk	high
phishingRisk	low
phishingRisk	medium
phishingRisk	high
malwareRisk	low
malwareRisk	medium
malwareRisk	high

SocialMediaRisk

{
          "facebookRisk": "medium",
          "linkedInRisk": "medium",
          "twitterRisk": "medium",
          "socialTrafficRatio": 0.11
        }

Brand safety information.

Properties

Name	Type	Required	Restrictions	Description
facebookRisk	string	false	none	The Facebook risk. Low social media engagement on Facebook can be a risk factor.
linkedInRisk	string	false	none	The Linked In risk. Low social media engagement on LinkedIn can be a risk factor.
twitterRisk	string	false	none	The Twitter In risk. Low social media engagement on Twitter can be a risk factor.
socialTrafficRatio	number	false	none	Percentage of social traffic to the site.

Enumerated Values

Property	Value
facebookRisk	low
facebookRisk	medium
facebookRisk	high
linkedInRisk	low
linkedInRisk	medium
linkedInRisk	high
twitterRisk	low
twitterRisk	medium
twitterRisk	high

InvalidTraffic

{
          "ivt": 7.76,
          "givt": 0.29,
          "sivt": 7.47,
          "givtTypes": [
            {
              "fraudType": "Data Center",
              "givt": 0.29
            }
          ],
          "sivtTypes": [
            {
              "fraudType": "AppSpoofing",
              "sivt": 2.78
            }
          ]
        }

The percentage of invalid traffic associated with each Pixalate's taxonomy of GIVT and SIVT invalid traffic types.

Properties

Name	Type	Required	Restrictions	Description
ivt	number	false	none	The total percentage of non-human traffic measured on the domain.
givt	number	false	none	GIVT refers to General Invalid Traffic - Deterministically judged to be non-human traffic; high to very high risk.
sivt	number	false	none	SIVT refers to Sophisticated Invalid Traffic - Probabilistically judged to be non-human traffic using advanced statistical detection methods; moderate to high risk traffic.
givtTypes	[object]	false	none	The percentage of invalid traffic associated with each Pixalate's taxonomy of GIVT invalid traffic types.
» fraudType	string	false	none	The type of SIVT fraud.
» givt	number	false	none	GIVT refers to General Invalid Traffic - Deterministically judged to be non-human traffic; high to very high risk.
sivtTypes	[object]	false	none	The percentage of invalid traffic associated with each Pixalate's taxonomy of SIVT invalid traffic types.
» fraudType	string	false	none	The type of SIVT fraud.
» sivt	number	false	none	SIVT refers to Sophisticated Invalid Traffic - Probabilistically judged to be non-human traffic using advanced statistical detection methods; moderate to high risk traffic.

Inventory

{
          "byRegion": [
            {
              "region": "APAC",
              "inventory": null,
              "inventoryRatio": 6.39,
              "ivt": 8.02,
              "viewability": 73.3
            }
          ],
          "byCountry": [
            {
              "countryName": "Romania",
              "inventory": null,
              "inventoryRatio": 4.01,
              "ivt": 17.21,
              "viewability": 57.2
            }
          ],
          "byState": [
            {
              "stateName": "United States, California",
              "inventory": null,
              "inventoryRatio": 15.62,
              "ivt": 5.94,
              "viewability": 53.38
            }
          ],
          "byAdsize": [
            {
              "adSize": "320x50",
              "inventory": null,
              "inventoryRatio": 0.1,
              "ivt": 3.22,
              "viewability": 56.44
            }
          ],
          "byDma": [
            {
              "dma": "NEW YORK",
              "inventory": null,
              "inventoryRatio": 6.39,
              "ivt": 5.45,
              "viewability": 54.79
            }
          ]
        }

The estimated volume of programmatic ad impressions broken down by device, region, country, DMA.

Properties

Name	Type	Required	Restrictions	Description
byRegion	[object]	false	none	The estimated volume of programmatic ad impressions broken down by region.
» region	string	false	none	The region.
» inventory	integer	false	none	The estimated volume of programmatic ad impressions by region.
» inventoryRatio	number	false	none	The estimated percentage of inventory by region.
» ivt	number	false	none	The total percentage of non-human traffic measured on the app by region.
» viewability	number	false	none	The average viewability for impressions by region.
byCountry	[object]	false	none	The estimated volume of programmatic ad impressions broken down by country.
» countryName	string	false	none	The country.
» inventory	integer	false	none	The estimated volume of programmatic ad impressions by country.
» inventoryRatio	number	false	none	The estimated percentage of inventory by country.
» ivt	number	false	none	The total percentage of non-human traffic measured on the app by country.
» viewability	number	false	none	The average viewability for impressions by country.
byState	[object]	false	none	The estimated volume of programmatic ad impressions broken down by state.
» stateName	string	false	none	The state.
» inventory	integer	false	none	The estimated volume of programmatic ad impressions by state.
» inventoryRatio	number	false	none	The estimated percentage of inventory by state.
» ivt	number	false	none	The total percentage of non-human traffic measured on the app by state.
» viewability	number	false	none	The average viewability for impressions by state.
byAdsize	[object]	false	none	The estimated volume of programmatic ad impressions broken down by ad size.
» adSize	string	false	none	The ad size.
» inventory	integer	false	none	The estimated volume of programmatic ad impressions by ad size.
» inventoryRatio	number	false	none	The estimated percentage of inventory by ad size.
» ivt	number	false	none	The total percentage of non-human traffic measured on the app by ad size.
» viewability	number	false	none	The average viewability for impressions by ad size.
byDma	[object]	false	none	The estimated volume of programmatic ad impressions broken down by DMA.
» dma	string	false	none	The DMA name.
» inventory	integer	false	none	The estimated volume of programmatic ad impressions by DMA.
» inventoryRatio	number	false	none	The estimated percentage of inventory by DMA.
» ivt	number	false	none	The total percentage of non-human traffic measured on the app by DMA.
» viewability	number	false	none	The average viewability for impressions by DMA.

AuthorizedSellers

[
          {
            "exchange": "Acme Exchange",
            "paymentType": "Direct",
            "inventory": 30039,
            "inventoryRatio": 12.87,
            "ivt": 0.9,
            "estBidLow": null,
            "estBidHigh": null,
            "viewability": 2.6
          }
        ]

The contribution of various sell side platforms to programmatic ad impressions sold on the app.

Properties

Name	Type	Required	Restrictions	Description
exchange	string	false	none	The name of the exchange.
paymentType	string	false	none	The payment type.
inventory	integer	false	none	The estimated number of monthly impressions this domain makes available programmatically by this seller.
inventoryRatio	number	false	none	The average inventory ratio for ad impressions on the domain by this seller.
ivt	number	false	none	The average IVT for ad impressions on the domain by this seller.
estBidLow	number	false	none	The estimate low bid for ads on the domain by this seller.
estBidHigh	number	false	none	The estimate high bid for ads on the domain by this seller.
viewability	number	false	none	The average viewability for ad impressions on the domain by this seller.

Viewability

{
          "viewability": 53.95,
          "byAdSize": [
            {
              "adSize": "728x90",
              "inventory": 7893,
              "inventoryRatio": 61.05,
              "viewability": 56.04
            }
          ]
        }

The average viewability, according the IAB standard of 50% in view for at least 1 second, for display advertisements in the domain.

Properties

Name	Type	Required	Restrictions	Description
viewability	number	false	none	The average viewability for all display ad impressions in the domain.
byAdSize	[object]	false	none	The risk of IAB viewability standards not being met for ad impressions on the domain broken down by ad size.
» adSize	string	false	none	The size of the ad.
» inventory	integer	false	none	The estimated inventory down by ad size.
» inventoryRatio	number	false	none	The estimated percentage of inventory by ad size.
» viewability	number	false	none	The average viewability for impressions by ad size.

Ctr

{
          "ctr": 6.03,
          "byAdSize": [
            {
              "adSize": "320x50",
              "ctr": 1.45
            }
          ]
        }

Information about Click Through Rate for this domain.

Properties

Name	Type	Required	Restrictions	Description
ctr	number	false	none	The overall average CTR for this domain.
byAdSize	[object]	false	none	The CTR for this domain broken down by ad size.
» adSize	string	false	none	The ad size.
» ctr	number	false	none	The Click Through Rate by ad size.

TrafficSources

[
          {
            "trafficSource": "Discovery",
            "inventory": null,
            "inventoryRatio": 6.39,
            "ivt": 8.02,
            "viewability": 73.3
          }
        ]

The volume of programmatic ad impressions broken down by traffic source.

Properties

Name	Type	Required	Restrictions	Description
trafficSource	string	false	none	The traffic source.
inventory	integer	false	none	The estimated volume of programmatic ad impressions by traffic source.
inventoryRatio	number	false	none	The estimated percentage of inventory by traffic source.
ivt	number	false	none	The total percentage of non-human traffic measured on the app by traffic source.
viewability	number	false	none	The average viewability for impressions by traffic source.

SubDomains

[
          {
            "subDomain": "mail.example.org",
            "inventory": null,
            "inventoryRatio": 52.39,
            "maskingRatio": 52.39,
            "ivt": 8.02,
            "viewability": 73.3
          }
        ]

The volume of programmatic ad impressions broken down by sub domains.

Properties

Name	Type	Required	Restrictions	Description
subDomain	string	false	none	The sub domain.
inventory	integer	false	none	The estimated volume of programmatic ad impressions by sub domain.
inventoryRatio	number	false	none	The estimated percentage of inventory by sub domain.
maskingRatio	number	false	none	The estimated percentage of masking by sub domain.
ivt	number	false	none	The total percentage of non-human traffic measured by sub domain.
viewability	number	false	none	The average viewability for impressions by sub domain.

DeviceDistribution

{
          "byDevice": [
            {
              "device": "desktop",
              "inventory": null,
              "inventoryRatio": 94.3,
              "maskingRatio": 52.39,
              "ivt": 8.02,
              "viewability": 73.3
            }
          ],
          "byDesktopOs": [
            {
              "os": "Windows 10",
              "inventory": null,
              "inventoryRatio": 13.63
            }
          ],
          "byMobileOs": [
            {
              "os": "Android 1.x",
              "inventory": null,
              "inventoryRatio": 9.29
            }
          ]
        }

The estimated volume of programmatic ad impressions broken down by device (desktop, mobile), by desktop OS, and by mobile OS.

Properties

Name	Type	Required	Restrictions	Description
byDevice	[object]	false	none	The estimated volume of programmatic ad impressions broken down by device.
» device	string	false	none	The device
» inventory	integer	false	none	The estimated volume of programmatic ad impressions by device.
» inventoryRatio	number	false	none	The estimated percentage of inventory by device.
» maskingRatio	number	false	none	The estimated percentage of masking by device.
» ivt	number	false	none	The total percentage of non-human traffic measured by device.
» viewability	number	false	none	The average viewability for impressions by device.
byDesktopOs	[object]	false	none	The estimated volume of programmatic ad impressions broken down by desktop OS.
» os	string	false	none	The operating system.
» inventory	integer	false	none	The estimated volume of programmatic ad impressions by desktop OS.
» inventoryRatio	number	false	none	The estimated percentage of inventory by desktop OS.
byMobileOs	[object]	false	none	The estimated volume of programmatic ad impressions broken down by mobile OS.
» os	string	false	none	The operating system.
» inventory	integer	false	none	The estimated volume of programmatic ad impressions by mobile OS.
» inventoryRatio	number	false	none	The estimated percentage of inventory by mobile OS.

Device

"desktop"

The device. GLOBAL indicates an aggregate of all devices.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The device. GLOBAL indicates an aggregate of all devices.

Enumerated Values

Property	Value
anonymous	GLOBAL
anonymous	desktop
anonymous	mobile

Region

"US"

A geographic region. GLOBAL indicates an aggregate of all regions.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	A geographic region. GLOBAL indicates an aggregate of all regions.

Enumerated Values

Property	Value
anonymous	GLOBAL
anonymous	US
anonymous	NON-US

Status

"OK"

The returned status.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The returned status.

Enumerated Values

Property	Value
anonymous	OK
anonymous	ERR

Widget

"domainOverview"

The identifier for a predefined subset of all the domain information available. If not supplied, usually indicates all widgets.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The identifier for a predefined subset of all the domain information available. If not supplied, usually indicates all widgets.

Enumerated Values

Property	Value
anonymous	domainOverview
anonymous	riskOverview
anonymous	domainDetails
anonymous	trafficQualityRisk
anonymous	siteRisk
anonymous	siteInfo
anonymous	brandSafetyRisk
anonymous	socialMediaRisk
anonymous	invalidTraffic
anonymous	inventory
anonymous	authorizedSellers
anonymous	viewability
anonymous	ctr
anonymous	trafficSources
anonymous	subDomains
anonymous	deviceDistribution

RiskReasons

[
          "Significantly Elevated IVT Percentage",
          "Ad Traffic Shows Some Suspicious Characteristics"
        ]

A list of reasons that the domain is at risk.

Properties

None

Ad Fraud API

Enrichment API

SCO Validation & Verification API

Getting Started

Enrichment API

Ad Fraud API

SCO Validation & Verification API

Video Tutorials

API Documentation

Enrichment API - Domains v2.0.0

Authentication

Domains

Get Domains Metadata

Parameters

Responses

Batch Get Domains data

Parameters

Responses

Get Domain Data

Parameters

Enumerated Values

Responses

Schemas

Metadata

Properties

Enumerated Values

DomainList

Properties

Domain

Properties

DomainOverview

Properties

RiskOverview

Properties

Enumerated Values

DomainDetails

Properties

Enumerated Values

TrafficQualityRisk

Properties

Enumerated Values

SiteRisk

Properties

Enumerated Values

SiteInfo

Properties

BrandSafetyRisk

Properties

Enumerated Values

SocialMediaRisk

Properties

Enumerated Values

InvalidTraffic

Properties

Inventory

Properties

AuthorizedSellers

Properties

Viewability

Properties

Ctr

Properties

TrafficSources

Properties

SubDomains

Properties

DeviceDistribution

Properties

Device

Properties

Enumerated Values

Region

Properties

Enumerated Values

Status

Properties

Enumerated Values

Widget

Properties

Enumerated Values