v3

latestOpenAPI 3.1.02026-08-08123192255.1 KB

external-v2-deals

List Deal Index Observations

Return candidate metric observations for a SOT or metric on a deal.

MCP clients use this after :func:search_deal_index to inspect the underlying observations behind a SOT value, then optionally promote one via :func:update_deal_index_fact.

post/api/external/v2/deals/{deal_id}/index/observations

Path parameters

deal_idinteger required

Request body

sot_idstring nullable

Prefixed SOT id from index/search results (e.g. 'd:123', 'a:42:property:690').

metric_idinteger nullable

Metric definition id; fallback when sot_id is unavailable.

entity_refstring nullable

Narrow observations for entity-specific metrics.

pageinteger

1-based page number.

limitinteger

Max observations per page (1-200, clamped).

include_signed_urlsboolean

When true, include time-limited signed URLs for document-backed source attachments.

Response

Successful Response

request_idstring required

timestampstring required

{"stackTrail":"components:schemas:DealIndexObservationListResponse:properties:pagination","oasType":"schema","type":"unknown","title":"Pagination"}