Get a demand signal routed to a storefront

curl --request GET \
  --url https://api.interchange.io/api/v2/storefront/storefronts/{storefrontId}/demand-signals/{signalId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.interchange.io/api/v2/storefront/storefronts/{storefrontId}/demand-signals/{signalId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.interchange.io/api/v2/storefront/storefronts/{storefrontId}/demand-signals/{signalId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "customerId": 0,
  "advertiserId": 0,
  "brandDomain": "<string>",
  "buyerName": "<string>",
  "advertiserName": "<string>",
  "campaignName": "<string>",
  "audience": "<string>",
  "geo": "<string>",
  "channels": [],
  "exclusions": [
    {
      "values": [],
      "raw": "<string>"
    }
  ],
  "startDate": "<string>",
  "endDate": "<string>",
  "flexibility": {
    "days": 4503599627370495
  },
  "statedBudget": 123,
  "currency": "<string>",
  "primaryKpi": {
    "raw": "<string>",
    "parsed": {
      "value": 123
    }
  },
  "priceExpect": 123,
  "creativeReady": true,
  "rawPrompt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "storefrontId": "<string>",
  "target": {
    "id": "<string>",
    "demandSignalId": "<string>",
    "storefrontId": "<string>",
    "externalPublisherName": "<string>",
    "externalPublisherDomain": "<string>",
    "matchPct": 50,
    "dispatchAttemptedAt": "<string>",
    "dispatchedAt": "<string>",
    "acknowledgedAt": "<string>",
    "errorMessage": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

GET

storefronts

{storefrontId}

demand-signals

{signalId}

Get a demand signal routed to a storefront

curl --request GET \
  --url https://api.interchange.io/api/v2/storefront/storefronts/{storefrontId}/demand-signals/{signalId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.interchange.io/api/v2/storefront/storefronts/{storefrontId}/demand-signals/{signalId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.interchange.io/api/v2/storefront/storefronts/{storefrontId}/demand-signals/{signalId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "customerId": 0,
  "advertiserId": 0,
  "brandDomain": "<string>",
  "buyerName": "<string>",
  "advertiserName": "<string>",
  "campaignName": "<string>",
  "audience": "<string>",
  "geo": "<string>",
  "channels": [],
  "exclusions": [
    {
      "values": [],
      "raw": "<string>"
    }
  ],
  "startDate": "<string>",
  "endDate": "<string>",
  "flexibility": {
    "days": 4503599627370495
  },
  "statedBudget": 123,
  "currency": "<string>",
  "primaryKpi": {
    "raw": "<string>",
    "parsed": {
      "value": 123
    }
  },
  "priceExpect": 123,
  "creativeReady": true,
  "rawPrompt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "storefrontId": "<string>",
  "target": {
    "id": "<string>",
    "demandSignalId": "<string>",
    "storefrontId": "<string>",
    "externalPublisherName": "<string>",
    "externalPublisherDomain": "<string>",
    "matchPct": 50,
    "dispatchAttemptedAt": "<string>",
    "dispatchedAt": "<string>",
    "acknowledgedAt": "<string>",
    "errorMessage": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

API key or access token

Path Parameters

storefrontId

integer

required

Required range: 1 <= x <= 9007199254740991

signalId

integer

required

Required range: 1 <= x <= 9007199254740991

Response

Get a demand signal routed to a storefront

A demand signal as seen by ONE storefront. Carries only buyer-set brief fields + per-storefront state (status, target, storefrontId). Buyer-side signal-wide aggregates are intentionally excluded — they have no per-storefront variant and would leak competitive activity across sellers.

string

required

customerId

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

advertiserId

integer | null

required

Required range: -9007199254740991 <= x <= 9007199254740991

brandDomain

string | null

required

buyerName

string

required

advertiserName

string

required

campaignName

string | null

required

audience

string

required

geo

string

required

channels

enum<string>[]

required

Channel the buyer wants to reach. Maps to ADCP MediaType. Lower-case to match the AdCP wire format; only Postgres-enum types use UPPERCASE.

Available options:

display,

native,

video,

audio,

ctv,

dooh,

newsletter,

podcast

exclusions

object[]

required

Show child attributes

startDate

string

required

endDate

string

required

flexibility

object | null

required

Show child attributes

statedBudget

number

required

currency

string

required

primaryKpi

object | null

required

Show child attributes

priceExpect

number | null

required

creativeReady

boolean | null

required

rawPrompt

string | null

required

targetingMode

enum<string>

required

DIRECT = buyer named the seller(s). FILTERED = matched ≤5 candidates. BROAD = >5.

Available options:

DIRECT,

FILTERED,

BROAD

createdAt

string

required

updatedAt

string

required

status

enum<string>

required

Lifecycle of a demand signal. SEARCHING on create; QUOTED when at least one seller responds; BOOKED when at least one target converts to a deal; ABANDONED after idle; DECLINED if every target declined.

Available options:

SEARCHING,

QUOTED,

BOOKED,

ABANDONED,

DECLINED

storefrontId

string

required

target

object

required

One target publisher within a demand signal. Identified by either storefrontId (live / coming-soon) or externalPublisherName (not-on-Interchange) — never both.

Show child attributes

List demand signals routed to a storefront Respond to a demand signal

⌘I