curl --request GET \
--url https://api.interchange.io/api/v2/buyer/discovery/{discoveryId}/products \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/discovery/{discoveryId}/products"
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/buyer/discovery/{discoveryId}/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"discoveryId": "<string>",
"products": [
{
"productId": "<string>",
"salesAgentId": "<string>",
"selectedAt": "<string>",
"groupId": "<string>",
"groupName": "<string>",
"storefrontId": "<string>",
"inventorySourceId": "<string>",
"selectionId": "<string>",
"bidPrice": 123,
"budget": 123,
"targetingOverlay": {
"geo_countries": [
"<string>"
],
"geo_countries_exclude": [
"<string>"
],
"geo_regions": [
"<string>"
],
"geo_regions_exclude": [
"<string>"
],
"geo_metros": [
{
"system": "nielsen_dma",
"values": [
"<string>"
]
}
],
"geo_metros_exclude": [
{
"system": "nielsen_dma",
"values": [
"<string>"
]
}
],
"geo_postal_areas": [
{
"country": "<string>",
"system": "postal_code",
"values": [
"<string>"
]
}
],
"geo_postal_areas_exclude": [
{
"country": "<string>",
"system": "postal_code",
"values": [
"<string>"
]
}
],
"daypart_targets": [
{
"days": [
"monday"
],
"start_hour": 11.5,
"end_hour": 12.5,
"label": "<string>"
}
],
"axe_include_segment": "<string>",
"axe_exclude_segment": "<string>",
"audience_include": [
"<string>"
],
"audience_exclude": [
"<string>"
],
"signal_targeting_groups": {
"operator": "all",
"groups": [
{
"operator": "any",
"signals": [
{
"pricing_option_id": "<string>",
"signal_agent_segment_id": "<string>",
"activation_key": {
"type": "segment_id",
"segment_id": "<string>"
}
}
]
}
]
},
"signal_targeting": [
{
"value_type": "binary",
"value": true,
"signal_ref": {
"scope": "product",
"signal_id": "<string>"
},
"signal_id": {
"source": "catalog",
"data_provider_domain": "<string>",
"id": "<string>"
}
}
],
"frequency_cap": {
"suppress": {
"interval": 2,
"unit": "seconds"
},
"suppress_minutes": 1,
"max_impressions": 2,
"per": "individuals",
"window": {
"interval": 2,
"unit": "seconds"
}
},
"property_list": {
"agent_url": "<string>",
"list_id": "<string>",
"auth_token": "<string>"
},
"collection_list": {
"agent_url": "<string>",
"list_id": "<string>",
"auth_token": "<string>"
},
"collection_list_exclude": {
"agent_url": "<string>",
"list_id": "<string>",
"auth_token": "<string>"
},
"age_restriction": {
"min": 56,
"verification_required": true,
"accepted_methods": [
"facial_age_estimation"
]
},
"device_platform": [
"ios"
],
"device_type": [
"desktop"
],
"device_type_exclude": [
"desktop"
],
"store_catchments": [
{
"catalog_id": "<string>",
"store_ids": [
"<string>"
],
"catchment_ids": [
"<string>"
]
}
],
"geo_proximity": [
{
"lat": 0,
"lng": 0,
"travel_time": {
"value": 2,
"unit": "min"
},
"transport_mode": "walking",
"label": "<string>",
"ext": {}
}
],
"language": [
"<string>"
],
"keyword_targets": [
{
"keyword": "<string>",
"match_type": "broad",
"bid_price": 1
}
],
"negative_keywords": [
{
"keyword": "<string>",
"match_type": "broad"
}
]
}
}
],
"totalProducts": 0,
"budgetContext": {
"sessionBudget": 123,
"allocatedBudget": 123,
"remainingBudget": 123,
"budgetWarning": "<string>"
},
"campaignBound": true,
"campaignWarning": "<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 selected products
Get the list of products that have been selected in this discovery session.
curl --request GET \
--url https://api.interchange.io/api/v2/buyer/discovery/{discoveryId}/products \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/discovery/{discoveryId}/products"
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/buyer/discovery/{discoveryId}/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"discoveryId": "<string>",
"products": [
{
"productId": "<string>",
"salesAgentId": "<string>",
"selectedAt": "<string>",
"groupId": "<string>",
"groupName": "<string>",
"storefrontId": "<string>",
"inventorySourceId": "<string>",
"selectionId": "<string>",
"bidPrice": 123,
"budget": 123,
"targetingOverlay": {
"geo_countries": [
"<string>"
],
"geo_countries_exclude": [
"<string>"
],
"geo_regions": [
"<string>"
],
"geo_regions_exclude": [
"<string>"
],
"geo_metros": [
{
"system": "nielsen_dma",
"values": [
"<string>"
]
}
],
"geo_metros_exclude": [
{
"system": "nielsen_dma",
"values": [
"<string>"
]
}
],
"geo_postal_areas": [
{
"country": "<string>",
"system": "postal_code",
"values": [
"<string>"
]
}
],
"geo_postal_areas_exclude": [
{
"country": "<string>",
"system": "postal_code",
"values": [
"<string>"
]
}
],
"daypart_targets": [
{
"days": [
"monday"
],
"start_hour": 11.5,
"end_hour": 12.5,
"label": "<string>"
}
],
"axe_include_segment": "<string>",
"axe_exclude_segment": "<string>",
"audience_include": [
"<string>"
],
"audience_exclude": [
"<string>"
],
"signal_targeting_groups": {
"operator": "all",
"groups": [
{
"operator": "any",
"signals": [
{
"pricing_option_id": "<string>",
"signal_agent_segment_id": "<string>",
"activation_key": {
"type": "segment_id",
"segment_id": "<string>"
}
}
]
}
]
},
"signal_targeting": [
{
"value_type": "binary",
"value": true,
"signal_ref": {
"scope": "product",
"signal_id": "<string>"
},
"signal_id": {
"source": "catalog",
"data_provider_domain": "<string>",
"id": "<string>"
}
}
],
"frequency_cap": {
"suppress": {
"interval": 2,
"unit": "seconds"
},
"suppress_minutes": 1,
"max_impressions": 2,
"per": "individuals",
"window": {
"interval": 2,
"unit": "seconds"
}
},
"property_list": {
"agent_url": "<string>",
"list_id": "<string>",
"auth_token": "<string>"
},
"collection_list": {
"agent_url": "<string>",
"list_id": "<string>",
"auth_token": "<string>"
},
"collection_list_exclude": {
"agent_url": "<string>",
"list_id": "<string>",
"auth_token": "<string>"
},
"age_restriction": {
"min": 56,
"verification_required": true,
"accepted_methods": [
"facial_age_estimation"
]
},
"device_platform": [
"ios"
],
"device_type": [
"desktop"
],
"device_type_exclude": [
"desktop"
],
"store_catchments": [
{
"catalog_id": "<string>",
"store_ids": [
"<string>"
],
"catchment_ids": [
"<string>"
]
}
],
"geo_proximity": [
{
"lat": 0,
"lng": 0,
"travel_time": {
"value": 2,
"unit": "min"
},
"transport_mode": "walking",
"label": "<string>",
"ext": {}
}
],
"language": [
"<string>"
],
"keyword_targets": [
{
"keyword": "<string>",
"match_type": "broad",
"bid_price": 1
}
],
"negative_keywords": [
{
"keyword": "<string>",
"match_type": "broad"
}
]
}
}
],
"totalProducts": 0,
"budgetContext": {
"sessionBudget": 123,
"allocatedBudget": 123,
"remainingBudget": 123,
"budgetWarning": "<string>"
},
"campaignBound": true,
"campaignWarning": "<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
API key or access token
Path Parameters
Discovery ID
1"abc123-def456-ghi789"
Response
Get selected products
Response containing selected products
Discovery ID
Selected products in the discovery session
Show child attributes
Show child attributes
Total number of selected products
-9007199254740991 <= x <= 9007199254740991Budget allocation context
Show child attributes
Show child attributes
Whether this discovery session is attached to an active campaign. When false, the products are saved to the session but no active campaign reflects them yet.
Guidance shown only when campaignBound is false: either the session is not attached to any campaign, or the campaign it was attached to has been archived. Pass campaignId for an active campaign (or restore the archived one) so the campaign reflects the products.