{"items":[{"type":"link","label":"Vanda Analytics Flow API","link":"/apis/flow/vanda-msvc-flow","routeSlug":"/apis/flow/vanda-msvc-flow","content":{"contentType":"overview","meta":{"name":"Vanda Analytics Flow API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"vanda-msvc-flow.json","url":"/_bundle/apis/flow/vanda-msvc-flow.json?download"},{"kind":"download","label":"vanda-msvc-flow.yaml","url":"/_bundle/apis/flow/vanda-msvc-flow.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Vanda Analytics Flow API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"High-performance Flow API with Auth0"}],"sectionId":"/apis/flow/vanda-msvc-flow"}],"sectionId":"/apis/flow/vanda-msvc-flow"}]}]}},{"type":"group","label":"Timeseries","link":"/apis/flow/vanda-msvc-flow/timeseries","routeSlug":"/apis/flow/vanda-msvc-flow/timeseries","items":[{"label":"Get flow timeseries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/timeseries/get_timeseries_flow_timeseries_get","routeSlug":"/apis/flow/vanda-msvc-flow/timeseries/get_timeseries_flow_timeseries_get","metadata":{"seo":{"title":"Get flow timeseries","description":"Observations for one or more series over a date range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_timeseries_flow_timeseries_get","name":"Get flow timeseries","isWebhook":false,"pointer":"/paths/~1flow~1timeseries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get flow timeseries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observations for one or more series over a date range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Units vary by series."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A multi-series response can mix USDmn, shares, contracts and index points, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are on every point rather than on the response. Check the unit before combining values across series."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"series_ids","in":"query","schemaId":"schema_396","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated identifiers. Accepts slug (preferred), slug without its label, series_label, entity or series_id. All but the first can match several series, and every match is returned."},"children":[]}]}]}],"required":true},{"name":"metrics","in":"query","schemaId":"schema_397","description":"Comma-separated metrics; omit for all. A series has one metric, so this selects series rather than filtering rows."},{"name":"frequency","in":"query","schemaId":"schema_398","description":"Comma-separated cadences; omit for all. Selects series, not rows. The older dod/wow/mom/qoq names are still accepted."},{"name":"start_date","in":"query","schemaId":"schema_399","description":"Start date (ISO). Intraday series cover at most 31 days per request; omit it for the latest 31 days."},{"name":"end_date","in":"query","schemaId":"schema_400","description":"End date (ISO). Intraday series default to their newest bar."},{"name":"order","in":"query","schemaId":"schema_401","description":"Sort order by timestamp"},{"name":"records_per_page","in":"query","schemaId":"schema_402","description":"Records per page"},{"name":"page_number","in":"query","schemaId":"schema_403","description":"Page number, 1-indexed"},{"name":"transformation","in":"query","schemaId":"schema_404","description":"Trailing-window transformation; one series per request."},{"name":"window","in":"query","schemaId":"schema_405","description":"Window in observations; required with transformation"},{"name":"normalisation","in":"query","schemaId":"schema_406","description":"Distribution normalisation"},{"name":"normalisation_period","in":"query","schemaId":"schema_407","description":"Lookback for normalisation; required with normalisation"},{"name":"dimensions","in":"query","schemaId":"schema_408","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeseries are history only; a forecast series' history is its neutral cell, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"projection\": 0, \"zscore\": \"All\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ret\": 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for gamma) is accepted and changes nothing. Any other cell answers 400: read the cube from /flow/forecast. JSON, because the types matter."},"children":[]}]}]}]}],"pointer":"/paths/~1flow~1timeseries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/timeseries","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"series_ids","in":"query","required":true,"schemaId":"schema_396"},{"name":"metrics","in":"query","required":false,"schemaId":"schema_397"},{"name":"frequency","in":"query","required":false,"schemaId":"schema_398"},{"name":"start_date","in":"query","required":false,"schemaId":"schema_399"},{"name":"end_date","in":"query","required":false,"schemaId":"schema_400"},{"name":"order","in":"query","required":false,"schemaId":"components/schemas/SortDirectionEnum"},{"name":"records_per_page","in":"query","required":false,"schemaId":"schema_402"},{"name":"page_number","in":"query","required":false,"schemaId":"schema_403"},{"name":"transformation","in":"query","required":false,"schemaId":"schema_404"},{"name":"window","in":"query","required":false,"schemaId":"schema_405"},{"name":"normalisation","in":"query","required":false,"schemaId":"schema_406"},{"name":"normalisation_period","in":"query","required":false,"schemaId":"schema_407"},{"name":"dimensions","in":"query","required":false,"schemaId":"schema_408"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flow/timeseries","href":"timeseries/get_timeseries_flow_timeseries_get","openApiOperationId":"get_timeseries_flow_timeseries_get","summary":"Get flow timeseries","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeseriesResponse"}},"schemaId":"components/schemas/TimeseriesResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1flow~1timeseries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TimeseriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeseriesResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/timeseries/get_timeseries_flow_timeseries_get"}],"panels":[]}]},"httpPath":"/flow/timeseries"},{"label":"Get latest flow observation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/timeseries/get_latest_flow_latest_get","routeSlug":"/apis/flow/vanda-msvc-flow/timeseries/get_latest_flow_latest_get","metadata":{"seo":{"title":"Get latest flow observation","description":"The newest observation for each series."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_latest_flow_latest_get","name":"Get latest flow observation","isWebhook":false,"pointer":"/paths/~1flow~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get latest flow observation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The newest observation for each series."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staleness_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alongside the value: coverage is uneven and many series stopped publishing years ago."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"series_ids","in":"query","schemaId":"schema_396","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated identifiers. Accepts slug (preferred), slug without its label, series_label, entity or series_id. All but the first can match several series, and every match is returned."},"children":[]}]}]}],"required":true},{"name":"metrics","in":"query","schemaId":"schema_409","description":"Comma-separated metrics; omit for all. A series has one metric, so this selects series rather than filtering rows."},{"name":"frequency","in":"query","schemaId":"schema_398","description":"Comma-separated cadences; omit for all. Selects series, not rows. The older dod/wow/mom/qoq names are still accepted."},{"name":"as_of","in":"query","schemaId":"schema_410","description":"Newest observation on or before this date"}],"pointer":"/paths/~1flow~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/latest","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"series_ids","in":"query","required":true,"schemaId":"schema_396"},{"name":"metrics","in":"query","required":false,"schemaId":"schema_409"},{"name":"frequency","in":"query","required":false,"schemaId":"schema_398"},{"name":"as_of","in":"query","required":false,"schemaId":"schema_410"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flow/latest","href":"timeseries/get_latest_flow_latest_get","openApiOperationId":"get_latest_flow_latest_get","summary":"Get latest flow observation","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LatestResponse"}},"schemaId":"components/schemas/LatestResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1flow~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LatestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LatestResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/timeseries/get_latest_flow_latest_get"}],"panels":[]}]},"httpPath":"/flow/latest"},{"label":"Get flow coverage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/timeseries/get_availability_flow_availability_get","routeSlug":"/apis/flow/vanda-msvc-flow/timeseries/get_availability_flow_availability_get","metadata":{"seo":{"title":"Get flow coverage","description":"First and last observation per series. row_count is distinct observations, not stored rows."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_availability_flow_availability_get","name":"Get flow coverage","isWebhook":false,"pointer":"/paths/~1flow~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get flow coverage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First and last observation per series. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"row_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is distinct observations, not stored rows."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"series_ids","in":"query","schemaId":"schema_396","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated identifiers. Accepts slug (preferred), slug without its label, series_label, entity or series_id. All but the first can match several series, and every match is returned."},"children":[]}]}]}],"required":true},{"name":"metrics","in":"query","schemaId":"schema_409","description":"Comma-separated metrics; omit for all. A series has one metric, so this selects series rather than filtering rows."},{"name":"frequency","in":"query","schemaId":"schema_398","description":"Comma-separated cadences; omit for all. Selects series, not rows. The older dod/wow/mom/qoq names are still accepted."}],"pointer":"/paths/~1flow~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/availability","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"series_ids","in":"query","required":true,"schemaId":"schema_396"},{"name":"metrics","in":"query","required":false,"schemaId":"schema_409"},{"name":"frequency","in":"query","required":false,"schemaId":"schema_398"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flow/availability","href":"timeseries/get_availability_flow_availability_get","openApiOperationId":"get_availability_flow_availability_get","summary":"Get flow coverage","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailabilityResponse"}},"schemaId":"components/schemas/AvailabilityResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1flow~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AvailabilityResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailabilityResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/timeseries/get_availability_flow_availability_get"}],"panels":[]}]},"httpPath":"/flow/availability"},{"label":"Export flow timeseries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/timeseries/export_timeseries_flow_timeseries_export_get","routeSlug":"/apis/flow/vanda-msvc-flow/timeseries/export_timeseries_flow_timeseries_export_get","metadata":{"seo":{"title":"Export flow timeseries","description":"Full history as CSV or JSON, unpaginated. Each row carries slug, metric and unit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"export_timeseries_flow_timeseries_export_get","name":"Export flow timeseries","isWebhook":false,"pointer":"/paths/~1flow~1timeseries~1export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export flow timeseries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Full history as CSV or JSON, unpaginated. Each row carries slug, metric and unit."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"series_ids","in":"query","schemaId":"schema_396","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated identifiers. Accepts slug (preferred), slug without its label, series_label, entity or series_id. All but the first can match several series, and every match is returned."},"children":[]}]}]}],"required":true},{"name":"metrics","in":"query","schemaId":"schema_409","description":"Comma-separated metrics; omit for all. A series has one metric, so this selects series rather than filtering rows."},{"name":"frequency","in":"query","schemaId":"schema_398","description":"Comma-separated cadences; omit for all. Selects series, not rows. The older dod/wow/mom/qoq names are still accepted."},{"name":"start_date","in":"query","schemaId":"schema_399","description":"Start date (ISO). Intraday series cover at most 31 days per request; omit it for the latest 31 days."},{"name":"end_date","in":"query","schemaId":"schema_400","description":"End date (ISO). Intraday series default to their newest bar."},{"name":"export_format","in":"query","schemaId":"schema_411","description":"Output format"},{"name":"compression","in":"query","schemaId":"schema_412","description":"Compression"}],"pointer":"/paths/~1flow~1timeseries~1export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/timeseries/export","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"series_ids","in":"query","required":true,"schemaId":"schema_396"},{"name":"metrics","in":"query","required":false,"schemaId":"schema_409"},{"name":"frequency","in":"query","required":false,"schemaId":"schema_398"},{"name":"start_date","in":"query","required":false,"schemaId":"schema_399"},{"name":"end_date","in":"query","required":false,"schemaId":"schema_400"},{"name":"export_format","in":"query","required":false,"schemaId":"components/schemas/ExportFormat"},{"name":"compression","in":"query","required":false,"schemaId":"components/schemas/CompressionFormat"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flow/timeseries/export","href":"timeseries/export_timeseries_flow_timeseries_export_get","openApiOperationId":"export_timeseries_flow_timeseries_export_get","summary":"Export flow timeseries","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1flow~1timeseries~1export/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/timeseries/export_timeseries_flow_timeseries_export_get"}],"panels":[]}]},"httpPath":"/flow/timeseries/export"},{"label":"List forecast runs, horizons and scenarios","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/timeseries/get_forecast_axes_flow_forecast_runs_get","routeSlug":"/apis/flow/vanda-msvc-flow/timeseries/get_forecast_axes_flow_forecast_runs_get","metadata":{"seo":{"title":"List forecast runs, horizons and scenarios","description":"What a forecast series can be asked for."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_forecast_axes_flow_forecast_runs_get","name":"List forecast runs, horizons and scenarios","isWebhook":false,"pointer":"/paths/~1flow~1forecast~1runs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List forecast runs, horizons and scenarios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What a forecast series can be asked for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A forecast dataset publishes a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cube"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every combination of a horizon and a z-score scenario for each run date. This returns the axes of that cube — the run dates, the horizons, and the scenario tokens — so a client knows what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/flow/forecast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will accept."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario tokens are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"strings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the domain mixes values like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-1.9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"All"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the unconditional path), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Series that publish no cube are refused; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/flow/timeseries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"series_ids","in":"query","schemaId":"schema_396","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated identifiers. Accepts slug (preferred), slug without its label, series_label, entity or series_id. All but the first can match several series, and every match is returned."},"children":[]}]}]}],"required":true},{"name":"records_per_page","in":"query","schemaId":"schema_402","description":"Records per page"},{"name":"page_number","in":"query","schemaId":"schema_403","description":"Page number, 1-indexed"}],"pointer":"/paths/~1flow~1forecast~1runs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/forecast/runs","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"series_ids","in":"query","required":true,"schemaId":"schema_396"},{"name":"records_per_page","in":"query","required":false,"schemaId":"schema_402"},{"name":"page_number","in":"query","required":false,"schemaId":"schema_403"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flow/forecast/runs","href":"timeseries/get_forecast_axes_flow_forecast_runs_get","openApiOperationId":"get_forecast_axes_flow_forecast_runs_get","summary":"List forecast runs, horizons and scenarios","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForecastAxesResponse"}},"schemaId":"components/schemas/ForecastAxesResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1flow~1forecast~1runs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ForecastAxesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForecastAxesResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/timeseries/get_forecast_axes_flow_forecast_runs_get"}],"panels":[]}]},"httpPath":"/flow/forecast/runs"},{"label":"Get one or more scenarios of the forecast cube","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/timeseries/get_forecast_flow_forecast_get","routeSlug":"/apis/flow/vanda-msvc-flow/timeseries/get_forecast_flow_forecast_get","metadata":{"seo":{"title":"Get one or more scenarios of the forecast cube","description":"One z-score scenario across the requested horizons, for the most recent run unless run_date says otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_forecast_flow_forecast_get","name":"Get one or more scenarios of the forecast cube","isWebhook":false,"pointer":"/paths/~1flow~1forecast/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get one or more scenarios of the forecast cube","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One z-score scenario across the requested horizons, for the most recent run unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"run_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" says otherwise."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rows are grouped "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one object per horizon"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with every metric nested inside it — a forecast is read as a point on a path, not as a dozen separate rows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"component"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the systematic strategy (cta, vt, rp, gamma) and is part of the grain — each publishes its own metrics, so one group never mixes them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scenario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names a branch of whichever axis the component uses — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zscore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"horizon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the dataset's own projection: market days ahead of the run date, which is 0."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forecast_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — resolving one needs a market calendar we do not hold, so pair "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"run_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"horizon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No transformation or normalisation: a projection is not a series to roll up or re-standardise."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"series_ids","in":"query","schemaId":"schema_396","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated identifiers. Accepts slug (preferred), slug without its label, series_label, entity or series_id. All but the first can match several series, and every match is returned."},"children":[]}]}]}],"required":true},{"name":"metrics","in":"query","schemaId":"schema_397","description":"Comma-separated metrics; omit for all. A series has one metric, so this selects series rather than filtering rows."},{"name":"run_date","in":"query","schemaId":"schema_414","description":"Which run to return (ISO date); omit for the most recent. Use /flow/forecast/runs to see what is published."},{"name":"horizons","in":"query","schemaId":"schema_415","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated horizons; omit for every one the series publishes. Market days ahead of the run date, which is 0, read from the dataset's own projection — the cube currently spans 0-15. A horizon the series does not publish is refused with the list of those it does; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/flow/forecast/runs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports them up front."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omitting this on a multi-series request is the largest response this endpoint produces: one group per (series, component, horizon), so 40 series is ~640 groups. Name the horizons you need, or page with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"records_per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"scenario","in":"query","schemaId":"schema_416","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which branch of the cube to return. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The axis is named per component"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zscore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gamma"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/flow/forecast/runs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports which one a series uses, with its values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On the z-score axis it is a string: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"All"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the default and the unconditional path), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sit in the same domain as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-1.9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is a number. Either way "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" find the same cell."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Horizon 0 is the run date, which has already happened, so on the z-score axis it publishes only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"All"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; asking for another scenario returns the later horizons and no group for 0."},"children":[]}]}]}]},{"name":"scenarios","in":"query","schemaId":"schema_417","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Several branches at once, comma-separated, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for every one published — a whole run in one call. Each group then carries its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scenario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Not with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scenario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A CTA run is 64 scenarios x 16 horizons, 1,024 groups, inside one default page; narrow with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"components","in":"query","schemaId":"schema_418","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated systematic strategies, e.g. cta,vt; omit for all that the series publishes. Each component publishes its own metrics, so a group never mixes them — use /flow/forecast/runs to see which exist."},"children":[]}]}]}]},{"name":"records_per_page","in":"query","schemaId":"schema_402","description":"Records per page"},{"name":"page_number","in":"query","schemaId":"schema_403","description":"Page number, 1-indexed"}],"pointer":"/paths/~1flow~1forecast/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/forecast","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"series_ids","in":"query","required":true,"schemaId":"schema_396"},{"name":"metrics","in":"query","required":false,"schemaId":"schema_397"},{"name":"run_date","in":"query","required":false,"schemaId":"schema_414"},{"name":"horizons","in":"query","required":false,"schemaId":"schema_415"},{"name":"scenario","in":"query","required":false,"schemaId":"schema_416"},{"name":"scenarios","in":"query","required":false,"schemaId":"schema_417"},{"name":"components","in":"query","required":false,"schemaId":"schema_418"},{"name":"records_per_page","in":"query","required":false,"schemaId":"schema_402"},{"name":"page_number","in":"query","required":false,"schemaId":"schema_403"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flow/forecast","href":"timeseries/get_forecast_flow_forecast_get","openApiOperationId":"get_forecast_flow_forecast_get","summary":"Get one or more scenarios of the forecast cube","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForecastResponse"}},"schemaId":"components/schemas/ForecastResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1flow~1forecast/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ForecastResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForecastResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/timeseries/get_forecast_flow_forecast_get"}],"panels":[]}]},"httpPath":"/flow/forecast"}],"content":{"contentType":"group","meta":{"name":"Timeseries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Timeseries","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flow/timeseries","summary":"Get flow timeseries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/timeseries/get_timeseries_flow_timeseries_get","deprecated":false},{"title":"/flow/latest","summary":"Get latest flow observation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/timeseries/get_latest_flow_latest_get","deprecated":false},{"title":"/flow/availability","summary":"Get flow coverage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/timeseries/get_availability_flow_availability_get","deprecated":false},{"title":"/flow/timeseries/export","summary":"Export flow timeseries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/timeseries/export_timeseries_flow_timeseries_export_get","deprecated":false},{"title":"/flow/forecast/runs","summary":"List forecast runs, horizons and scenarios","prefix":{"name":"get","color":"get"},"badges":[],"link":"/timeseries/get_forecast_axes_flow_forecast_runs_get","deprecated":false},{"title":"/flow/forecast","summary":"Get one or more scenarios of the forecast cube","prefix":{"name":"get","color":"get"},"badges":[],"link":"/timeseries/get_forecast_flow_forecast_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Catalog","link":"/apis/flow/vanda-msvc-flow/catalog","routeSlug":"/apis/flow/vanda-msvc-flow/catalog","items":[{"label":"Browse the flow catalog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/catalog/list_catalog_flow_catalog_get","routeSlug":"/apis/flow/vanda-msvc-flow/catalog/list_catalog_flow_catalog_get","metadata":{"seo":{"title":"Browse the flow catalog","description":"Every published series, with its identifiers, classification, measure and coverage. Filter by any dimension from /flow/catalog/facets, or search with q."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_catalog_flow_catalog_get","name":"Browse the flow catalog","isWebhook":false,"pointer":"/paths/~1flow~1catalog/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Browse the flow catalog","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every published series, with its identifiers, classification, measure and coverage. Filter by any dimension from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/flow/catalog/facets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or search with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"q"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity.slug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" changes when the pipeline reloads."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_419","description":"Free-text search over names, descriptions and identifiers"},{"name":"records_per_page","in":"query","schemaId":"schema_420","description":"Rows per page"},{"name":"page_number","in":"query","schemaId":"schema_421","description":"1-indexed"}],"pointer":"/paths/~1flow~1catalog/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/catalog","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"q","in":"query","required":false,"schemaId":"schema_419"},{"name":"records_per_page","in":"query","required":false,"schemaId":"schema_420"},{"name":"page_number","in":"query","required":false,"schemaId":"schema_421"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flow/catalog","href":"catalog/list_catalog_flow_catalog_get","openApiOperationId":"list_catalog_flow_catalog_get","summary":"Browse the flow catalog","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogResponse"}},"schemaId":"components/schemas/CatalogResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1flow~1catalog/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_catalog_flow_catalog_get"}],"panels":[]}]},"httpPath":"/flow/catalog"},{"label":"Distinct values per catalog dimension","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/catalog/get_facets_flow_catalog_facets_get","routeSlug":"/apis/flow/vanda-msvc-flow/catalog/get_facets_flow_catalog_facets_get","metadata":{"seo":{"title":"Distinct values per catalog dimension","description":"Distinct values per filterable dimension. Read these rather than hard-coding a list; metric grows as the pipeline publishes more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_facets_flow_catalog_facets_get","name":"Distinct values per catalog dimension","isWebhook":false,"pointer":"/paths/~1flow~1catalog~1facets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Distinct values per catalog dimension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Distinct values per filterable dimension. Read these rather than hard-coding a list; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grows as the pipeline publishes more."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dimensions","in":"query","schemaId":"schema_422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated dimensions to return, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metric,frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit for all."},"children":[]}]}]}]}],"pointer":"/paths/~1flow~1catalog~1facets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/catalog/facets","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"dimensions","in":"query","required":false,"schemaId":"schema_422"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flow/catalog/facets","href":"catalog/get_facets_flow_catalog_facets_get","openApiOperationId":"get_facets_flow_catalog_facets_get","summary":"Distinct values per catalog dimension","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacetsResponse"}},"schemaId":"components/schemas/FacetsResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1flow~1catalog~1facets/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FacetsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacetsResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/get_facets_flow_catalog_facets_get"}],"panels":[]}]},"httpPath":"/flow/catalog/facets"},{"label":"One catalog entry, with coverage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/catalog/get_catalog_entry_flow_catalog__identifier__get","routeSlug":"/apis/flow/vanda-msvc-flow/catalog/get_catalog_entry_flow_catalog__identifier__get","metadata":{"seo":{"title":"One catalog entry, with coverage","description":"Accepts the same identifiers as series_ids. Where one matches several series the first is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_catalog_entry_flow_catalog__identifier__get","name":"One catalog entry, with coverage","isWebhook":false,"pointer":"/paths/~1flow~1catalog~1{identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"One catalog entry, with coverage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts the same identifiers as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Where one matches several series the first is returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_423","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Slug, series_label, entity or series_id"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1flow~1catalog~1{identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/catalog/{identifier}","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"schemaId":"schema_423"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flow/catalog/{identifier}","href":"catalog/get_catalog_entry_flow_catalog__identifier__get","openApiOperationId":"get_catalog_entry_flow_catalog__identifier__get","summary":"One catalog entry, with coverage","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogEntryDetail"}},"schemaId":"components/schemas/CatalogEntryDetail"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1flow~1catalog~1{identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogEntryDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogEntryDetail"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/get_catalog_entry_flow_catalog__identifier__get"}],"panels":[]}]},"httpPath":"/flow/catalog/{identifier}"}],"content":{"contentType":"group","meta":{"name":"Catalog"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Catalog","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flow/catalog","summary":"Browse the flow catalog","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_catalog_flow_catalog_get","deprecated":false},{"title":"/flow/catalog/facets","summary":"Distinct values per catalog dimension","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/get_facets_flow_catalog_facets_get","deprecated":false},{"title":"/flow/catalog/{identifier}","summary":"One catalog entry, with coverage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/get_catalog_entry_flow_catalog__identifier__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/apis/flow/vanda-msvc-flow/users","routeSlug":"/apis/flow/vanda-msvc-flow/users","items":[{"label":"Current user's tier and request limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/users/get_me_flow_users_me_get","routeSlug":"/apis/flow/vanda-msvc-flow/users/get_me_flow_users_me_get","metadata":{"seo":{"title":"Current user's tier and request limits","description":"The caller's tier and the request limits that follow from it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_me_flow_users_me_get","name":"Current user's tier and request limits","isWebhook":false,"pointer":"/paths/~1flow~1users~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Current user's tier and request limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The caller's tier and the request limits that follow from it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/users/me","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flow/users/me","href":"users/get_me_flow_users_me_get","openApiOperationId":"get_me_flow_users_me_get","summary":"Current user's tier and request limits","securityGroups":[{"HTTPBearer":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413"}],"pointer":"/paths/~1flow~1users~1me/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/get_me_flow_users_me_get"}],"panels":[]}]},"httpPath":"/flow/users/me"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flow/users/me","summary":"Current user's tier and request limits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get_me_flow_users_me_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Utility","link":"/apis/flow/vanda-msvc-flow/utility","routeSlug":"/apis/flow/vanda-msvc-flow/utility","items":[{"label":"Health check endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/utility/health_check_flow_health_get","routeSlug":"/apis/flow/vanda-msvc-flow/utility/health_check_flow_health_get","metadata":{"seo":{"title":"Health check endpoint","description":"Health check endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"health_check_flow_health_get","name":"Health check endpoint","isWebhook":false,"pointer":"/paths/~1flow~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health check endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"empty-message","label":"No request data","labelTranslationKey":"noRequestData"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flow/health","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/flow/health","href":"utility/health_check_flow_health_get","openApiOperationId":"health_check_flow_health_get","summary":"Health check endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413"}],"pointer":"/paths/~1flow~1health/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/utility/health_check_flow_health_get"}],"panels":[]}]},"httpPath":"/flow/health"}],"content":{"contentType":"group","meta":{"name":"Utility"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Utility","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flow/health","summary":"Health check endpoint","prefix":{"name":"get","color":"get"},"badges":[],"link":"/utility/health_check_flow_health_get","deprecated":false}]}]}]}]}},{"label":"Root","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flow/vanda-msvc-flow/other/root__get","routeSlug":"/apis/flow/vanda-msvc-flow/other/root__get","metadata":{"seo":{"title":"Root","description":"Root endpoint providing service metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"root__get","name":"Root","isWebhook":false,"pointer":"/paths/~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Root","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Root endpoint providing service metadata."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/","servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/","href":"other/root__get","openApiOperationId":"root__get","summary":"Root"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","description":"Mock server","isMockServer":true},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413"}],"pointer":"/paths/~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/root__get"}],"panels":[]}]},"httpPath":"/"}],"store":{"schemaStore":{"components/schemas/AvailabilityResponse":{"id":"components/schemas/AvailabilityResponse","kind":"json-schema","title":"AvailabilityResponse","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SeriesAvailability"},"type":"array","title":"Data"},"series_ids":{"items":{"type":"integer"},"type":"array","title":"Series Ids"},"unresolved":{"items":{"type":"string"},"type":"array","title":"Unresolved"},"count":{"type":"integer","title":"Count","default":0}},"type":"object","title":"AvailabilityResponse","description":"Coverage per series."}},"components/schemas/CatalogEntryDetail":{"id":"components/schemas/CatalogEntryDetail","kind":"json-schema","title":"CatalogEntryDetail","data":{"properties":{"identity":{"$ref":"#/components/schemas/SeriesIdentity"},"classification":{"$ref":"#/components/schemas/SeriesClassification"},"asset":{"$ref":"#/components/schemas/SeriesAssetDimensions"},"geographic":{"$ref":"#/components/schemas/SeriesGeographicDimensions"},"investor":{"$ref":"#/components/schemas/SeriesInvestorDimensions"},"measure":{"$ref":"#/components/schemas/SeriesMeasure"},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sector"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mirrors "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"measure.unit"},"children":[]}]}]}]},"metric":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Metric","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mirrors "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"measure.metric"},"children":[]}]}]}]},"is_active":{"type":"boolean","title":"Is Active","description":"Has an observation within the last 90 days","default":true},"staleness_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Staleness Days","description":"Days since the last observation"},"availability":{"anyOf":[{"$ref":"#/components/schemas/SeriesAvailability"},{"type":"null"}],"description":"Coverage; null if the series has no data yet"}},"type":"object","required":["identity","classification","asset","geographic","investor","measure"],"title":"CatalogEntryDetail","description":"A catalog entry with its coverage in the fact table attached."}},"components/schemas/CatalogLabelEntry":{"id":"components/schemas/CatalogLabelEntry","kind":"json-schema","title":"CatalogLabelEntry","data":{"properties":{"identity":{"$ref":"#/components/schemas/LabelIdentity"},"classification":{"$ref":"#/components/schemas/SeriesClassification"},"asset":{"$ref":"#/components/schemas/SeriesAssetDimensions"},"geographic":{"$ref":"#/components/schemas/SeriesGeographicDimensions"},"investor":{"$ref":"#/components/schemas/SeriesInvestorDimensions"},"measure":{"$ref":"#/components/schemas/LabelMeasure"},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sector"},"series":{"items":{"$ref":"#/components/schemas/LabelSeriesVariant"},"type":"array","title":"Series","description":"Every series under the label"},"series_count":{"type":"integer","title":"Series Count","description":"Series grouped under the label","default":0},"is_active":{"type":"boolean","title":"Is Active","description":"Any series observed within the last 90 days","default":true},"staleness_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Staleness Days","description":"Days since the most recent observation"}},"type":"object","required":["identity","classification","asset","geographic","investor","measure"],"title":"CatalogLabelEntry","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and every series published under it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The listing is keyed by label rather than by series. Use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /flow/catalog/{identifier}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a single series' detail."},"children":[]}]}]}]}},"components/schemas/CatalogResponse":{"id":"components/schemas/CatalogResponse","kind":"json-schema","title":"CatalogResponse","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CatalogLabelEntry"},"type":"array","title":"Data","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalog entries, keyed by series_label"},"children":[]}]}]}]},"count":{"type":"integer","title":"Count","description":"Entries on this page","default":0},"pagination":{"anyOf":[{"$ref":"#/components/schemas/PaginationMeta"},{"type":"null"}]}},"type":"object","title":"CatalogResponse","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paged catalog listing, one entry per series_label."},"children":[]}]}]}]}},"components/schemas/CompressionFormat":{"id":"components/schemas/CompressionFormat","kind":"json-schema","title":"CompressionFormat","data":{"type":"string","enum":["none","gzip","zip"],"title":"CompressionFormat","description":"Compression format options for exports"}},"components/schemas/ExportFormat":{"id":"components/schemas/ExportFormat","kind":"json-schema","title":"ExportFormat","data":{"type":"string","enum":["json","csv"],"title":"ExportFormat","description":"Export format options for API responses"}},"components/schemas/FacetsResponse":{"id":"components/schemas/FacetsResponse","kind":"json-schema","title":"FacetsResponse","data":{"properties":{"facets":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","title":"Facets","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dimension -> sorted distinct values"},"children":[]}]}]}]},"total_series":{"type":"integer","title":"Total Series","description":"Series the facets summarise","default":0}},"type":"object","title":"FacetsResponse","description":"Distinct values per filterable dimension."}},"components/schemas/FlowLatestPoint":{"id":"components/schemas/FlowLatestPoint","kind":"json-schema","title":"FlowLatestPoint","data":{"properties":{"ts":{"type":"string","format":"date-time","title":"Ts","description":"Observation timestamp (UTC)"},"series_id":{"type":"integer","title":"Series Id","description":"Pipeline series ID; changes on reload"},"series_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Series Label","description":"Source label, not unique on its own"},"metric":{"type":"string","title":"Metric","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Measure, e.g. net, buy_value"},"children":[]}]}]}]},"frequency":{"type":"string","title":"Frequency","description":"Publication cadence"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Observed value"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of the value, e.g. USDmn, shares"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The preferred handle"},"measure_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Class","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (per period, summable), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a position at a point in time) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Chart a flow as bars and a level as a line. A migrated dataset classifies on the row instead, in the pipeline's own vocabulary — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volatility"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"dimensions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Dimensions","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The dimension values this observation sits at, for datasets that publish them — e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"component\": \"cta\", \"projection\": 10, \"zscore\": \"-1.9\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Absent for datasets that do not. Filter with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimensions="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Display name"},"dataset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Id"},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Type"},"staleness_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Staleness Days","description":"Days since this observation"}},"type":"object","required":["ts","series_id","metric","frequency"],"title":"FlowLatestPoint","description":"Most recent observation per series, with catalog context."}},"components/schemas/FlowPoint":{"id":"components/schemas/FlowPoint","kind":"json-schema","title":"FlowPoint","data":{"properties":{"ts":{"type":"string","format":"date-time","title":"Ts","description":"Observation timestamp (UTC)"},"series_id":{"type":"integer","title":"Series Id","description":"Pipeline series ID; changes on reload"},"series_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Series Label","description":"Source label, not unique on its own"},"metric":{"type":"string","title":"Metric","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Measure, e.g. net, buy_value"},"children":[]}]}]}]},"frequency":{"type":"string","title":"Frequency","description":"Publication cadence"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Observed value"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of the value, e.g. USDmn, shares"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The preferred handle for this series"},"measure_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Class","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (per period, summable), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a position at a point in time) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Chart a flow as bars and a level as a line. A migrated dataset classifies on the row instead, in the pipeline's own vocabulary — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volatility"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"dimensions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Dimensions","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The dimension values this observation sits at, for datasets that publish them — e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"component\": \"cta\", \"projection\": 10, \"zscore\": \"-1.9\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Absent for datasets that do not. Filter with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimensions="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["ts","series_id","metric","frequency"],"title":"FlowPoint","description":"One observation, deduplicated to its most recent load."}},"components/schemas/ForecastAxes":{"id":"components/schemas/ForecastAxes","kind":"json-schema","title":"ForecastAxes","data":{"properties":{"series_label":{"type":"string","title":"Series Label","description":"The label these axes belong to"},"dataset_id":{"type":"string","title":"Dataset Id","description":"Dataset publishing the sweep"},"components":{"items":{"type":"string"},"type":"array","title":"Components","description":"Systematic strategies published, e.g. cta, vt, rp, gamma. Each publishes its own metrics, so they are not interchangeable."},"run_dates":{"items":{"type":"string","format":"date-time"},"type":"array","title":"Run Dates","description":"Run dates published for this label"},"horizons":{"items":{"type":"integer"},"type":"array","title":"Horizons","description":"Projections published, 0 being the run date itself"},"scenario_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scenario Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which axis this series varies over besides the horizon: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zscore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for cta/rp/vt, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for gamma."},"children":[]}]}]}]},"scenario_type":{"type":"string","title":"Scenario Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The axis's JSON type, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"string"},"scenarios":{"items":{"type":"string"},"type":"array","title":"Scenarios","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokens published on that axis, as strings. The z-score domain mixes values like '-1.9' with 'All', '<0' and '>0'; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is numeric."},"children":[]}]}]}]},"metrics":{"items":{"type":"string"},"type":"array","title":"Metrics","description":"Metrics published"}},"type":"object","required":["series_label","dataset_id"],"title":"ForecastAxes","description":"What one forecast series can be asked for."}},"components/schemas/ForecastAxesResponse":{"id":"components/schemas/ForecastAxesResponse","kind":"json-schema","title":"ForecastAxesResponse","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ForecastAxes"},"type":"array","title":"Data"},"unresolved":{"items":{"type":"string"},"type":"array","title":"Unresolved","description":"Identifiers that matched no series"},"count":{"type":"integer","title":"Count","description":"Series in this page","default":0},"pagination":{"anyOf":[{"$ref":"#/components/schemas/PaginationMeta"},{"type":"null"}]}},"type":"object","title":"ForecastAxesResponse","description":"The axes available for the requested series."}},"components/schemas/ForecastGroup":{"id":"components/schemas/ForecastGroup","kind":"json-schema","title":"ForecastGroup","data":{"properties":{"series_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Series Label"},"component":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Component","description":"The systematic strategy this point belongs to. Part of the grain: components publish different metrics, so one group never mixes them."},"horizon":{"type":"integer","title":"Horizon","description":"Market days ahead of the run date, which is 0. Read from the dataset's own projection, not counted from the rows. Horizon 0 is the run date itself and exists only for the unconditional scenario, so a numeric scenario starts at 1."},"scenario":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scenario","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The branch of the scenario axis this point is on, e.g. '-1.9' or 'All'. Part of the grain when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scenarios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" asks for several."},"children":[]}]}]}]},"metrics":{"additionalProperties":{"$ref":"#/components/schemas/ForecastMetric"},"type":"object","title":"Metrics","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metric name -> its value and unit"},"children":[]}]}]}]}},"type":"object","required":["horizon"],"title":"ForecastGroup","description":"Every metric of one series, for one component, at one horizon.\n\nGrouped rather than one row per metric: a forecast is read as a point on a\npath, and the flat shape made a client re-assemble a dozen rows to draw one."}},"components/schemas/ForecastMetric":{"id":"components/schemas/ForecastMetric","kind":"json-schema","title":"ForecastMetric","data":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Observed value"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The preferred handle for this metric's series. A slug names a (label, metric) pair, so it sits here rather than on the group, which spans every metric."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passed through from the warehouse unchanged — this service neither maps nor validates units, so a correction at source appears here with no release. The forecast dataset reports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pct_aum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"measure_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Class","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Read from dim.flow_measure_class, which lists none of the forecast metrics as of 2026-09-04, so they report "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until rows are added — a data change, not a release."},"children":[]}]}]}]}},"type":"object","title":"ForecastMetric","description":"One measure at one horizon."}},"components/schemas/ForecastResponse":{"id":"components/schemas/ForecastResponse","kind":"json-schema","title":"ForecastResponse","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ForecastGroup"},"type":"array","title":"Data"},"run_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Run Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The run these projections were made on. There is no forecast_date: resolving one needs a market calendar we do not hold, so a client pairs this with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"horizon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" itself."},"children":[]}]}]}]},"scenario":{"anyOf":[{"$ref":"#/components/schemas/ForecastScenario"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The branch served; null when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scenarios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" asked for several."},"children":[]}]}]}]},"scenarios":{"items":{"type":"string"},"type":"array","title":"Scenarios","description":"Every branch in this response, in the axis's order."},"series_labels":{"items":{"type":"string"},"type":"array","title":"Series Labels"},"metrics":{"items":{"type":"string"},"type":"array","title":"Metrics","description":"Metrics present in this page"},"unresolved":{"items":{"type":"string"},"type":"array","title":"Unresolved","description":"Identifiers that matched no series"},"count":{"type":"integer","title":"Count","description":"Groups in this page","default":0},"pagination":{"anyOf":[{"$ref":"#/components/schemas/PaginationMeta"},{"type":"null"}]}},"type":"object","title":"ForecastResponse","description":"One scenario of the forecast cube, across the requested horizons."}},"components/schemas/ForecastScenario":{"id":"components/schemas/ForecastScenario","kind":"json-schema","title":"ForecastScenario","data":{"properties":{"type":{"type":"string","title":"Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which axis was filtered: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zscore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for cta/rp/vt, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for gamma. Named per component, so read it rather than assuming."},"children":[]}]}]}],"default":"zscore"},"value":{"type":"string","title":"Value","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token served, e.g. '-1.9', 'All' for the unconditional path on the z-score axis, or '25' on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Always a string here because the z-score domain mixes 'All', '<0' and '>0' with numbers; the filter itself uses the axis's own JSON type."},"children":[]}]}]}]}},"type":"object","required":["value"],"title":"ForecastScenario","description":"Which branch of the cube the response describes."}},"components/schemas/HTTPValidationError":{"id":"components/schemas/HTTPValidationError","kind":"json-schema","title":"HTTPValidationError","data":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}},"components/schemas/LabelIdentity":{"id":"components/schemas/LabelIdentity","kind":"json-schema","title":"LabelIdentity","data":{"properties":{"series_label":{"type":"string","title":"Series Label","description":"The label this entry groups"},"series_ids":{"items":{"type":"integer"},"type":"array","title":"Series Ids","description":"Every series under the label"},"slugs":{"items":{"type":"string"},"type":"array","title":"Slugs","description":"Preferred handle for each series"},"dataset_ids":{"items":{"type":"string"},"type":"array","title":"Dataset Ids","description":"Usually one; 12 labels span several datasets"},"entities":{"items":{"type":"string"},"type":"array","title":"Entities"},"entity_types":{"items":{"type":"string"},"type":"array","title":"Entity Types"},"frequencies":{"items":{"type":"string"},"type":"array","title":"Frequencies"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version","description":"Model version, e.g. \"V1\""},"model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Id","description":"Producing model"},"legacy_series_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legacy Series Id","description":"VandaXAsset series ID, where one maps"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Display name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"What the label measures"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date","description":"Earliest observation"},"lag":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lag","description":"Publication lag in days"},"update_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Update Time","description":"Expected publication time"}},"type":"object","required":["series_label"],"title":"LabelIdentity","description":"Identity of a label, which covers one or more series."}},"components/schemas/LabelMeasure":{"id":"components/schemas/LabelMeasure","kind":"json-schema","title":"LabelMeasure","data":{"properties":{"metrics":{"items":{"type":"string"},"type":"array","title":"Metrics","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. net, buy_value"},"children":[]}]}]}]},"units":{"items":{"type":"string"},"type":"array","title":"Units","description":"e.g. USDmn, shares"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Not yet populated"},"scale":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Scale"},"measure_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Class","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where the label's series are not all the same. Read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series[].measure_class"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the exact value per series. Filtering by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?measure_class="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches a label if any of its series does, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches nothing."},"children":[]}]}]}]},"aggregation_rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Aggregation Rule"},"sign_convention":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sign Convention"},"derivation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Derivation"},"zero_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zero Policy"}},"type":"object","title":"LabelMeasure","description":"Measure semantics for a label. Plural where its series differ."}},"components/schemas/LabelSeriesVariant":{"id":"components/schemas/LabelSeriesVariant","kind":"json-schema","title":"LabelSeriesVariant","data":{"properties":{"series_id":{"type":"integer","title":"Series Id","description":"Pipeline series ID; changes on reload"},"slug":{"type":"string","title":"Slug","description":"The preferred handle for this series"},"metric":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Metric","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. net, buy_value"},"children":[]}]}]}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"e.g. USDmn, shares, count"},"frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Frequency","description":"Publication cadence"},"measure_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Class","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (per period, summable), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a position at a point in time) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Chart a flow as bars and a level as a line"},"children":[]}]}]}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Type"},"dataset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Id"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date","description":"First observation"},"is_active":{"type":"boolean","title":"Is Active","description":"Observed within the last 90 days","default":true},"staleness_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Staleness Days","description":"Days since this series' last observation"}},"type":"object","required":["series_id","slug"],"title":"LabelSeriesVariant","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One series under a label, with the facts the plural lists cannot pair."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"measure.units"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" beside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"measure.metrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not say which metric is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"counted in what — most labels span more than one unit — so a client"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rendering a row per series reads them from here."},"children":[]}]}]}]}},"components/schemas/LatestResponse":{"id":"components/schemas/LatestResponse","kind":"json-schema","title":"LatestResponse","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FlowLatestPoint"},"type":"array","title":"Data"},"series_ids":{"items":{"type":"integer"},"type":"array","title":"Series Ids"},"metrics":{"items":{"type":"string"},"type":"array","title":"Metrics"},"frequencies":{"items":{"type":"string"},"type":"array","title":"Frequencies"},"unresolved":{"items":{"type":"string"},"type":"array","title":"Unresolved"},"count":{"type":"integer","title":"Count","default":0}},"type":"object","title":"LatestResponse","description":"Most recent observation per series."}},"components/schemas/NormalisationEnum":{"id":"components/schemas/NormalisationEnum","kind":"json-schema","title":"NormalisationEnum","data":{"type":"string","enum":["zscore","percentile_rank"],"title":"NormalisationEnum","description":"Normalisations, applied after any transformation."}},"components/schemas/NormalisationPeriodEnum":{"id":"components/schemas/NormalisationPeriodEnum","kind":"json-schema","title":"NormalisationPeriodEnum","data":{"type":"string","enum":["3m","6m","1y","2y","5y","Expanding","All"],"title":"NormalisationPeriodEnum","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lookback for a normalisation. A calendar range, so it means the same at any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cadence: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" over a monthly series uses twelve observations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"All"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is unbounded in both directions and so not causal — early values are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"normalised using data from their future."},"children":[]}]}]}]}},"components/schemas/PaginationMeta":{"id":"components/schemas/PaginationMeta","kind":"json-schema","title":"PaginationMeta","data":{"properties":{"page_number":{"type":"integer","title":"Page Number","description":"Current page, 1-indexed"},"records_per_page":{"type":"integer","title":"Records Per Page","description":"Records requested per page"},"total_record_count":{"type":"integer","title":"Total Record Count","description":"Total records matching the query"},"total_pages":{"type":"integer","title":"Total Pages","description":"Total pages available"},"has_next":{"type":"boolean","title":"Has Next","description":"Whether a further page exists"},"has_previous":{"type":"boolean","title":"Has Previous","description":"Whether a previous page exists"}},"type":"object","required":["page_number","records_per_page","total_record_count","total_pages","has_next","has_previous"],"title":"PaginationMeta","description":"Pagination metadata attached to list responses."}},"components/schemas/SeriesAssetDimensions":{"id":"components/schemas/SeriesAssetDimensions","kind":"json-schema","title":"SeriesAssetDimensions","data":{"properties":{"asset_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Type","description":"EQ, FX, FI, COM"},"asset_subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Subtype"},"asset_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Code"},"benchmark":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benchmark"},"benchmark_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benchmark Code"}},"type":"object","title":"SeriesAssetDimensions"}},"components/schemas/SeriesAvailability":{"id":"components/schemas/SeriesAvailability","kind":"json-schema","title":"SeriesAvailability","data":{"properties":{"series_id":{"type":"integer","title":"Series Id"},"series_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Series Label"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"metric":{"type":"string","title":"Metric"},"frequency":{"type":"string","title":"Frequency"},"first_ts":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Ts"},"last_ts":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Ts"},"row_count":{"type":"integer","title":"Row Count","description":"Deduplicated observation count","default":0}},"type":"object","required":["series_id","metric","frequency"],"title":"SeriesAvailability","description":"Coverage for one series. Counts deduplicated observations, not raw rows."}},"components/schemas/SeriesClassification":{"id":"components/schemas/SeriesClassification","kind":"json-schema","title":"SeriesClassification","data":{"properties":{"product":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product","description":"Commercial surface"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain","description":"Analytical domain"},"universe":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Universe","description":"Market, e.g. CN, KR, EU"},"dataset":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset","description":"Logical dataset name"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model name"}},"type":"object","title":"SeriesClassification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classification block — the Unified Data Model hierarchy."},"children":[]}]}]}]}},"components/schemas/SeriesGeographicDimensions":{"id":"components/schemas/SeriesGeographicDimensions","kind":"json-schema","title":"SeriesGeographicDimensions","data":{"properties":{"geography":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Geography"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code"},"dm_em":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dm Em","description":"DM or EM"}},"type":"object","title":"SeriesGeographicDimensions"}},"components/schemas/SeriesIdentity":{"id":"components/schemas/SeriesIdentity","kind":"json-schema","title":"SeriesIdentity","data":{"properties":{"series_id":{"type":"integer","title":"Series Id","description":"Pipeline series ID; changes on reload"},"slug":{"type":"string","title":"Slug","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dataset_id:entity:metric[:series_label] — the preferred handle"},"children":[]}]}]}]},"series_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Series Label","description":"Source label"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version","description":"Model version, e.g. \"V1\""},"dataset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Id","description":"e.g. FLOW.CN.EQ.V1"},"model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Producing model, e.g. CN_EQ"},"children":[]}]}]}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity","description":"Entity, not unique on its own"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. investor_type|sector"},"children":[]}]}]}]},"legacy_series_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legacy Series Id","description":"VandaXAsset series ID, where one maps"},"aliases":{"items":{"type":"string"},"type":"array","title":"Aliases","description":"Other identifiers that resolve to this series"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Display name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"What the series measures"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date","description":"First observation"},"frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Frequency","description":"Publication cadence"},"lag":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lag","description":"Publication lag in days"},"update_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Update Time","description":"Expected publication time"}},"type":"object","required":["series_id","slug"],"title":"SeriesIdentity","description":"Identity block of a catalog entry."}},"components/schemas/SeriesInvestorDimensions":{"id":"components/schemas/SeriesInvestorDimensions","kind":"json-schema","title":"SeriesInvestorDimensions","data":{"properties":{"investor_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Investor Category"},"investor_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Investor Type"},"investor_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Investor Origin"},"investor_subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Investor Subtype"}},"type":"object","title":"SeriesInvestorDimensions"}},"components/schemas/SeriesMeasure":{"id":"components/schemas/SeriesMeasure","kind":"json-schema","title":"SeriesMeasure","data":{"properties":{"metric":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Metric","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. net, buy_value"},"children":[]}]}]}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"e.g. USDmn, shares, contracts"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Not yet populated"},"scale":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Scale"},"measure_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Class","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a quantity per period, summable over time), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a position at a point in time) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when unclassified"},"children":[]}]}]}]},"aggregation_rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Aggregation Rule"},"sign_convention":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sign Convention"},"derivation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Derivation"},"zero_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zero Policy","description":"Whether a zero means no flow or not reported"}},"type":"object","title":"SeriesMeasure","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Measure semantics. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"measure_class"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/SortDirectionEnum":{"id":"components/schemas/SortDirectionEnum","kind":"json-schema","title":"SortDirectionEnum","data":{"type":"string","enum":["asc","desc"],"title":"SortDirectionEnum","description":"Sort direction for timeseries results."}},"components/schemas/TimeseriesResponse":{"id":"components/schemas/TimeseriesResponse","kind":"json-schema","title":"TimeseriesResponse","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FlowPoint"},"type":"array","title":"Data"},"series":{"items":{"type":"string"},"type":"array","title":"Series","description":"Slugs that contributed rows"},"series_ids":{"items":{"type":"integer"},"type":"array","title":"Series Ids"},"metrics":{"items":{"type":"string"},"type":"array","title":"Metrics","description":"Metrics present in this page"},"frequencies":{"items":{"type":"string"},"type":"array","title":"Frequencies","description":"Cadences present in this page"},"unresolved":{"items":{"type":"string"},"type":"array","title":"Unresolved","description":"Identifiers that matched no series"},"count":{"type":"integer","title":"Count","description":"Rows in this page","default":0},"pagination":{"anyOf":[{"$ref":"#/components/schemas/PaginationMeta"},{"type":"null"}]},"transformation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Transformation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transformed rows, at transformation.results.data. On failure it carries a Failure status and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is still populated."},"children":[]}]}]}]}},"type":"object","title":"TimeseriesResponse","description":"A page of observations."}},"components/schemas/TransformationEnum":{"id":"components/schemas/TransformationEnum","kind":"json-schema","title":"TransformationEnum","data":{"type":"string","enum":["rolling_sum","moving_avg"],"title":"TransformationEnum","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Windowed transformations. Allowed on every metric, whatever its measure_class."},"children":[]}]}]}]}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"components/schemas/WindowEnum":{"id":"components/schemas/WindowEnum","kind":"json-schema","title":"WindowEnum","data":{"type":"string","enum":["5","20","30","60","90","120","252"],"title":"WindowEnum","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Window length in OBSERVATIONS — the upstream applies it with rowsBetween."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The names are daily-centric, shared with services that only publish daily"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data. On a monthly series "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (20) means twenty months. Pick the value,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not the label."},"children":[]}]}]}]}},"schema_396":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated identifiers. Accepts slug (preferred), slug without its label, series_label, entity or series_id. All but the first can match several series, and every match is returned."},"children":[]}]}]}],"title":"Series Ids"},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated metrics; omit for all. A series has one metric, so this selects series rather than filtering rows.","examples":["buy","buy_raw","buy_value","buy_volume"],"title":"Metrics"},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated cadences; omit for all. Selects series, not rows. The older dod/wow/mom/qoq names are still accepted.","title":"Frequency"},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date (ISO). Intraday series cover at most 31 days per request; omit it for the latest 31 days.","title":"Start Date"},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date (ISO). Intraday series default to their newest bar.","title":"End Date"},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SortDirectionEnum","description":"Sort order by timestamp","default":"desc"},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"type":"integer","maximum":10000,"minimum":1,"description":"Records per page","default":2000,"title":"Records Per Page"},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"type":"integer","minimum":1,"description":"Page number, 1-indexed","default":1,"title":"Page Number"},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/TransformationEnum"},{"type":"null"}],"description":"Trailing-window transformation; one series per request.","title":"Transformation"},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/WindowEnum"},{"type":"null"}],"description":"Window in observations; required with transformation","title":"Window"},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/NormalisationEnum"},{"type":"null"}],"description":"Distribution normalisation","title":"Normalisation"},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/NormalisationPeriodEnum"},{"type":"null"}],"description":"Lookback for normalisation; required with normalisation","title":"Normalisation Period"},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeseries are history only; a forecast series' history is its neutral cell, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"projection\": 0, \"zscore\": \"All\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ret\": 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for gamma) is accepted and changes nothing. Any other cell answers 400: read the cube from /flow/forecast. JSON, because the types matter."},"children":[]}]}]}],"examples":["{\"projection\": 10, \"ret\": -2}"],"title":"Dimensions"},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated metrics; omit for all. A series has one metric, so this selects series rather than filtering rows.","title":"Metrics"},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Newest observation on or before this date","title":"As Of"},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ExportFormat","description":"Output format","default":"csv"},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CompressionFormat","description":"Compression","default":"none"},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which run to return (ISO date); omit for the most recent. Use /flow/forecast/runs to see what is published.","title":"Run Date"},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated horizons; omit for every one the series publishes. Market days ahead of the run date, which is 0, read from the dataset's own projection — the cube currently spans 0-15. A horizon the series does not publish is refused with the list of those it does; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/flow/forecast/runs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports them up front."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omitting this on a multi-series request is the largest response this endpoint produces: one group per (series, component, horizon), so 40 series is ~640 groups. Name the horizons you need, or page with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"records_per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"title":"Horizons"},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which branch of the cube to return. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The axis is named per component"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zscore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gamma"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/flow/forecast/runs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports which one a series uses, with its values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On the z-score axis it is a string: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"All"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the default and the unconditional path), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sit in the same domain as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-1.9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is a number. Either way "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" find the same cell."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Horizon 0 is the run date, which has already happened, so on the z-score axis it publishes only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"All"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; asking for another scenario returns the later horizons and no group for 0."},"children":[]}]}]}],"examples":["All","-1.9","25"],"title":"Scenario"},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Several branches at once, comma-separated, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for every one published — a whole run in one call. Each group then carries its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scenario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Not with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scenario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A CTA run is 64 scenarios x 16 horizons, 1,024 groups, inside one default page; narrow with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["*","All,-1.0,1.0"],"title":"Scenarios"},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated systematic strategies, e.g. cta,vt; omit for all that the series publishes. Each component publishes its own metrics, so a group never mixes them — use /flow/forecast/runs to see which exist."},"children":[]}]}]}],"examples":["vt","cta,vt"],"title":"Components"},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Free-text search over names, descriptions and identifiers","title":"Q"},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page","default":100,"title":"Records Per Page"},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"type":"integer","minimum":1,"description":"1-indexed","default":1,"title":"Page Number"},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated dimensions to return, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metric,frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit for all."},"children":[]}]}]}],"title":"Dimensions"},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Slug, series_label, entity or series_id"},"children":[]}]}]}],"title":"Identifier"},"id":"schema_423"}},"exampleStore":{},"securitySchemeStore":{"HTTPBearer":{"id":"HTTPBearer","type":"http","scheme":"bearer"},"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","in":"header","paramName":"x-api-key"}},"servers":[{"url":"/_mock/apis/flow/vanda-msvc-flow","isMockServer":true,"description":"Mock server"},{"url":"https://api.vanda-analytics.com","description":"Production server"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":"all","schemasExpansionLevel":"all","codeSamples":{"languages":[{"lang":"curl","label":"cURL"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"R"}]},"mockServer":{"url":"/_mock/apis/flow/vanda-msvc-flow","position":"first","description":"Mock server","errorIfForcedExampleNotFound":false,"strictExamples":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/flow/vanda-msvc-flow.json?download"},{"url":"/_bundle/apis/flow/vanda-msvc-flow.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Vanda Analytics Flow API","description":"High-performance Flow API with Auth0"}},"baseSlug":"/apis/flow/vanda-msvc-flow","routesMapping":{}}