Scope3

Scope3 Storefront Ad Server Buyer Routing API

The Storefront Ad Server Buyer Routing API from Scope3 — 12 operation(s) for storefront ad server buyer routing.

GitHub OpenAPI
Business capability
Ad Trafficking & Operations BC-3760.40

Operations 14

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /esa/{esaId}/sandbox-account Check ad server sandbox account readiness · Get ad server source sandbox-account readiness #
Ask an LLM
“Is the sandbox advertiser account ready for no-spend tests on my ad server source?”
“Can I check sandbox readiness before running buyer-stack tests?”
Tell an agent
Check sandbox account readiness for ad server source {esaId}.
Show the sandbox account status on source {esaId}.
POST /esa/{esaId}/sandbox-account/ensure Create or repair the ad server sandbox account · Ensure ad server source sandbox account exists #
Ask an LLM
“How do I make sure a sandbox advertiser account exists for no-spend testing?”
“Can a broken sandbox account mapping be repaired automatically?”
Tell an agent
Ensure the sandbox account exists on ad server source {esaId}.
Create or repair the no-spend sandbox account for source {esaId}.
GET /esa/{esaId}/advertisers List ad server advertisers for any adapter · List adapter advertisers #
Ask an LLM
“Which advertisers exist in my connected ad server, whatever platform it is?”
“How can I tell if the advertiser roster read was complete?”
Tell an agent
List advertisers on ad server source {esaId}.
Read up to {limit} advertisers from the ad server behind {esaId}.
GET /esa/{esaId}/gam/advertisers List cached Google Ad Manager advertisers · List cached GAM advertisers #
Ask an LLM
“Which Google Ad Manager advertisers are cached for my source?”
“Can I search cached GAM advertisers by name?”
Tell an agent
List cached GAM advertisers for source {esaId}.
Search cached GAM advertisers on {esaId} for {q}.
POST /esa/{esaId}/gam/advertisers/ensure Find or create a GAM advertiser by name · Ensure a GAM advertiser exists #
Ask an LLM
“How do I create a Google Ad Manager advertiser to route buyers to?”
“Can I dry-run creating a GAM advertiser first?”
Tell an agent
Ensure a GAM advertiser named {name} exists on source {esaId}.
Find or create GAM advertiser {name} for {esaId}, dry run {dryRun}.
PUT /esa/{esaId}/default-advertiser Set the catch-all advertiser for any ad server · Set default advertiser #
Ask an LLM
“Where do unmatched buyers get routed in my ad server?”
“Can I set a default advertiser without caring which ad server backs the agent?”
Tell an agent
Set the default advertiser on source {esaId} to {advertiserId}.
Route all unmatched buyers on {esaId} to advertiser {advertiserId}.
PUT /esa/{esaId}/gam/default-advertiser Set the default GAM advertiser · Set default GAM advertiser #
Ask an LLM
“Can I set the Google Ad Manager-specific default advertiser for buyer routing?”
“Is there a GAM-only way to pick the fallback advertiser?”
Tell an agent
Set the default GAM advertiser for {esaId} to {gamAdvertiserId}.
Use GAM advertiser {gamAdvertiserId} as the fallback on GAM source {esaId}.
POST /esa/{esaId}/gam-custom-targeting-keys/ensure Create GAM custom-targeting keys · Ensure GAM custom-targeting keys exist #
Ask an LLM
“How do I add custom-targeting keys in Google Ad Manager through my source?”
“Will existing GAM keys be duplicated if I ensure them again?”
Tell an agent
Ensure GAM custom-targeting keys {keys} exist on {esaId}.
Create missing custom-targeting keys {keys} in GAM for source {esaId}.
PUT /esa/{esaId}/axe-keys Configure AXE targeting key names · Configure AXE custom-targeting key names #
Ask an LLM
“Which GAM keys carry Scope3 include, exclude and emissions macro targeting?”
“Does the AXE macro key have to be a specific value?”
Tell an agent
Configure AXE keys on {esaId}: include {axeIncludeKey}, exclude {axeExcludeKey}, macro {axeMacroKey}.
Set AXE include key {axeIncludeKey}, exclude key {axeExcludeKey} and macro key {axeMacroKey} for source {esaId}.
GET /esa/{esaId}/buyer-advertiser-mappings List buyer-to-advertiser routing mappings · List buyer advertiser mappings #
Ask an LLM
“Which buyers are mapped to specific GAM advertisers?”
“Can I look up the routing mapping for one buyer's operator domain?”
Tell an agent
List buyer advertiser mappings on {esaId}.
Show the mapping for operator domain {operatorDomain} on {esaId}.
POST /esa/{esaId}/buyer-advertiser-mappings Map a buyer to a GAM advertiser · Create buyer advertiser mapping #
Ask an LLM
“How do I route a specific buyer to its own GAM advertiser?”
“Can a buyer mapping be scoped to one brand?”
Tell an agent
Map buyer {operatorDomain} to GAM advertiser {gamAdvertiserId} on {esaId}.
Route {operatorDomain} brand {brandId} to GAM advertiser {gamAdvertiserId} on source {esaId}.
PATCH /esa/{esaId}/buyer-advertiser-mappings/{mappingId} Update a buyer routing mapping · Update buyer advertiser mapping #
Ask an LLM
“Can I point an existing buyer mapping at a different GAM advertiser?”
“How do I change the brand on a buyer mapping?”
Tell an agent
Point mapping {mappingId} on {esaId} to GAM advertiser {gamAdvertiserId}.
Change the brand of mapping {mappingId} on {esaId} to {brandId}.
DELETE /esa/{esaId}/buyer-advertiser-mappings/{mappingId} Delete a buyer routing mapping · Delete buyer advertiser mapping #
Ask an LLM
“Can I remove a buyer-specific advertiser mapping?”
“What happens to a buyer once its mapping is deleted?”
Tell an agent destructive · confirm first
Delete buyer mapping {mappingId} on {esaId}.
Remove routing mapping {mappingId} from source {esaId}.
GET /esa/{esaId}/recent-buyers List recent buyers and how they routed · List recent buyers #
Ask an LLM
“Which buyers have hit my ad server source recently?”
“Did recent buyers go to the default advertiser or a specific mapping?”
Tell an agent
List recent buyers on {esaId}.
Show buyers seen on {esaId} in the last {days} days.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scope3/refs/heads/main/openapi/scope3-storefront-ad-server-buyer-routing-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/scope3:scope3-storefront-ad-server-buyer-routing-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

scope3-storefront-ad-server-buyer-routing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Scope3 Storefront Storefront Ad Server Buyer Routing API
  version: 2.0.0
  description: 'REST API for partners to manage storefronts, inventory sources, and billing.


    ## Authentication


    All endpoints require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer your-api-key

    ```


    ## Base URL


    `https://api.interchange.io/api/v2/storefront`


    ## For AI Agents


    AI agents can use the MCP endpoint at `/mcp/v2/storefront` with three tools:

    - `initialize`: Start an MCP session

    - `api_call`: Make REST API calls

    - `ask_about_capability`: Learn about API features'
servers:
- url: https://api.interchange.io/api/v2/storefront
  description: Production server
tags:


# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scope3/refs/heads/main/openapi/scope3-storefront-ad-server-buyer-routing-api-openapi.yml