Changelog
Back to All
improved

API 2.0 now in General Availability

5 months ago by Daniel Earle

Below V2 APIs are now live in Scope3! The 2.0 release includes support for uploading data via a cloud bucket, simplifies authentication to a single token, and cleans up many outdated fields.

Latest V2 APIs cover

For more information, please see What's New in 2.0.

V1 deprecation notice

The V1.3 API will be deprecated by January 1st, 2025. To migrate to the V2 API, please use our migration guides.

Endpoint Changes

In V2, we have consolidated the REST endpoints to /measure /creative and /benchmarks. For a list of changes, check our What's New in 2.0.

Stateful APIs

In addition to the updated API endpoints, V2 now supports integration via cloud buckets. These new Stateful APIs work using AWS, GCP, or Azure buckets. Cloud bucket uploads do not have row count limitations like on version 1.x endpoints. Multiple file types are supported: Newline-Delimited JSON, CSV, Avro, and Parquet. Emissions reports can be pushed back to the desired bucket location.

Uploads via new Stateful APIs bring a deeper integration into the CSP and are managed through a purpose-built Integrate UI. We recommend using these new Stateful APIs for most use cases. Check out the Integrate UI Basic Setup guide for details.

Response format change

The response from V2 REST endpoints has been updated and includes additional metrics, inventory intelligence information, and a dedicated emissions breakdown section.

The output responses for the Stateful APIs are configurable. Media Delivery responses can contain supplied input fields and emissions measurement fields. Response configuration is done in the Integrate UI.


Breaking Changes

Please note that V2 includes changes in authentication and data fields that might break your existing integration.

Authentication

The authentication mechanism has switched to the bearer token for the V2 stateless endpoints (/measure /creative /benchmarks). See the V2 auth guide on how these tokens are generated and used.

Channel naming

Channel names have been simplified. display-web and display-app are now web and app respectively. If you are using streaming-video for either websites or apps, this can be switched. The channel can be app or web with the video format described in the new creative fields. If you are using streaming-video for CTV, use the new ctv/bvod channel.

Field changes

There are a number of changes to input fields:

  • Site and app inputs are now covered by one combined inventory_id input
  • The creative input fields have been updated and expanded to support detailed modeling of creatives, including the introduction of ad formats
  • Date is now utcDatetime

To see the new inputs in full visit the V2 API reference.

See What's New in 2.0 for more information.