Get risk ratings and reputation for one CTV app

GET

https://api.pixalate.com/api/v2/mrt/ctv/:appId

GET

/api/v2/mrt/ctv/:appId

curl -G https://api.pixalate.com/api/v2/mrt/ctv/71845 \
     -H "x-api-key: <apiKey>" \
     -d device=roku \
     -d includeSpoofing=true \
     -d region=GLOBAL

{
  "status": "OK",
  "numFound": 1,
  "docs": [
    {
      "appId": "B07SM3YB4H",
      "region": "GLOBAL",
      "device": "roku",
      "includeSpoofing": false,
      "appOverview": {
        "channelId": "string",
        "appTitle": "Example App",
        "description": "An example app.",
        "categories": [
          "Movies & TV"
        ],
        "screenshotUrls": [
          "https://example.com/image/screenshot-1.png",
          "https://example.com/image/screenshot-2.png"
        ]
      },
      "riskOverview": {
        "risk": [
          {
            "region": "GLOBAL",
            "pixalateRisk": "medium",
            "pixalateRiskReasons": [
              "Significantly Elevated IVT Percentage",
              "Ad Traffic Shows Some Suspicious Characteristics"
            ]
          }
        ],
        "ivt": 10.12,
        "ivtRisk": "medium",
        "ssaiRate": 0.55,
        "transaparentSsaiRate": 0.01,
        "descriptionBrandSafetyRisk": "low",
        "contentBrandSafetyRisk": "low"
      },
      "pixalateAdvisories": {
        "hasAppAdsTxt": false,
        "delistedApp": true,
        "delistedDate": "2021-10-30",
        "privateDomain": false,
        "hasTermsAndConditions": true,
        "hasPrivacyPolicy": true,
        "appAgeRisk": "medium"
      },
      "appSpoofing": {
        "victimOfSpoofing": true,
        "spoofingRisk": "medium",
        "byFraudType": [
          {
            "fraudType": "userAgentObfuscation",
            "apps": [
              {
                "detectedBundleId": "string",
                "declaredBundleId": "B00KDSGIPK",
                "sovRisk": "medium"
              }
            ]
          }
        ]
      },
      "appDetails": {
        "appStoreUrl": "https://appstore.example.org/dp/B00KDXXX2PK",
        "availableCountries": [
          "US",
          "ES"
        ],
        "availableLanguages": [
          "en",
          "es"
        ],
        "keywords": [
          "space",
          "news"
        ],
        "rating": 84,
        "starRatingCount": 517628,
        "parentalHint": "Guidance Suggested",
        "revenueSources": [
          "string"
        ],
        "cvaaCompliant": true,
        "appAgeRisk": "low",
        "appAge": 91,
        "publishedDate": "string",
        "appPrivacyPolicy": true,
        "appPrivacyPolicyUrl": "http://example.org/privacy-policy/",
        "delistedApp": false,
        "delistedDate": "string",
        "bundleIds": [
          {
            "bundleId": "B00KDXXX2PK",
            "sovRatio": 77.43
          }
        ]
      },
      "developerOverview": {
        "developerName": "Acme Apps",
        "developerWebsite": "https://www.example.org",
        "privateDomain": false,
        "hasTermsAndConditions": true,
        "hasPrivacyPolicy": true,
        "totalApps": 3
      },
      "channels": [
        {},
        {}
      ],
      "brandSafety": {
        "descriptionBrandSafety": {
          "advisoriesRisk": "medium",
          "adultContentRisk": "high",
          "drugContentRisk": "medium",
          "alcoholContentRisk": "medium",
          "hateSpeechRisk": "low",
          "offensiveContentRisk": "medium"
        },
        "contentBrandSafety": {
          "adultRisk": "low",
          "violenceRisk": "medium",
          "imageData": [
            {
              "url": "https://example.org/images/kxipXQ3huWkwsqokX66euP.png",
              "text": "Weather Radar",
              "violenceRisk": "low",
              "spoofRisk": "low",
              "medicalRisk": "low",
              "adultRisk": "low"
            }
          ]
        }
      },
      "trafficOverlap": {
        "trafficOverview": {
          "spoofingRisk": "low",
          "advertisingIvtRisk": "low",
          "trustedSeller": "Google AdExchange",
          "ivtFreeUsersRate": 96.03,
          "estimatedDailyActiveUsers": 4929,
          "estimatedMonthlyActiveUsers": 46502,
          "adSpend": 69000,
          "adDensity": 18377044,
          "adDensityRisk": "low",
          "adDensityConfidenceScore": 0.95
        },
        "trafficOverlap": {
          "byOverallTraffic": [
            {
              "appName": "ExampleOrg's - Free TV Drama & Movies",
              "developerName": "Example Org",
              "impressionOverlap": 0.2,
              "deviceOverlap": 0.21,
              "risk": "medium"
            }
          ],
          "byIvt": [
            {
              "appName": "ExampleOrg's - Free TV Drama & Movies",
              "developerName": "Example Org",
              "impressionOverlap": 0.14,
              "deviceOverlap": 0.05,
              "risk": "low"
            }
          ]
        }
      },
      "authorizedSellers": [
        {
          "exchange": "Acme Exchange",
          "paymentType": "Direct",
          "inventory": 30039,
          "inventoryRatio": 12.87,
          "ivt": 0.9,
          "videoInventoryRatio": 1.4,
          "displayInventoryRatio": 1.4,
          "spoofingRate": 2.6,
          "ssaiRate": 0.06,
          "transparentSsaiRate": 0.06
        }
      ],
      "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": "GLOBAL",
            "inventory": 1,
            "inventoryRatio": 6.39,
            "ivt": 2.93,
            "ssaiRate": 0.02,
            "TransparentssaiRate": 0.01
          }
        ],
        "byAdsize": [
          {
            "adSize": "320x50",
            "inventory": 1,
            "inventoryRatio": 3.47,
            "ivt": 12.25,
            "ssaiRate": 0.03,
            "TransparentssaiRate": 0.02
          }
        ],
        "byDma": [
          {
            "dmaName": "NEW YORK",
            "inventory": 1,
            "inventoryRatio": 5.35,
            "ivt": 4.76,
            "ssaiRate": 0,
            "TransparentssaiRate": 0
          }
        ]
      },
      "availableCountries": [
        "Germany"
      ],
      "rankings": {
        "regionRank": 6473,
        "category": [
          {
            "category": "Movies & TV",
            "rank": "11"
          }
        ],
        "final": {
          "grade": "C",
          "score": "38"
        },
        "ivt": {
          "grade": "B",
          "score": "62"
        },
        "popularity": {
          "grade": "C",
          "score": "44"
        },
        "userEngagement": {
          "grade": "A",
          "score": "99"
        },
        "adDensity": {
          "grade": "A",
          "score": "99"
        },
        "globalPopularityRank": "234"
      },
      "rankingsByCountry": {
        "reach": [
          {
            "countryCode": "ZA",
            "countryName": "South Africa",
            "mauRank": "637",
            "mauRankChange": "-372"
          }
        ],
        "marketShare": [
          {
            "countryCode": "GE",
            "countryName": "Georgia",
            "impressionRank": "359",
            "impsRankChange": "N/A"
          }
        ]
      },
      "coppa": {
        "coppaAudience": "General Audience",
        "coppaAudienceReason": [
          "This app is likely directed to children (including mixed audience) based on manual review"
        ],
        "isReviewedManually": true,
        "parentalHint": "Guidance Suggested",
        "Categories": [
          "Movies & TV"
        ],
        "coppaViolationRisk": "low",
        "coppaViolationRiskReason": [
          "The COPPA risk is low because the app is likely not directed to children under 13."
        ],
        "privacyPolicyDetected": true,
        "transmitsResidentialIP": true,
        "passesLocation": true
      },
      "mfa": {
        "mfaRisk": "low",
        "adRefreshRate": 1
      }
    }
  ]
}

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

Authentication

x-api-keystring

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.

Path parameters

appIdstringRequired

The app's unique identifier.

Query parameters

regionenumOptional

Filter by region. All regions are returned by default. GLOBAL indicates aggregated traffic from all regions.

Allowed values:

deviceenumOptional

Filter by device. All devices are returned by default.

Allowed values:

includeSpoofingbooleanOptional

A true indicates that spoofing information should be included.

prettybooleanOptional

If true, return pretty JSON. Default is false.

Response

statusenumOptional

The returned status.

Allowed values:

numFoundintegerOptional

The total number of matching apps.

docslist of objectsOptional

A list of apps.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

5XX

Server Error