Browse products for discovery session

curl --request GET \
  --url https://api.apostra.com/api/v2/buyer/discovery/{discoveryId}/discover-products \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.apostra.com/api/v2/buyer/discovery/{discoveryId}/discover-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.apostra.com/api/v2/buyer/discovery/{discoveryId}/discover-products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "discoveryId": "abc123-def456-ghi789",
  "productGroups": [
    {
      "groupId": "<string>",
      "groupName": "<string>",
      "products": [
        {
          "productId": "prod_123",
          "name": "Premium CTV Inventory - Sports",
          "channel": "ctv",
          "channels": [
            "streaming_audio",
            "podcast"
          ],
          "inventoryType": "run_of_site",
          "formatTypes": [
            "video_hosted"
          ],
          "cpm": 12.5,
          "currency": "USD",
          "expiresAt": "2023-11-07T05:31:56Z",
          "pricingScope": "public",
          "salesAgentId": "<string>",
          "salesAgentName": "<string>",
          "storefrontId": "<string>",
          "inventorySourceId": "<string>",
          "storefrontName": "<string>",
          "supportedRoutingTypes": [
            "DECISIONED"
          ],
          "description": "<string>",
          "deliveryType": "guaranteed",
          "briefRelevance": "<string>",
          "productCard": {
            "image": {
              "asset_type": "image",
              "url": "<string>",
              "width": 4503599627370496,
              "height": 4503599627370496,
              "file_size_bytes": 4503599627370496,
              "pixel_ratio": 1,
              "state_id": "<string>",
              "breakpoint_id": "<string>",
              "focal_point": [
                123
              ],
              "format": "<string>",
              "alt_text": "<string>",
              "provenance": {
                "digital_source_type": "digital_capture",
                "synthetic_depiction": true,
                "ai_tool": {
                  "name": "<string>",
                  "version": "<string>",
                  "provider": "<string>"
                },
                "human_oversight": "none",
                "declared_by": {
                  "role": "creator",
                  "agent_url": "<string>"
                },
                "declared_at": "<string>",
                "created_time": "<string>",
                "c2pa": {
                  "manifest_url": "<string>"
                },
                "embedded_provenance": [
                  {
                    "method": "manifest_wrapper",
                    "provider": "<string>",
                    "standard": "<string>",
                    "verify_agent": {
                      "agent_url": "<string>",
                      "feature_id": "<string>"
                    },
                    "embedded_at": "<string>"
                  }
                ],
                "watermarks": [
                  {
                    "media_type": "audio",
                    "provider": "<string>",
                    "verify_agent": {
                      "agent_url": "<string>",
                      "feature_id": "<string>"
                    },
                    "c2pa_action": "c2pa.watermarked.bound",
                    "embedded_at": "<string>"
                  }
                ],
                "disclosure": {
                  "required": true,
                  "jurisdictions": [
                    {
                      "country": "<string>",
                      "regulation": "<string>",
                      "region": "<string>",
                      "label_text": "<string>",
                      "render_guidance": {
                        "persistence": "continuous",
                        "min_duration_ms": 4503599627370496,
                        "positions": [
                          "prominent"
                        ],
                        "ext": {}
                      }
                    }
                  ]
                },
                "verification": [
                  {
                    "verified_by": "<string>",
                    "result": "authentic",
                    "verified_time": "<string>",
                    "confidence": 0.5,
                    "details_url": "<string>"
                  }
                ],
                "ext": {}
              }
            },
            "title": "<string>",
            "description": "<string>",
            "price_label": "<string>",
            "cta_label": "<string>"
          },
          "productCardDetailed": {
            "hero_image": {
              "asset_type": "image",
              "url": "<string>",
              "width": 4503599627370496,
              "height": 4503599627370496,
              "file_size_bytes": 4503599627370496,
              "pixel_ratio": 1,
              "state_id": "<string>",
              "breakpoint_id": "<string>",
              "focal_point": [
                123
              ],
              "format": "<string>",
              "alt_text": "<string>",
              "provenance": {
                "digital_source_type": "digital_capture",
                "synthetic_depiction": true,
                "ai_tool": {
                  "name": "<string>",
                  "version": "<string>",
                  "provider": "<string>"
                },
                "human_oversight": "none",
                "declared_by": {
                  "role": "creator",
                  "agent_url": "<string>"
                },
                "declared_at": "<string>",
                "created_time": "<string>",
                "c2pa": {
                  "manifest_url": "<string>"
                },
                "embedded_provenance": [
                  {
                    "method": "manifest_wrapper",
                    "provider": "<string>",
                    "standard": "<string>",
                    "verify_agent": {
                      "agent_url": "<string>",
                      "feature_id": "<string>"
                    },
                    "embedded_at": "<string>"
                  }
                ],
                "watermarks": [
                  {
                    "media_type": "audio",
                    "provider": "<string>",
                    "verify_agent": {
                      "agent_url": "<string>",
                      "feature_id": "<string>"
                    },
                    "c2pa_action": "c2pa.watermarked.bound",
                    "embedded_at": "<string>"
                  }
                ],
                "disclosure": {
                  "required": true,
                  "jurisdictions": [
                    {
                      "country": "<string>",
                      "regulation": "<string>",
                      "region": "<string>",
                      "label_text": "<string>",
                      "render_guidance": {
                        "persistence": "continuous",
                        "min_duration_ms": 4503599627370496,
                        "positions": [
                          "prominent"
                        ],
                        "ext": {}
                      }
                    }
                  ]
                },
                "verification": [
                  {
                    "verified_by": "<string>",
                    "result": "authentic",
                    "verified_time": "<string>",
                    "confidence": 0.5,
                    "details_url": "<string>"
                  }
                ],
                "ext": {}
              }
            },
            "carousel_images": [
              {
                "asset_type": "image",
                "url": "<string>",
                "width": 4503599627370496,
                "height": 4503599627370496,
                "file_size_bytes": 4503599627370496,
                "pixel_ratio": 1,
                "state_id": "<string>",
                "breakpoint_id": "<string>",
                "focal_point": [
                  123
                ],
                "format": "<string>",
                "alt_text": "<string>",
                "provenance": {
                  "digital_source_type": "digital_capture",
                  "synthetic_depiction": true,
                  "ai_tool": {
                    "name": "<string>",
                    "version": "<string>",
                    "provider": "<string>"
                  },
                  "human_oversight": "none",
                  "declared_by": {
                    "role": "creator",
                    "agent_url": "<string>"
                  },
                  "declared_at": "<string>",
                  "created_time": "<string>",
                  "c2pa": {
                    "manifest_url": "<string>"
                  },
                  "embedded_provenance": [
                    {
                      "method": "manifest_wrapper",
                      "provider": "<string>",
                      "standard": "<string>",
                      "verify_agent": {
                        "agent_url": "<string>",
                        "feature_id": "<string>"
                      },
                      "embedded_at": "<string>"
                    }
                  ],
                  "watermarks": [
                    {
                      "media_type": "audio",
                      "provider": "<string>",
                      "verify_agent": {
                        "agent_url": "<string>",
                        "feature_id": "<string>"
                      },
                      "c2pa_action": "c2pa.watermarked.bound",
                      "embedded_at": "<string>"
                    }
                  ],
                  "disclosure": {
                    "required": true,
                    "jurisdictions": [
                      {
                        "country": "<string>",
                        "regulation": "<string>",
                        "region": "<string>",
                        "label_text": "<string>",
                        "render_guidance": {
                          "persistence": "continuous",
                          "min_duration_ms": 4503599627370496,
                          "positions": [
                            "prominent"
                          ],
                          "ext": {}
                        }
                      }
                    ]
                  },
                  "verification": [
                    {
                      "verified_by": "<string>",
                      "result": "authentic",
                      "verified_time": "<string>",
                      "confidence": 0.5,
                      "details_url": "<string>"
                    }
                  ],
                  "ext": {}
                }
              }
            ],
            "title": "<string>",
            "description": "<string>",
            "specifications": [
              {
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "price_label": "<string>",
            "cta_label": "<string>"
          },
          "pricingOptions": [
            {
              "pricingOptionId": "<string>",
              "pricingModel": "<string>",
              "isFixed": true,
              "rate": 123,
              "floorPrice": 123,
              "fixedPrice": 123,
              "maxBid": true,
              "currency": "<string>",
              "priceGuidance": {
                "floor": 123,
                "p25": 123,
                "p50": 123,
                "p75": 123,
                "p90": 123
              }
            }
          ],
          "estimatedExposures": 0,
          "forecast": {},
          "bookability": "<string>",
          "publisherProperties": [
            {
              "publisherDomain": "<string>",
              "propertyType": "<string>",
              "name": "<string>",
              "selectionType": "<string>",
              "identifiers": [
                {}
              ]
            }
          ],
          "isSandbox": true,
          "formatOptions": [
            {
              "format_kind": "video_hosted",
              "format_option_id": "<string>",
              "display_name": "<string>",
              "params": {
                "containers": [
                  "mp4"
                ],
                "video_codecs": [
                  "h264"
                ],
                "audio_codecs": [
                  "aac"
                ]
              }
            }
          ],
          "supportedTargeting": [
            "<string>"
          ]
        }
      ],
      "productCount": 4503599627370495,
      "totalProducts": 4503599627370495,
      "hasMoreProducts": true,
      "storefrontId": "<string>",
      "storefrontName": "<string>",
      "description": "<string>"
    }
  ],
  "totalGroups": 25,
  "hasMoreGroups": true,
  "summary": {
    "totalProducts": 150,
    "publishersCount": 25,
    "priceRange": {
      "min": 123,
      "max": 123,
      "avg": 123,
      "currency": "USD"
    }
  },
  "source": "snapshot",
  "excludedProductCount": 4503599627370495,
  "excludedProductCountsByStorefront": {},
  "excludedProductsByStorefront": {},
  "excludedProductsTruncatedByStorefront": {},
  "unenforceableProductCount": 4503599627370495,
  "unenforceableProductsByStorefront": {},
  "unverifiedProductCount": 4503599627370495,
  "unverifiedProductsByStorefront": {},
  "budgetContext": {
    "sessionBudget": 123,
    "allocatedBudget": 123,
    "remainingBudget": 123,
    "budgetWarning": "<string>"
  },
  "proposals": [
    {
      "proposalId": "<string>",
      "name": "<string>",
      "allocations": [
        {
          "productId": "<string>",
          "allocationPercentage": 50,
          "pricingOptionId": "<string>",
          "rationale": "<string>",
          "sequence": 0,
          "tags": [
            "<string>"
          ]
        }
      ],
      "description": "<string>",
      "briefAlignment": "<string>",
      "salesAgentId": "<string>",
      "salesAgentName": "<string>",
      "storefrontId": "<string>",
      "storefrontName": "<string>",
      "supportedRoutingTypes": [
        "DECISIONED"
      ],
      "expiresAt": "<string>",
      "totalBudgetGuidance": {
        "min": 123,
        "recommended": 123,
        "max": 123,
        "currency": "<string>"
      }
    }
  ],
  "incompleteAgents": [
    {
      "agentId": "<string>",
      "agentName": "<string>",
      "reason": "timeout",
      "waitSeconds": 4503599627370495,
      "storefronts": [
        {
          "storefrontId": "<string>",
          "storefrontName": "<string>"
        }
      ],
      "responseTimeMs": 4503599627370495,
      "incompleteScopes": [
        {
          "scope": "products",
          "description": "<string>",
          "estimatedWaitSeconds": 4503599627370495
        }
      ]
    }
  ],
  "connectionIssues": [
    {
      "providerType": "meta",
      "storefrontId": "<string>",
      "storefrontName": "<string>"
    }
  ],
  "retryWithLongerWaitAvailable": true,
  "agentResults": [
    {
      "agentId": "<string>",
      "agentName": "<string>",
      "success": true,
      "productCount": 4503599627370495,
      "responseTimeMs": 4503599627370495,
      "timedOut": true,
      "storefronts": [
        {
          "storefrontId": "<string>",
          "storefrontName": "<string>"
        }
      ],
      "error": "<string>",
      "skipReason": "<string>",
      "incomplete": [
        {
          "scope": "products",
          "description": "<string>",
          "estimated_wait": {
            "interval": 1,
            "unit": "seconds"
          }
        }
      ],
      "rawResponseData": "<unknown>",
      "debugLogs": [
        {
          "timestamp": "<string>",
          "type": "<string>",
          "message": "<string>",
          "request": {},
          "response": {}
        }
      ]
    }
  ],
  "refinementApplied": [
    {
      "status": "applied",
      "scope": "request",
      "id": "<string>",
      "notes": "<string>"
    }
  ],
  "revision": 3,
  "resultsComplete": false,
  "pendingAgents": [
    {
      "agentId": "<string>",
      "agentName": "<string>",
      "storefronts": [
        {
          "storefrontId": "<string>",
          "storefrontName": "<string>"
        }
      ]
    }
  ],
  "progress": {
    "respondedStorefrontCount": 4503599627370495,
    "totalStorefrontCount": 4503599627370495,
    "waitSeconds": 4503599627370495
  },
  "diagnostics": {
    "trace": {
      "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
      "spanId": "00f067aa0ba902b7",
      "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"
    }
  },
  "guidance": "2 seller(s) still working — call browse_discovery with sinceRevision: 3 for newly landed results."
}

{
  "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

discovery

{discoveryId}

discover-products

Browse products for discovery session

curl --request GET \
  --url https://api.apostra.com/api/v2/buyer/discovery/{discoveryId}/discover-products \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.apostra.com/api/v2/buyer/discovery/{discoveryId}/discover-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.apostra.com/api/v2/buyer/discovery/{discoveryId}/discover-products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "discoveryId": "abc123-def456-ghi789",
  "productGroups": [
    {
      "groupId": "<string>",
      "groupName": "<string>",
      "products": [
        {
          "productId": "prod_123",
          "name": "Premium CTV Inventory - Sports",
          "channel": "ctv",
          "channels": [
            "streaming_audio",
            "podcast"
          ],
          "inventoryType": "run_of_site",
          "formatTypes": [
            "video_hosted"
          ],
          "cpm": 12.5,
          "currency": "USD",
          "expiresAt": "2023-11-07T05:31:56Z",
          "pricingScope": "public",
          "salesAgentId": "<string>",
          "salesAgentName": "<string>",
          "storefrontId": "<string>",
          "inventorySourceId": "<string>",
          "storefrontName": "<string>",
          "supportedRoutingTypes": [
            "DECISIONED"
          ],
          "description": "<string>",
          "deliveryType": "guaranteed",
          "briefRelevance": "<string>",
          "productCard": {
            "image": {
              "asset_type": "image",
              "url": "<string>",
              "width": 4503599627370496,
              "height": 4503599627370496,
              "file_size_bytes": 4503599627370496,
              "pixel_ratio": 1,
              "state_id": "<string>",
              "breakpoint_id": "<string>",
              "focal_point": [
                123
              ],
              "format": "<string>",
              "alt_text": "<string>",
              "provenance": {
                "digital_source_type": "digital_capture",
                "synthetic_depiction": true,
                "ai_tool": {
                  "name": "<string>",
                  "version": "<string>",
                  "provider": "<string>"
                },
                "human_oversight": "none",
                "declared_by": {
                  "role": "creator",
                  "agent_url": "<string>"
                },
                "declared_at": "<string>",
                "created_time": "<string>",
                "c2pa": {
                  "manifest_url": "<string>"
                },
                "embedded_provenance": [
                  {
                    "method": "manifest_wrapper",
                    "provider": "<string>",
                    "standard": "<string>",
                    "verify_agent": {
                      "agent_url": "<string>",
                      "feature_id": "<string>"
                    },
                    "embedded_at": "<string>"
                  }
                ],
                "watermarks": [
                  {
                    "media_type": "audio",
                    "provider": "<string>",
                    "verify_agent": {
                      "agent_url": "<string>",
                      "feature_id": "<string>"
                    },
                    "c2pa_action": "c2pa.watermarked.bound",
                    "embedded_at": "<string>"
                  }
                ],
                "disclosure": {
                  "required": true,
                  "jurisdictions": [
                    {
                      "country": "<string>",
                      "regulation": "<string>",
                      "region": "<string>",
                      "label_text": "<string>",
                      "render_guidance": {
                        "persistence": "continuous",
                        "min_duration_ms": 4503599627370496,
                        "positions": [
                          "prominent"
                        ],
                        "ext": {}
                      }
                    }
                  ]
                },
                "verification": [
                  {
                    "verified_by": "<string>",
                    "result": "authentic",
                    "verified_time": "<string>",
                    "confidence": 0.5,
                    "details_url": "<string>"
                  }
                ],
                "ext": {}
              }
            },
            "title": "<string>",
            "description": "<string>",
            "price_label": "<string>",
            "cta_label": "<string>"
          },
          "productCardDetailed": {
            "hero_image": {
              "asset_type": "image",
              "url": "<string>",
              "width": 4503599627370496,
              "height": 4503599627370496,
              "file_size_bytes": 4503599627370496,
              "pixel_ratio": 1,
              "state_id": "<string>",
              "breakpoint_id": "<string>",
              "focal_point": [
                123
              ],
              "format": "<string>",
              "alt_text": "<string>",
              "provenance": {
                "digital_source_type": "digital_capture",
                "synthetic_depiction": true,
                "ai_tool": {
                  "name": "<string>",
                  "version": "<string>",
                  "provider": "<string>"
                },
                "human_oversight": "none",
                "declared_by": {
                  "role": "creator",
                  "agent_url": "<string>"
                },
                "declared_at": "<string>",
                "created_time": "<string>",
                "c2pa": {
                  "manifest_url": "<string>"
                },
                "embedded_provenance": [
                  {
                    "method": "manifest_wrapper",
                    "provider": "<string>",
                    "standard": "<string>",
                    "verify_agent": {
                      "agent_url": "<string>",
                      "feature_id": "<string>"
                    },
                    "embedded_at": "<string>"
                  }
                ],
                "watermarks": [
                  {
                    "media_type": "audio",
                    "provider": "<string>",
                    "verify_agent": {
                      "agent_url": "<string>",
                      "feature_id": "<string>"
                    },
                    "c2pa_action": "c2pa.watermarked.bound",
                    "embedded_at": "<string>"
                  }
                ],
                "disclosure": {
                  "required": true,
                  "jurisdictions": [
                    {
                      "country": "<string>",
                      "regulation": "<string>",
                      "region": "<string>",
                      "label_text": "<string>",
                      "render_guidance": {
                        "persistence": "continuous",
                        "min_duration_ms": 4503599627370496,
                        "positions": [
                          "prominent"
                        ],
                        "ext": {}
                      }
                    }
                  ]
                },
                "verification": [
                  {
                    "verified_by": "<string>",
                    "result": "authentic",
                    "verified_time": "<string>",
                    "confidence": 0.5,
                    "details_url": "<string>"
                  }
                ],
                "ext": {}
              }
            },
            "carousel_images": [
              {
                "asset_type": "image",
                "url": "<string>",
                "width": 4503599627370496,
                "height": 4503599627370496,
                "file_size_bytes": 4503599627370496,
                "pixel_ratio": 1,
                "state_id": "<string>",
                "breakpoint_id": "<string>",
                "focal_point": [
                  123
                ],
                "format": "<string>",
                "alt_text": "<string>",
                "provenance": {
                  "digital_source_type": "digital_capture",
                  "synthetic_depiction": true,
                  "ai_tool": {
                    "name": "<string>",
                    "version": "<string>",
                    "provider": "<string>"
                  },
                  "human_oversight": "none",
                  "declared_by": {
                    "role": "creator",
                    "agent_url": "<string>"
                  },
                  "declared_at": "<string>",
                  "created_time": "<string>",
                  "c2pa": {
                    "manifest_url": "<string>"
                  },
                  "embedded_provenance": [
                    {
                      "method": "manifest_wrapper",
                      "provider": "<string>",
                      "standard": "<string>",
                      "verify_agent": {
                        "agent_url": "<string>",
                        "feature_id": "<string>"
                      },
                      "embedded_at": "<string>"
                    }
                  ],
                  "watermarks": [
                    {
                      "media_type": "audio",
                      "provider": "<string>",
                      "verify_agent": {
                        "agent_url": "<string>",
                        "feature_id": "<string>"
                      },
                      "c2pa_action": "c2pa.watermarked.bound",
                      "embedded_at": "<string>"
                    }
                  ],
                  "disclosure": {
                    "required": true,
                    "jurisdictions": [
                      {
                        "country": "<string>",
                        "regulation": "<string>",
                        "region": "<string>",
                        "label_text": "<string>",
                        "render_guidance": {
                          "persistence": "continuous",
                          "min_duration_ms": 4503599627370496,
                          "positions": [
                            "prominent"
                          ],
                          "ext": {}
                        }
                      }
                    ]
                  },
                  "verification": [
                    {
                      "verified_by": "<string>",
                      "result": "authentic",
                      "verified_time": "<string>",
                      "confidence": 0.5,
                      "details_url": "<string>"
                    }
                  ],
                  "ext": {}
                }
              }
            ],
            "title": "<string>",
            "description": "<string>",
            "specifications": [
              {
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "price_label": "<string>",
            "cta_label": "<string>"
          },
          "pricingOptions": [
            {
              "pricingOptionId": "<string>",
              "pricingModel": "<string>",
              "isFixed": true,
              "rate": 123,
              "floorPrice": 123,
              "fixedPrice": 123,
              "maxBid": true,
              "currency": "<string>",
              "priceGuidance": {
                "floor": 123,
                "p25": 123,
                "p50": 123,
                "p75": 123,
                "p90": 123
              }
            }
          ],
          "estimatedExposures": 0,
          "forecast": {},
          "bookability": "<string>",
          "publisherProperties": [
            {
              "publisherDomain": "<string>",
              "propertyType": "<string>",
              "name": "<string>",
              "selectionType": "<string>",
              "identifiers": [
                {}
              ]
            }
          ],
          "isSandbox": true,
          "formatOptions": [
            {
              "format_kind": "video_hosted",
              "format_option_id": "<string>",
              "display_name": "<string>",
              "params": {
                "containers": [
                  "mp4"
                ],
                "video_codecs": [
                  "h264"
                ],
                "audio_codecs": [
                  "aac"
                ]
              }
            }
          ],
          "supportedTargeting": [
            "<string>"
          ]
        }
      ],
      "productCount": 4503599627370495,
      "totalProducts": 4503599627370495,
      "hasMoreProducts": true,
      "storefrontId": "<string>",
      "storefrontName": "<string>",
      "description": "<string>"
    }
  ],
  "totalGroups": 25,
  "hasMoreGroups": true,
  "summary": {
    "totalProducts": 150,
    "publishersCount": 25,
    "priceRange": {
      "min": 123,
      "max": 123,
      "avg": 123,
      "currency": "USD"
    }
  },
  "source": "snapshot",
  "excludedProductCount": 4503599627370495,
  "excludedProductCountsByStorefront": {},
  "excludedProductsByStorefront": {},
  "excludedProductsTruncatedByStorefront": {},
  "unenforceableProductCount": 4503599627370495,
  "unenforceableProductsByStorefront": {},
  "unverifiedProductCount": 4503599627370495,
  "unverifiedProductsByStorefront": {},
  "budgetContext": {
    "sessionBudget": 123,
    "allocatedBudget": 123,
    "remainingBudget": 123,
    "budgetWarning": "<string>"
  },
  "proposals": [
    {
      "proposalId": "<string>",
      "name": "<string>",
      "allocations": [
        {
          "productId": "<string>",
          "allocationPercentage": 50,
          "pricingOptionId": "<string>",
          "rationale": "<string>",
          "sequence": 0,
          "tags": [
            "<string>"
          ]
        }
      ],
      "description": "<string>",
      "briefAlignment": "<string>",
      "salesAgentId": "<string>",
      "salesAgentName": "<string>",
      "storefrontId": "<string>",
      "storefrontName": "<string>",
      "supportedRoutingTypes": [
        "DECISIONED"
      ],
      "expiresAt": "<string>",
      "totalBudgetGuidance": {
        "min": 123,
        "recommended": 123,
        "max": 123,
        "currency": "<string>"
      }
    }
  ],
  "incompleteAgents": [
    {
      "agentId": "<string>",
      "agentName": "<string>",
      "reason": "timeout",
      "waitSeconds": 4503599627370495,
      "storefronts": [
        {
          "storefrontId": "<string>",
          "storefrontName": "<string>"
        }
      ],
      "responseTimeMs": 4503599627370495,
      "incompleteScopes": [
        {
          "scope": "products",
          "description": "<string>",
          "estimatedWaitSeconds": 4503599627370495
        }
      ]
    }
  ],
  "connectionIssues": [
    {
      "providerType": "meta",
      "storefrontId": "<string>",
      "storefrontName": "<string>"
    }
  ],
  "retryWithLongerWaitAvailable": true,
  "agentResults": [
    {
      "agentId": "<string>",
      "agentName": "<string>",
      "success": true,
      "productCount": 4503599627370495,
      "responseTimeMs": 4503599627370495,
      "timedOut": true,
      "storefronts": [
        {
          "storefrontId": "<string>",
          "storefrontName": "<string>"
        }
      ],
      "error": "<string>",
      "skipReason": "<string>",
      "incomplete": [
        {
          "scope": "products",
          "description": "<string>",
          "estimated_wait": {
            "interval": 1,
            "unit": "seconds"
          }
        }
      ],
      "rawResponseData": "<unknown>",
      "debugLogs": [
        {
          "timestamp": "<string>",
          "type": "<string>",
          "message": "<string>",
          "request": {},
          "response": {}
        }
      ]
    }
  ],
  "refinementApplied": [
    {
      "status": "applied",
      "scope": "request",
      "id": "<string>",
      "notes": "<string>"
    }
  ],
  "revision": 3,
  "resultsComplete": false,
  "pendingAgents": [
    {
      "agentId": "<string>",
      "agentName": "<string>",
      "storefronts": [
        {
          "storefrontId": "<string>",
          "storefrontName": "<string>"
        }
      ]
    }
  ],
  "progress": {
    "respondedStorefrontCount": 4503599627370495,
    "totalStorefrontCount": 4503599627370495,
    "waitSeconds": 4503599627370495
  },
  "diagnostics": {
    "trace": {
      "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
      "spanId": "00f067aa0ba902b7",
      "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"
    }
  },
  "guidance": "2 seller(s) still working — call browse_discovery with sinceRevision: 3 for newly landed results."
}

{
  "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

discoveryId

string

required

Discovery ID

Minimum string length: 1

Example:

"abc123-def456-ghi789"

Query Parameters

groupLimit

integer

default:10

Maximum number of product groups to return (default: 10, max: 10)

Required range: 0 < x <= 10

Example:

10

groupOffset

integer

default:0

Number of groups to skip for pagination

Required range: 0 <= x <= 9007199254740991

Example:

0

productsPerGroup

integer

default:10

Maximum products to return per group (default: 10, max: 15)

Required range: 0 < x <= 15

Example:

10

productOffset

integer

default:0

Number of products to skip within each group (default: 0, max: 1000)

Required range: 0 <= x <= 1000

Example:

5

publisherDomain

string

Filter products by publisher domain (exact domain component match)

Minimum string length: 1

Example:

"hulu"

pricingModel

enum<string>

Filter products by pricing model

Available options:

cpm,

vcpm,

cpc,

cpcv,

cpv,

cpp,

cpa,

revenue_share,

flat_rate,

time

Example:

"cpm"

storefrontIds

Filter products by storefront ID(s) (from list_storefronts).

Maximum array length: 50

Required range: 0 < x <= 9007199254740991

Example:

[42, 57]

storefrontNames

Filter products by storefront name (case-insensitive substring match).

Maximum array length: 50

Maximum string length: 255

Example:

["Acme", "Acme Exchange"]

debug

When true, includes detailed ADCP agent request/response debug logs in the response for troubleshooting

waitMode

enum<string>

default:quick

quick waits up to 45 seconds per storefront agent and returns partial results if slow agents miss the window. long waits up to 210 seconds per storefront agent; ask the user before using it.

Available options:

quick,

long

Example:

"quick"

waitSeconds

integer

Optional explicit per-storefront wait in seconds, max 210. Overrides waitMode. Ask the user before setting this above 30.

Required range: 0 < x <= 210

Example:

120

sinceRevision

integer

Progressive polling: return only seller groups that landed after this snapshot revision. Groups use REPLACE semantics — a group may be re-delivered at a later revision when more of its products land; replace it by groupId, never append. The response always carries the current revision, resultsComplete, and pendingAgents; poll again with the returned revision until resultsComplete is true, and stop polling after roughly the wait budget if it never turns true (the fan-out may have been interrupted).

Required range: 0 <= x <= 9007199254740991

Example:

3

Response

Browse products for discovery session

Response from discovering products

discoveryId

string

required

Discovery ID

Example:

"abc123-def456-ghi789"

productGroups

object[]

required

Products grouped by publisher

Show child attributes

totalGroups

integer

required

Total number of product groups available

Required range: 0 <= x <= 9007199254740991

Example:

25

hasMoreGroups

boolean

required

Whether more groups are available beyond those shown

summary

object

required

Summary statistics for discovered products

Show child attributes

source

enum<string>

Browse provenance. snapshot is the cached discovery result; refreshed was re-discovered and may differ from the original result.

Available options:

snapshot,

refreshed

excludedProductCount

integer

Products removed because they include properties on the advertiser's exclusion list across all storefronts.

Required range: 0 <= x <= 9007199254740991

excludedProductCountsByStorefront

object

Products removed because they include properties on the advertiser's exclusion list, keyed by storefront ID.

Show child attributes

excludedProductsByStorefront

object

Bounded details of products removed by the advertiser's exclusion list, keyed by storefront ID. Matching domains are limited to the seller product's intersection with that list.

Show child attributes

excludedProductsTruncatedByStorefront

object

True for a storefront when excludedProductsByStorefront omitted additional removed products.

Show child attributes

unenforceableProductCount

integer

Products removed across all storefronts because no route can enforce one of the advertiser's property lists on them. Present only when such a product was removed.

Required range: 0 < x <= 9007199254740991

unenforceableProductsByStorefront

object

Details of those removals keyed by storefront ID: the count, bounded products with the lists that cannot be enforced and why, and whether the product list was truncated.

Show child attributes

unverifiedProductCount

integer

Products withheld across all storefronts because we could not verify that the advertiser's property lists can be enforced on them. Retry the request. Present only when products were withheld.

Required range: 0 < x <= 9007199254740991

unverifiedProductsByStorefront

object

Details of those withheld products keyed by storefront ID: the count, bounded products, and whether the product list was truncated.

Show child attributes

budgetContext

object

Budget context if budget was provided

Show child attributes

proposals

object[]

Recommended media plans from sales agents (ADCP v3). Each proposal explains WHY certain products are recommended together and how budget should be allocated.

Show child attributes

incompleteAgents

object[]

Storefront agents that timed out, returned ADCP incomplete scopes, or had unsafe products withheld during host persistence. Present without debug=true and without raw agent or database logs.

Show child attributes

connectionIssues

object[]

Adapter storefronts skipped because the buyer has not connected an account with them, has not chosen one for this advertiser, or the connection's OAuth credentials have expired. Open Media Partners to connect or reconnect the account, then retry.

Show child attributes

retryWithLongerWaitAvailable

boolean

True when at least one storefront timed out or returned ADCP incomplete scopes and the request used less than the maximum interactive wait window.

agentResults

object[]

Per-agent debug info. Only present when debug=true; includes timing so callers can decide whether to retry with a longer wait.

Show child attributes

refinementApplied

object[]

Seller's response to each refinement instruction, matched by position to the request's refine array. Only present when refine was provided.

Show child attributes

revision

integer

Progressive delivery: monotonic snapshot revision. Present on progressive responses and sinceRevision polls; pass it back as sinceRevision to fetch only newly landed seller groups.

Required range: 0 <= x <= 9007199254740991

Example:

3

resultsComplete

boolean

Progressive delivery: false while sellers are still answering in the background. Poll browse_discovery with sinceRevision until true.

Example:

false

pendingAgents

object[]

Progressive delivery: sellers still in flight (not yet answered). Distinct from incompleteAgents, which timed out or answered partially at the final revision.

Show child attributes

progress

object

Progressive delivery: authoritative storefront response counts, independent of result-group pagination and sinceRevision delta pages.

Show child attributes

diagnostics

object

Advanced support diagnostics. Returned only to elevated/admin contexts and intended for internal troubleshooting.

Show child attributes

guidance

string

Human-readable next-step guidance. On progressive responses this spells out the exact continuation call (browse with sinceRevision); on empty results it explains what was queried and suggests adding a brief/brand URL or broadening filters.

Example:

"2 seller(s) still working — call browse_discovery with sinceRevision: 3 for newly landed results."

Start building

Core Concepts

Buyer operations

Seller operations

Cross-Cutting Reference

Buyer API reference

Seller API reference

Release Notes

Browse products for discovery session

Authorizations

Path Parameters

Query Parameters

Response