Changes allow Scope3 to easily collect data on a daily level instead of just by month and year and to dive more granularly into site and domain reporting. This lays the groundwork for supporting mobile apps and other channels.

👉

This release includes a breaking change

We will keep /v0 around for the next 60 days until October 1, 2022, to help with the migration. If you have any questions/concerns, please reach out to your Scope3 point of contact.

Summary of API Changes in Version 1.0

Changes allow Scope3 to easily collect data on a daily level instead of just by month and year, and to dive more granularly into site and domain reporting. This lays the groundwork for supporting mobile apps and other channels.

calculate endpoint

Endpoint /v0/calculate -> /v1/calculate/daily

Domain: The domain field has been moved to sit under the site object

Month & Year: The month and year fields have been replaced at the row level with a date field.

Previous: /v0/calculate

{
     "month": 3,
     "year": 2022,
     "rows": [
          {
               "device": "desktop",
               "domain": "nytimes.com",
               "country": "US",
               "impressions": 13821,
               "creative": {
                    "format": "banner"
               },
          }
     ]
}

Now: /v1/calculate/daily

{
     "rows": [
          {
               "date": "2022-06-14",
               "site": {
                    "domain": "nytimes.com"
               },
               "device": "desktop",
               "country": "US",
               "date": "2022-06-14",
               "impressions": 13821,
               "creative": {
                    "format": "banner"
               }
          }
     ]

}

domainCoverage endpoint

Endpoint /v0/domainCoverage -> /v1/domainCoverage

Previous

[
     "nytimes.com",
     "bbc.com"
]

Now

{
     "sites": [
          {
               "domain": "nytimes.com"
          },
          {
               "domain": "bbc.com"
          }
     ]
}