Changelog
Start typing to search…
Back to All

API 1.2.1

over 2 years ago by Brian O'Kelley

New Planning API to support media planning, carbon calculators, and ad server reporting. Also redesigned the API for supply graph reporting, deprecating the supply directness field.

New - Planning API

Media plans, ad servers, and carbon calculators generally use the seller (publisher, platform, or media owner) as the primary entity, not the domain or app ID. With this release, the Scope3 API adds the ability to model emissions for sellers across display-web, display-app, streaming-video, and social channels.

The Planning API is documented here. Planning capabilities are in closed beta - please contact Scope3 if you would like access.

Modeling Sellers in the Campaign API

When reports are pulled from a buy-side ad server (Flashtalking, Sizmek, DCM), the underlying domain or app is generally not available. The "site" field generally references a publisher or ad network. Passing this into the Scope3 API in the seller field will pull the modeled data for this organization. Since the "site" field is free-form, it may be necessary to slightly tweak the mappings in the ad server or on the Scope3 side. Please get in touch with our customer success team to help!

Changed fields - Campaign API

  • The inventoryID field is now optional. When inventory ID is not provided, we will first attempt to look up the seller field as an organization. If this doesn't match, we will look up the seller as an inventory ID. If neither is provided, we will return an error.

Improved Supply Graph Reporting

In the past, we shared a single supply directness number representing the max depth to a monetization partner. We now provide min, max, and average, as well as the logical and technical depth from the passthrough nodes work. As an example:

{
   "supplyGraph": {
      "totalCount":121,
      "logical": {
          "maxDepth":3,
          "averageDepth":1.3,
          "minDepth":1
       },
      "technical": {
          "maxDepth":2,
          "averageDepth":0.71,
          "minDepth":0
       }
   }
}

The supplyDirectness field is now deprecated in favor of supplyGraph.