API Documentation

MRT Apps v2

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 mobile applications. The response is a JSON formatted object containing a list of app information partitioned by region and device. Note that while the API may return more fields then are document here.

Authentication

Base URLs:

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

Authentication

  • API Key (ApiKey)
    • Parameter Name: x-api-key, in: header.

MRT Apps

getapps

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'API_KEY'
}

r = requests.get('https://api.pixalate.com/api/v2/apps/{appId}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.pixalate.com/api/v2/apps/{appId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /apps/{appId}

app Ratings Lookup

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

Parameters

Name In Type Required Description
appId path string true The app's unique identifier. A package name on Google Play or a track id on Apple app Store.
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. GLOBAL indicates aggregated traffic from all devices.

Enumerated Values

Parameter Value
widget appOverview
widget appDetails
widget pixalateAdvisories
widget apAdvisories
widget riskOverview
widget developerOverview
widget trafficOverview
widget brandSafety
widget appPermissions
widget trafficOverlap
widget authorizedSellers
widget invalidTraffic
widget viewability
widget inventory
widget ctr
widget availableCountries
widget rankings
widget rankingsByCountry
region GLOBAL
region NA
region EMEA
region LATAM
region APAC
device GLOBAL
device smartphone
device tablet

Example responses

200 Response

{
  "status": "OK",
  "numFound": 1,
  "docs": [
    {
      "appId": "1407852246",
      "region": "APAC",
      "device": "smartphone",
      "appStore": "android",
      "appOverview": {
        "appTitle": "Example App",
        "screenshotUrls": [
          [
            "https://example.com/image/screenshot-1.png",
            "https://example.com/image/screenshot-2.png"
          ]
        ],
        "description": "An example app.",
        "iabPrimaryCategory": [
          [
            "Video Gaming"
          ]
        ],
        "iabSubCategory": [
          [
            "Mobile Games"
          ]
        ],
        "appStoreCategories": [
          [
            "Games"
          ]
        ],
        "delistedDate": "2021-10-30",
        "delistedApp": false,
        "hasDangerousPermissions": false
      },
      "appDetails": {
        "bundleId": "com.example.ios",
        "trackId": "1407852246",
        "appStoreUrl": "https://apps.apple.com/us/app/example/id1407852246?uo=4",
        "appLastUpdatedDate": "2021-10-30",
        "trustedSeller": "Example",
        "incentivizedActivity": true,
        "downloadRange": "500000000 - 1000000000",
        "averageUserRating": 4,
        "contentRating": "Everyone",
        "blocklisted": false,
        "blocklistedReasons": [
          "App is No Longer in Active Use",
          "The app is a VPN"
        ],
        "adCapabilities": {
          "topDevice": "Generic Android",
          "displayTopAdsize": "336x280",
          "videoTopAdsize": "768x1024",
          "displayContribution": 95.23,
          "videoContribution": 4.77,
          "hyperLocationAvailability": 98.78,
          "mraidVersion": "3.0",
          "adsDetected": true
        },
        "interactiveELements": [
          "Shares Location",
          "Users Interact"
        ]
      },
      "pixalateAdvisories": {
        "hasAppAdsTxt": false,
        "delistedApp": true,
        "delistedDate": "2021-10-30",
        "hasDangerousPermissions": false,
        "blocklisted": false,
        "privateDomain": false,
        "hasTermsAndConditions": true,
        "hasPrivacyPolicy": true
      },
      "apAdvisories": [
        [
          "An example advisory",
          "Another advisory"
        ]
      ],
      "riskOverview": {
        "ivt": 10.12,
        "ivtRisk": "medium",
        "viewability": 66.05,
        "viewabilityRisk": "medium",
        "descriptionBrandSafetyRisk": "low",
        "contentBrandSafetyRisk": "low",
        "overallIvtPermissionRisk": "low",
        "risk": [
          {
            "region": "APAC",
            "device": "smartphone",
            "pixalateRisk": "medium",
            "pixalateRiskReasons": [
              "Significantly Elevated IVT Percentage",
              "Ad Traffic Shows Some Suspicious Characteristics"
            ]
          }
        ]
      },
      "developerOverview": {
        "developerName": "Acme Apps",
        "developerLocation": "J. Doe, Main Street, Anywhere USA",
        "developerEmail": "jdoe@example.org",
        "developerCountry": "US",
        "developerWebsite": "https://www.example.org",
        "developerTotalApps": 4,
        "privateDomain": false,
        "hasTermsAndConditions": true,
        "hasPrivacyPolicy": true,
        "facebookRisk": "low",
        "linkedInRisk": "low",
        "twitterRisk": "low"
      },
      "trafficOverview": {
        "spoofingRisk": "low",
        "locationMaskingRisk": "low",
        "advertisingIvtRisk": "low",
        "clickIvtRisk": "low",
        "viewabilityRisk": "low",
        "estimatedDailyActiveUsers": 1000000,
        "estimatedMonthlyActiveUsers": 20000000,
        "inventory": 22000000,
        "adSpend": 69000
      },
      "brandSafety": {
        "descriptionBrandSafety": {
          "descriptionBrandSafetyRisk": "medium",
          "advisoriesRisk": "medium",
          "adultContentRisk": "high",
          "drugContentRisk": "medium",
          "alcoholContentRisk": "medium",
          "hateSpeechRisk": "low",
          "offensiveContentRisk": "medium",
          "gamblingContentRisk": "medium",
          "violenceContentRisk": "low"
        },
        "contentBrandSafety": {
          "contentBrandSafetyRisk": "medium",
          "adultRisk": "low",
          "violenceRisk": "medium",
          "imageData": [
            {
              "url": "https://example.org/images/kxipXQ3huWkwsqokX66euP.png",
              "text": "Weather Radar",
              "violenceRisk": "low",
              "spoofRisk": "low",
              "medicalRisk": "low",
              "adultRisk": "low"
            }
          ]
        }
      },
      "appPermissions": {
        "ivtPermissionRisk": "medium",
        "permissions": [
          {
            "name": "ACCESS_BACKGROUND_LOCATION",
            "description": "Allows an app to access location in the background.",
            "isDangerous": "false;",
            "ivtPermissonRisk": "medium"
          }
        ]
      },
      "trafficOverlap": {
        "userOverlap": 8.7,
        "inventoryOverlap": 3.1
      },
      "authorizedSellers": [
        {}
      ],
      "invalidTraffic": {
        "ivt": 0,
        "givt": 0,
        "sivt": 0,
        "givtTypes": [
          {
            "fraudType": "string",
            "givt": 0,
            "sivt": 0
          }
        ],
        "sivtTypes": [
          {
            "fraudType": "string",
            "givt": 0,
            "sivt": 0
          }
        ]
      },
      "viewability": {
        "viewability": 66.05,
        "viewabilityRisk": "medium",
        "byAdSizes": [
          {
            "adSize": "728x90",
            "inventory": 22360289,
            "inventoryRatio": 66.05,
            "viewability": 66.05
          }
        ]
      },
      "inventory": {
        "byDevice": {
          "device": "string",
          "inventory": 0,
          "inventoryRatio": 0,
          "ivt": 0,
          "viewability": 0
        }
      },
      "ctr": {
        "appId": "string"
      },
      "availableCountries": {
        "appId": "string"
      },
      "rankings": {
        "appId": "string"
      },
      "rankingsByCountry": {
        "appId": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK AppList

Schemas

AppList

{
  "status": "OK",
  "numFound": 1,
  "docs": [
    {
      "appId": "1407852246",
      "region": "APAC",
      "device": "smartphone",
      "appStore": "android",
      "appOverview": {
        "appTitle": "Example App",
        "screenshotUrls": [
          [
            "https://example.com/image/screenshot-1.png",
            "https://example.com/image/screenshot-2.png"
          ]
        ],
        "description": "An example app.",
        "iabPrimaryCategory": [
          [
            "Video Gaming"
          ]
        ],
        "iabSubCategory": [
          [
            "Mobile Games"
          ]
        ],
        "appStoreCategories": [
          [
            "Games"
          ]
        ],
        "delistedDate": "2021-10-30",
        "delistedApp": false,
        "hasDangerousPermissions": false
      },
      "appDetails": {
        "bundleId": "com.example.ios",
        "trackId": "1407852246",
        "appStoreUrl": "https://apps.apple.com/us/app/example/id1407852246?uo=4",
        "appLastUpdatedDate": "2021-10-30",
        "trustedSeller": "Example",
        "incentivizedActivity": true,
        "downloadRange": "500000000 - 1000000000",
        "averageUserRating": 4,
        "contentRating": "Everyone",
        "blocklisted": false,
        "blocklistedReasons": [
          "App is No Longer in Active Use",
          "The app is a VPN"
        ],
        "adCapabilities": {
          "topDevice": "Generic Android",
          "displayTopAdsize": "336x280",
          "videoTopAdsize": "768x1024",
          "displayContribution": 95.23,
          "videoContribution": 4.77,
          "hyperLocationAvailability": 98.78,
          "mraidVersion": "3.0",
          "adsDetected": true
        },
        "interactiveELements": [
          "Shares Location",
          "Users Interact"
        ]
      },
      "pixalateAdvisories": {
        "hasAppAdsTxt": false,
        "delistedApp": true,
        "delistedDate": "2021-10-30",
        "hasDangerousPermissions": false,
        "blocklisted": false,
        "privateDomain": false,
        "hasTermsAndConditions": true,
        "hasPrivacyPolicy": true
      },
      "apAdvisories": [
        [
          "An example advisory",
          "Another advisory"
        ]
      ],
      "riskOverview": {
        "ivt": 10.12,
        "ivtRisk": "medium",
        "viewability": 66.05,
        "viewabilityRisk": "medium",
        "descriptionBrandSafetyRisk": "low",
        "contentBrandSafetyRisk": "low",
        "overallIvtPermissionRisk": "low",
        "risk": [
          {
            "region": "APAC",
            "device": "smartphone",
            "pixalateRisk": "medium",
            "pixalateRiskReasons": [
              "Significantly Elevated IVT Percentage",
              "Ad Traffic Shows Some Suspicious Characteristics"
            ]
          }
        ]
      },
      "developerOverview": {
        "developerName": "Acme Apps",
        "developerLocation": "J. Doe, Main Street, Anywhere USA",
        "developerEmail": "jdoe@example.org",
        "developerCountry": "US",
        "developerWebsite": "https://www.example.org",
        "developerTotalApps": 4,
        "privateDomain": false,
        "hasTermsAndConditions": true,
        "hasPrivacyPolicy": true,
        "facebookRisk": "low",
        "linkedInRisk": "low",
        "twitterRisk": "low"
      },
      "trafficOverview": {
        "spoofingRisk": "low",
        "locationMaskingRisk": "low",
        "advertisingIvtRisk": "low",
        "clickIvtRisk": "low",
        "viewabilityRisk": "low",
        "estimatedDailyActiveUsers": 1000000,
        "estimatedMonthlyActiveUsers": 20000000,
        "inventory": 22000000,
        "adSpend": 69000
      },
      "brandSafety": {
        "descriptionBrandSafety": {
          "descriptionBrandSafetyRisk": "medium",
          "advisoriesRisk": "medium",
          "adultContentRisk": "high",
          "drugContentRisk": "medium",
          "alcoholContentRisk": "medium",
          "hateSpeechRisk": "low",
          "offensiveContentRisk": "medium",
          "gamblingContentRisk": "medium",
          "violenceContentRisk": "low"
        },
        "contentBrandSafety": {
          "contentBrandSafetyRisk": "medium",
          "adultRisk": "low",
          "violenceRisk": "medium",
          "imageData": [
            {
              "url": "https://example.org/images/kxipXQ3huWkwsqokX66euP.png",
              "text": "Weather Radar",
              "violenceRisk": "low",
              "spoofRisk": "low",
              "medicalRisk": "low",
              "adultRisk": "low"
            }
          ]
        }
      },
      "appPermissions": {
        "ivtPermissionRisk": "medium",
        "permissions": [
          {
            "name": "ACCESS_BACKGROUND_LOCATION",
            "description": "Allows an app to access location in the background.",
            "isDangerous": "false;",
            "ivtPermissonRisk": "medium"
          }
        ]
      },
      "trafficOverlap": {
        "userOverlap": 8.7,
        "inventoryOverlap": 3.1
      },
      "authorizedSellers": [
        {}
      ],
      "invalidTraffic": {
        "ivt": 0,
        "givt": 0,
        "sivt": 0,
        "givtTypes": [
          {
            "fraudType": "string",
            "givt": 0,
            "sivt": 0
          }
        ],
        "sivtTypes": [
          {
            "fraudType": "string",
            "givt": 0,
            "sivt": 0
          }
        ]
      },
      "viewability": {
        "viewability": 66.05,
        "viewabilityRisk": "medium",
        "byAdSizes": [
          {
            "adSize": "728x90",
            "inventory": 22360289,
            "inventoryRatio": 66.05,
            "viewability": 66.05
          }
        ]
      },
      "inventory": {
        "byDevice": {
          "device": "string",
          "inventory": 0,
          "inventoryRatio": 0,
          "ivt": 0,
          "viewability": 0
        }
      },
      "ctr": {
        "appId": "string"
      },
      "availableCountries": {
        "appId": "string"
      },
      "rankings": {
        "appId": "string"
      },
      "rankingsByCountry": {
        "appId": "string"
      }
    }
  ]
}

A list of apps.

Properties

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

App

{
  "appId": "1407852246",
  "region": "APAC",
  "device": "smartphone",
  "appStore": "android",
  "appOverview": {
    "appTitle": "Example App",
    "screenshotUrls": [
      [
        "https://example.com/image/screenshot-1.png",
        "https://example.com/image/screenshot-2.png"
      ]
    ],
    "description": "An example app.",
    "iabPrimaryCategory": [
      [
        "Video Gaming"
      ]
    ],
    "iabSubCategory": [
      [
        "Mobile Games"
      ]
    ],
    "appStoreCategories": [
      [
        "Games"
      ]
    ],
    "delistedDate": "2021-10-30",
    "delistedApp": false,
    "hasDangerousPermissions": false
  },
  "appDetails": {
    "bundleId": "com.example.ios",
    "trackId": "1407852246",
    "appStoreUrl": "https://apps.apple.com/us/app/example/id1407852246?uo=4",
    "appLastUpdatedDate": "2021-10-30",
    "trustedSeller": "Example",
    "incentivizedActivity": true,
    "downloadRange": "500000000 - 1000000000",
    "averageUserRating": 4,
    "contentRating": "Everyone",
    "blocklisted": false,
    "blocklistedReasons": [
      "App is No Longer in Active Use",
      "The app is a VPN"
    ],
    "adCapabilities": {
      "topDevice": "Generic Android",
      "displayTopAdsize": "336x280",
      "videoTopAdsize": "768x1024",
      "displayContribution": 95.23,
      "videoContribution": 4.77,
      "hyperLocationAvailability": 98.78,
      "mraidVersion": "3.0",
      "adsDetected": true
    },
    "interactiveELements": [
      "Shares Location",
      "Users Interact"
    ]
  },
  "pixalateAdvisories": {
    "hasAppAdsTxt": false,
    "delistedApp": true,
    "delistedDate": "2021-10-30",
    "hasDangerousPermissions": false,
    "blocklisted": false,
    "privateDomain": false,
    "hasTermsAndConditions": true,
    "hasPrivacyPolicy": true
  },
  "apAdvisories": [
    [
      "An example advisory",
      "Another advisory"
    ]
  ],
  "riskOverview": {
    "ivt": 10.12,
    "ivtRisk": "medium",
    "viewability": 66.05,
    "viewabilityRisk": "medium",
    "descriptionBrandSafetyRisk": "low",
    "contentBrandSafetyRisk": "low",
    "overallIvtPermissionRisk": "low",
    "risk": [
      {
        "region": "APAC",
        "device": "smartphone",
        "pixalateRisk": "medium",
        "pixalateRiskReasons": [
          "Significantly Elevated IVT Percentage",
          "Ad Traffic Shows Some Suspicious Characteristics"
        ]
      }
    ]
  },
  "developerOverview": {
    "developerName": "Acme Apps",
    "developerLocation": "J. Doe, Main Street, Anywhere USA",
    "developerEmail": "jdoe@example.org",
    "developerCountry": "US",
    "developerWebsite": "https://www.example.org",
    "developerTotalApps": 4,
    "privateDomain": false,
    "hasTermsAndConditions": true,
    "hasPrivacyPolicy": true,
    "facebookRisk": "low",
    "linkedInRisk": "low",
    "twitterRisk": "low"
  },
  "trafficOverview": {
    "spoofingRisk": "low",
    "locationMaskingRisk": "low",
    "advertisingIvtRisk": "low",
    "clickIvtRisk": "low",
    "viewabilityRisk": "low",
    "estimatedDailyActiveUsers": 1000000,
    "estimatedMonthlyActiveUsers": 20000000,
    "inventory": 22000000,
    "adSpend": 69000
  },
  "brandSafety": {
    "descriptionBrandSafety": {
      "descriptionBrandSafetyRisk": "medium",
      "advisoriesRisk": "medium",
      "adultContentRisk": "high",
      "drugContentRisk": "medium",
      "alcoholContentRisk": "medium",
      "hateSpeechRisk": "low",
      "offensiveContentRisk": "medium",
      "gamblingContentRisk": "medium",
      "violenceContentRisk": "low"
    },
    "contentBrandSafety": {
      "contentBrandSafetyRisk": "medium",
      "adultRisk": "low",
      "violenceRisk": "medium",
      "imageData": [
        {
          "url": "https://example.org/images/kxipXQ3huWkwsqokX66euP.png",
          "text": "Weather Radar",
          "violenceRisk": "low",
          "spoofRisk": "low",
          "medicalRisk": "low",
          "adultRisk": "low"
        }
      ]
    }
  },
  "appPermissions": {
    "ivtPermissionRisk": "medium",
    "permissions": [
      {
        "name": "ACCESS_BACKGROUND_LOCATION",
        "description": "Allows an app to access location in the background.",
        "isDangerous": "false;",
        "ivtPermissonRisk": "medium"
      }
    ]
  },
  "trafficOverlap": {
    "userOverlap": 8.7,
    "inventoryOverlap": 3.1
  },
  "authorizedSellers": [
    {}
  ],
  "invalidTraffic": {
    "ivt": 0,
    "givt": 0,
    "sivt": 0,
    "givtTypes": [
      {
        "fraudType": "string",
        "givt": 0,
        "sivt": 0
      }
    ],
    "sivtTypes": [
      {
        "fraudType": "string",
        "givt": 0,
        "sivt": 0
      }
    ]
  },
  "viewability": {
    "viewability": 66.05,
    "viewabilityRisk": "medium",
    "byAdSizes": [
      {
        "adSize": "728x90",
        "inventory": 22360289,
        "inventoryRatio": 66.05,
        "viewability": 66.05
      }
    ]
  },
  "inventory": {
    "byDevice": {
      "device": "string",
      "inventory": 0,
      "inventoryRatio": 0,
      "ivt": 0,
      "viewability": 0
    }
  },
  "ctr": {
    "appId": "string"
  },
  "availableCountries": {
    "appId": "string"
  },
  "rankings": {
    "appId": "string"
  },
  "rankingsByCountry": {
    "appId": "string"
  }
}

An app.

Properties

Name Type Required Restrictions Description
appId string false none The app's unique identifier. A package name on Google Play or a track id on Apple app Store.
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.
appStore AppStore false none An app store identifier.
appOverview AppOverview false none General information about the app.
appDetails AppDetails false none Detailed information about the app.
pixalateAdvisories PixalateAdvisories false none Pixalate app advisories.
apAdvisories ApAdvisories false none App advisories.
riskOverview RiskOverview false none An overview of risk for the app.
developerOverview DeveloperOverview false none An overview of app's developer information.
trafficOverview TrafficOverview false none An overview of the traffic risk.
brandSafety BrandSafety false none Brand safety information.
appPermissions AppPermissions false none App permissions.
trafficOverlap TrafficOverlap false none Overlap traffic illustrates the most common user journeys from app to app. It leverages shared users to not only connect apps together but also to create relationships between a series of apps. List of apps provided based on overall traffic(byOveralTraffic) and invalid traffic(byIvt).
authorizedSellers AuthorizedSellers false none The contribution of various sell side platforms to programmatic ad impressions sold on the app.
invalidTraffic InvalidTraffic false none An 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 app.
inventory Inventory false none The estimated volume of programmatic ad impressions broken down by device, region, country, DMA.
ctr Ctr false none An app.
availableCountries AvailableCountries false none An app.
rankings Rankings false none An app.
rankingsByCountry RankingsByCountry false none An app.

AppOverview

{
  "appTitle": "Example App",
  "screenshotUrls": [
    [
      "https://example.com/image/screenshot-1.png",
      "https://example.com/image/screenshot-2.png"
    ]
  ],
  "description": "An example app.",
  "iabPrimaryCategory": [
    [
      "Video Gaming"
    ]
  ],
  "iabSubCategory": [
    [
      "Mobile Games"
    ]
  ],
  "appStoreCategories": [
    [
      "Games"
    ]
  ],
  "delistedDate": "2021-10-30",
  "delistedApp": false,
  "hasDangerousPermissions": false
}

General information about the app.

Properties

Name Type Required Restrictions Description
appTitle string false none The app title.
screenshotUrls [string] false none A list of app screenshot URLs.
description string false none App description.
iabPrimaryCategory [string] false none The IAB primary categories.
iabSubCategory [string] false none The IAB secondary categories.
appStoreCategories [string] false none App store categories.
delistedDate string(date) false none If app has been delisted from the app store, then this property is the date when delisted. The date format is YYYY-MM-DD.
delistedApp boolean false none A true indicates that app has been delisted from the app store.
hasDangerousPermissions boolean false none A true indicates that the app requests a permission which is dangerous according to the protection level in the Google permission manifest.

AppDetails

{
  "bundleId": "com.example.ios",
  "trackId": "1407852246",
  "appStoreUrl": "https://apps.apple.com/us/app/example/id1407852246?uo=4",
  "appLastUpdatedDate": "2021-10-30",
  "trustedSeller": "Example",
  "incentivizedActivity": true,
  "downloadRange": "500000000 - 1000000000",
  "averageUserRating": 4,
  "contentRating": "Everyone",
  "blocklisted": false,
  "blocklistedReasons": [
    "App is No Longer in Active Use",
    "The app is a VPN"
  ],
  "adCapabilities": {
    "topDevice": "Generic Android",
    "displayTopAdsize": "336x280",
    "videoTopAdsize": "768x1024",
    "displayContribution": 95.23,
    "videoContribution": 4.77,
    "hyperLocationAvailability": 98.78,
    "mraidVersion": "3.0",
    "adsDetected": true
  },
  "interactiveELements": [
    "Shares Location",
    "Users Interact"
  ]
}

Detailed information about the app.

Properties

Name Type Required Restrictions Description
bundleId string false none The App bundle identifier. For Google Play it is package name & For app Store it is Unique identifier for the app assigned by apple developer.
trackId string false none The unique identifier for the app assigned by Apple. App Store Only, otherwise null
appStoreUrl string false none The app page on Google Play or App Store.
appLastUpdatedDate string(date) false none The date the app information was last updated. Formatted as YYYY-MM-DD.
trustedSeller string false none The authorized trusted seller.
incentivizedActivity boolean false none A true indicates incentivized activity available in the app.
downloadRange string false none The estimated number of apps installed. For Google Google Play only.
averageUserRating integer false none The average user rating given by the app store.
contentRating string false none The recommended content rating defined by the app store.
blocklisted boolean false none A true indicates the app has been placed on Pixalate risk blocklist.
blocklistedReasons BlocklistedReasons false none A list of reasons that the app is blocklisted.
adCapabilities object false none The ad capabilities of the app.
» topDevice string false none The most commonly reported device in use by the app.
» displayTopAdsize string false none The display ad size most commonly trafficked in programmatic advertising.
» videoTopAdsize string false none The video ad size most commonly trafficked in programmatic advertising.
» displayContribution number false none The percentage of video ads trafficked on the app.
» videoContribution number false none The percentage of display ads trafficked on the app.
» hyperLocationAvailability number false none The percentage of advertising transactions containing the user's latitude and longitude.
» mraidVersion string false none The most recent version of MRAID for which the app is compliant.
» adsDetected boolean false none A true indicates that Ads detected in the app. Non ad-supported apps may be at risk of spoofing.
interactiveELements InteractiveElements false none List of Interactive elements focus on what information the app has access to.

PixalateAdvisories

{
  "hasAppAdsTxt": false,
  "delistedApp": true,
  "delistedDate": "2021-10-30",
  "hasDangerousPermissions": false,
  "blocklisted": false,
  "privateDomain": false,
  "hasTermsAndConditions": true,
  "hasPrivacyPolicy": true
}

Pixalate app advisories.

Properties

Name Type Required Restrictions Description
hasAppAdsTxt boolean false none A true indicates that AppAds.txt is enabled for the app's domain.
delistedApp boolean false none A true indicates that app has been delisted from the app store.
delistedDate string(date) false none If app has been delisted from the app store, then this property is the date when delisted. The date format is YYYY-MM-DD.
hasDangerousPermissions boolean false none A true indicates that the app requests a permission which is dangerous according to the protection level in the Google permission manifest.
blocklisted boolean false none A true indicates app has been placed on Pixalate risk blocklist.
privateDomain boolean false none A true indicates app's domain is privately registered.
hasTermsAndConditions boolean false none A true indicates app has terms and conditions.
hasPrivacyPolicy boolean false none A true indicates app has privacy policy.

ApAdvisories

[
  [
    "An example advisory",
    "Another advisory"
  ]
]

App advisories.

Properties

None

RiskOverview

{
  "ivt": 10.12,
  "ivtRisk": "medium",
  "viewability": 66.05,
  "viewabilityRisk": "medium",
  "descriptionBrandSafetyRisk": "low",
  "contentBrandSafetyRisk": "low",
  "overallIvtPermissionRisk": "low",
  "risk": [
    {
      "region": "APAC",
      "device": "smartphone",
      "pixalateRisk": "medium",
      "pixalateRiskReasons": [
        "Significantly Elevated IVT Percentage",
        "Ad Traffic Shows Some Suspicious Characteristics"
      ]
    }
  ]
}

An overview of risk for the app.

Properties

Name Type Required Restrictions Description
ivt number false none Percentage of invalid traffic associated with advertising transactions for the app.
ivtRisk string false none The invalid traffic risk.
viewability number false none The average viewability for all display ad impressions in the app.
viewabilityRisk string false none The risk of IAB viewability standards not being met for ad impressions on the app.
descriptionBrandSafetyRisk string false none The overall description risk to advertise brand safety from the app.
contentBrandSafetyRisk string false none The overall content risk to advertise brand safety from the app.
overallIvtPermissionRisk string false none The overall IVT risk to advertise brand safety from the app.
risk [object] false none Pixalate's unique overall advertising risk assessment based on blended risk factors including brand safety, invalid traffic and inventory for all regions and devices. It includes risk reasons. And list of possible risk reasons.
» 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.
» pixalateRisk string false none Pixalate's unique overall risk assessment for the app.
» pixalateRiskReasons RiskReasons false none A list of reasons that the app is at risk.

Enumerated Values

Property Value
ivtRisk low
ivtRisk medium
ivtRisk high
viewabilityRisk low
viewabilityRisk medium
viewabilityRisk high
descriptionBrandSafetyRisk low
descriptionBrandSafetyRisk medium
descriptionBrandSafetyRisk high
contentBrandSafetyRisk low
contentBrandSafetyRisk medium
contentBrandSafetyRisk high
overallIvtPermissionRisk low
overallIvtPermissionRisk medium
overallIvtPermissionRisk high
pixalateRisk low
pixalateRisk medium
pixalateRisk high

DeveloperOverview

{
  "developerName": "Acme Apps",
  "developerLocation": "J. Doe, Main Street, Anywhere USA",
  "developerEmail": "jdoe@example.org",
  "developerCountry": "US",
  "developerWebsite": "https://www.example.org",
  "developerTotalApps": 4,
  "privateDomain": false,
  "hasTermsAndConditions": true,
  "hasPrivacyPolicy": true,
  "facebookRisk": "low",
  "linkedInRisk": "low",
  "twitterRisk": "low"
}

An overview of app's developer information.

Properties

Name Type Required Restrictions Description
developerName string false none The business name of the app's developer.
developerLocation string false none The business address of the app's developer
developerEmail string false none The contact email address of the app's developer.
developerCountry string false none The country name of the app's developer.
developerWebsite string false none The website of the app's developer.
developerTotalApps integer false none The total number of apps available from the developer.
privateDomain boolean false none A true indicates app's domain is privately registered.
hasTermsAndConditions boolean false none A true indicates app has terms and conditions.
hasPrivacyPolicy boolean false none A true indicates app has privacy policy.
facebookRisk string false none The Facebook risk. Low social media engagement on Facebook can be a risk factor.
linkedInRisk string false none The LinkedIn risk. Low social media engagement on LinkedIn can be a risk factor.
twitterRisk string false none The Twitter risk. Low social media engagement on Twitter can be a risk factor.

Enumerated Values

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

TrafficOverview

{
  "spoofingRisk": "low",
  "locationMaskingRisk": "low",
  "advertisingIvtRisk": "low",
  "clickIvtRisk": "low",
  "viewabilityRisk": "low",
  "estimatedDailyActiveUsers": 1000000,
  "estimatedMonthlyActiveUsers": 20000000,
  "inventory": 22000000,
  "adSpend": 69000
}

An overview of the traffic risk.

Properties

Name Type Required Restrictions Description
spoofingRisk string false none The risk the app may be misrepresented in advertising transactions and ads delivered to a different app or site.
locationMaskingRisk string false none The risk that location data is inaccurate for advertising transactions involving the app.
advertisingIvtRisk string false none The risk of advertising impressions delivered to the app being due to invalid traffic.
clickIvtRisk string false none The risk of clicks originating from ads on the app being fraudluent.
viewabilityRisk string false none The risk of IAB viewability standards not being met for ad impressions on the app.
estimatedDailyActiveUsers integer false none The estimated daily active users of the app.
estimatedMonthlyActiveUsers integer false none The estimated monthly active users of the app.
inventory integer false none The estimated number of monthly impressions this app makes available programmatically.
adSpend number false none Total estimated monthly ad spend on this app.

Enumerated Values

Property Value
spoofingRisk low
spoofingRisk medium
spoofingRisk high
locationMaskingRisk low
locationMaskingRisk medium
locationMaskingRisk high
advertisingIvtRisk low
advertisingIvtRisk medium
advertisingIvtRisk high
clickIvtRisk low
clickIvtRisk medium
clickIvtRisk high
viewabilityRisk low
viewabilityRisk medium
viewabilityRisk high

BrandSafety

{
  "descriptionBrandSafety": {
    "descriptionBrandSafetyRisk": "medium",
    "advisoriesRisk": "medium",
    "adultContentRisk": "high",
    "drugContentRisk": "medium",
    "alcoholContentRisk": "medium",
    "hateSpeechRisk": "low",
    "offensiveContentRisk": "medium",
    "gamblingContentRisk": "medium",
    "violenceContentRisk": "low"
  },
  "contentBrandSafety": {
    "contentBrandSafetyRisk": "medium",
    "adultRisk": "low",
    "violenceRisk": "medium",
    "imageData": [
      {
        "url": "https://example.org/images/kxipXQ3huWkwsqokX66euP.png",
        "text": "Weather Radar",
        "violenceRisk": "low",
        "spoofRisk": "low",
        "medicalRisk": "low",
        "adultRisk": "low"
      }
    ]
  }
}

Brand safety information.

Properties

Name Type Required Restrictions Description
descriptionBrandSafety object false none App descriptive text is processed through natural language algorithms and comprehensive categorical dictionaries to predict the advertiser brand safety risk.
» descriptionBrandSafetyRisk string false none The overall description risk to advertise brand safety from the app.
» advisoriesRisk string false none The risk to brand safety derived from the app's content advisories.
» adultContentRisk string false none The risk to brand safety from adult themed content based on textual analysis of the app and its descriptive content.
» drugContentRisk string false none The risk to brand safety from drug themed content based on textual analysis of the app and its descriptive content.
» alcoholContentRisk string false none The risk to brand safety from Alcohol themed content based on textual analysis of the app and its descriptive content.
» hateSpeechRisk string false none The risk to brand safety from hate speech content based on textual analysis of the app and its descriptive content.
» offensiveContentRisk string false none The risk to brand safety from content with offensive language based on textual analysis of the app and its descriptive content .
» gamblingContentRisk string false none The risk to brand safety from gambling focused content based on textual analysis of the app and its descriptive content.
» violenceContentRisk string false none The risk to brand safety from Gambling focused content based on textual analysis of the app and its descriptive content.
contentBrandSafety object false none In-app visual content is processed through an advanced machine learning algorithm and evaluated for risk to advertiser brand safety.
» contentBrandSafetyRisk string false none The overall content risk to advertise brand safety from the app.
» adultRisk string false none The risk to brand safety from potential adult images and content detected within the app.
» violenceRisk string false none The risk to brand safety from potential violent imagery and content detected within the app.
» imageData [object] false none The image by image breakdown of brand safety risk factors based on advanced image processing and machine learning.
»» url string false none A URL to the image.
»» text string false none The extracted text.
»» violenceRisk string false none The risk to brand safety from potential violence images and any extracted text.
»» spoofRisk string false none The risk to brand safety from potential spoofing based on images and any extracted text.
»» medicalRisk string false none The risk to brand safety from potential medical images and any extracted text.
»» adultRisk string false none The risk to brand safety from potential adult images images and any extracted text.

Enumerated Values

Property Value
descriptionBrandSafetyRisk low
descriptionBrandSafetyRisk medium
descriptionBrandSafetyRisk high
advisoriesRisk low
advisoriesRisk medium
advisoriesRisk high
adultContentRisk low
adultContentRisk medium
adultContentRisk high
drugContentRisk low
drugContentRisk medium
drugContentRisk high
alcoholContentRisk low
alcoholContentRisk medium
alcoholContentRisk high
hateSpeechRisk low
hateSpeechRisk medium
hateSpeechRisk high
offensiveContentRisk low
offensiveContentRisk medium
offensiveContentRisk high
gamblingContentRisk low
gamblingContentRisk medium
gamblingContentRisk high
violenceContentRisk low
violenceContentRisk medium
violenceContentRisk high
contentBrandSafetyRisk low
contentBrandSafetyRisk medium
contentBrandSafetyRisk high
adultRisk low
adultRisk medium
adultRisk high
violenceRisk low
violenceRisk medium
violenceRisk high
violenceRisk low
violenceRisk medium
violenceRisk high
spoofRisk low
spoofRisk medium
spoofRisk high
medicalRisk low
medicalRisk medium
medicalRisk high
adultRisk low
adultRisk medium
adultRisk high

AppPermissions

{
  "ivtPermissionRisk": "medium",
  "permissions": [
    {
      "name": "ACCESS_BACKGROUND_LOCATION",
      "description": "Allows an app to access location in the background.",
      "isDangerous": "false;",
      "ivtPermissonRisk": "medium"
    }
  ]
}

App permissions.

Properties

Name Type Required Restrictions Description
ivtPermissionRisk string false none The IVT Risk based on the combined risk of the permissions.
permissions [object] false none List of permissions.
» name string false none The permission name.
» description string false none The permission description.
» isDangerous boolean false none A true indicates a dangerous permission.

Normal permissions - Normal permissions cover areas where your app needs to access data or resources outside the app's sandbox,
but where there's very little risk to the user's privacy or the operation of other apps.
For example, permission to set the time zone is a normal permission.
If an app declares in its manifest that it needs a normal permission, the system automatically grants the app that permission at install time.

Dangerous permissions - Dangerous permissions cover areas where the app wants data or resources that involve the user's private information,
or could potentially affect the user's stored data or the operation of other apps.
For example, the ability to read the user's contacts is a dangerous permission.
If an app declares that it needs a dangerous permission, the user has to explicitly grant the permission to the app.
Until the user approves the permission, the app cannot provide functionality that depends on that permission.
» ivtPermissonRisk string false none The IVT Risk for the permission.

Enumerated Values

Property Value
ivtPermissionRisk low
ivtPermissionRisk medium
ivtPermissionRisk high
ivtPermissonRisk low
ivtPermissonRisk medium
ivtPermissonRisk high

TrafficOverlap

{
  "userOverlap": 8.7,
  "inventoryOverlap": 3.1
}

Overlap traffic illustrates the most common user journeys from app to app. It leverages shared users to not only connect apps together but also to create relationships between a series of apps. List of apps provided based on overall traffic(byOveralTraffic) and invalid traffic(byIvt).

Properties

Name Type Required Restrictions Description
userOverlap number false none The percentage of users of the given app that also visit the app.
inventoryOverlap number false none The percentage of impressions of the given app that were generated by the users that visited the app.

AuthorizedSellers

[
  {}
]

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 x
paymentType string false none x
inventory integer false none The estimated volume of programmatic ad impressions broken down by ad size.
inventoryRatio number false none The estimated percentage of inventory broken down by ad size.
ivt number false none The estimated percentage of inventory broken down by ad size.
videoInventoryRatio number false none The estimated percentage of inventory broken down by ad size.
viewability number false none The estimated percentage of inventory broken down by ad size.

InvalidTraffic

{
  "ivt": 0,
  "givt": 0,
  "sivt": 0,
  "givtTypes": [
    {
      "fraudType": "string",
      "givt": 0,
      "sivt": 0
    }
  ],
  "sivtTypes": [
    {
      "fraudType": "string",
      "givt": 0,
      "sivt": 0
    }
  ]
}

An app.

Properties

Name Type Required Restrictions Description
ivt number false none x
givt number false none x
sivt number false none x
givtTypes [object] false none x
» fraudType string false none x
» givt number false none none
» sivt number false none none
sivtTypes [object] false none x
» fraudType string false none x
» givt number false none none
» sivt number false none none

Viewability

{
  "viewability": 66.05,
  "viewabilityRisk": "medium",
  "byAdSizes": [
    {
      "adSize": "728x90",
      "inventory": 22360289,
      "inventoryRatio": 66.05,
      "viewability": 66.05
    }
  ]
}

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

Properties

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

Enumerated Values

Property Value
viewabilityRisk low
viewabilityRisk medium
viewabilityRisk high

Inventory

{
  "byDevice": {
    "device": "string",
    "inventory": 0,
    "inventoryRatio": 0,
    "ivt": 0,
    "viewability": 0
  }
}

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

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.
» inventoryRatio number false none The estimated percentage of inventory.
» ivt number false none x
» viewability number false none x

Ctr

{
  "appId": "string"
}

An app.

Properties

Name Type Required Restrictions Description
appId string false none none

AvailableCountries

{
  "appId": "string"
}

An app.

Properties

Name Type Required Restrictions Description
appId string false none none

Rankings

{
  "appId": "string"
}

An app.

Properties

Name Type Required Restrictions Description
appId string false none none

RankingsByCountry

{
  "appId": "string"
}

An app.

Properties

Name Type Required Restrictions Description
appId string false none none

AppStore

"android"

An app store identifier.

Properties

Name Type Required Restrictions Description
anonymous string false none An app store identifier.

Enumerated Values

Property Value
anonymous ios
anonymous android

Device

"smartphone"

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 smartphone
anonymous tablet

Region

"APAC"

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 NA
anonymous EMEA
anonymous LATAM
anonymous APAC

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

"appOverview"

The identifier for a predefined subset of all the app 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 app information available. If not supplied, usually indicates all widgets.

Enumerated Values

Property Value
anonymous appOverview
anonymous appDetails
anonymous pixalateAdvisories
anonymous apAdvisories
anonymous riskOverview
anonymous developerOverview
anonymous trafficOverview
anonymous brandSafety
anonymous appPermissions
anonymous trafficOverlap
anonymous authorizedSellers
anonymous invalidTraffic
anonymous viewability
anonymous inventory
anonymous ctr
anonymous availableCountries
anonymous rankings
anonymous rankingsByCountry

BlocklistedReasons

[
  "App is No Longer in Active Use",
  "The app is a VPN"
]

A list of reasons that the app is blocklisted.

Properties

None

RiskReasons

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

A list of reasons that the app is at risk.

Properties

None

InteractiveElements

[
  "Shares Location",
  "Users Interact"
]

List of Interactive elements focus on what information the app has access to.

Properties

None